Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is a method that is writing to a logger pure?

Tags:

c#

attributes

A pure method is defined as "does not make any visible state changes".

My method is writing a log message if one argument is null or an exception is thrown. Is it still pure? Is writing to a logger a visible change?

Here's the code:

    /// <summary>
    /// Formats with invariant culture - won't throw an exception.
    /// </summary>
    /// <param name="format">A composite format string.</param>
    /// <param name="args">An object array that contains zero or more objects to format.</param>
    /// <returns>A copy of format in which the format items have been replaced by the string representation of the corresponding objects in args.</returns>
    [SuppressMessage("Microsoft.Globalization", "CA1303:Do not pass literals as localized parameters", MessageId = "CyanCor.Core.Logging.Log.ExceptionPrevent(System.String,System.String,System.Int32,System.String)", Justification = "It is for the logger (riedl)")]
    [Pure - yes or no?]
    public static string FormatSafe(this string format, params object[] args)
    {
        if (format == null)
        {
            Log.ExceptionPrevent("Argument format is null");
            return NullFormat;
        }

        try
        {
            return string.Format(CultureInfo.InvariantCulture, format, args);
        }
        catch (ArgumentException exc)
        {
            Log.Exception(exc);
            return format;
        }
        catch (FormatException exc)
        {
            Log.Exception(exc);
            return format;
        }
    }
like image 466
ldrdl Avatar asked Apr 15 '13 07:04

ldrdl


1 Answers

Generally, "state change" means modifying the state of an object, ie. modifying a variable or changing the structure of a complex object. Following this definition, it would seem that your method is still pure.

like image 69
ose Avatar answered Sep 28 '22 04:09

ose