From f40a407577b06c5830e7b9aa69a468bbaf26b08b Mon Sep 17 00:00:00 2001 From: Vinay Sajip Date: Thu, 18 Sep 2014 17:46:58 +0100 Subject: [PATCH] Issue #22436: Improved documentation for getEffectiveLevel() and getLevelName(). --- Doc/library/logging.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index 0c50b2f8e9..839bdc7579 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -130,7 +130,9 @@ is the module's name in the Python package namespace. Indicates the effective level for this logger. If a value other than :const:`NOTSET` has been set using :meth:`setLevel`, it is returned. Otherwise, the hierarchy is traversed towards the root until a value other than - :const:`NOTSET` is found, and that value is returned. + :const:`NOTSET` is found, and that value is returned. The value returned is + an integer, typically one of :const:`logging.DEBUG`, :const:`logging.INFO` + etc. .. method:: Logger.getChild(suffix) @@ -898,6 +900,12 @@ functions. of the defined levels is passed in, the corresponding string representation is returned. Otherwise, the string "Level %s" % lvl is returned. + .. note:: Integer levels should be used when e.g. setting levels on instances + of :class:`Logger` and handlers. This function is used to convert between + an integer level and the level name displayed in the formatted log output + by means of the ``%(levelname)s`` format specifier (see + :ref:`logrecord-attributes`). + .. function:: makeLogRecord(attrdict) -- 2.50.1