Issue #22436: Improved documentation for getEffectiveLevel() and getLevelName().

This commit is contained in:
Vinay Sajip 2014-09-18 17:46:58 +01:00
parent 74012c1795
commit f40a407577
1 changed files with 9 additions and 1 deletions

View File

@ -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 Indicates the effective level for this logger. If a value other than
:const:`NOTSET` has been set using :meth:`setLevel`, it is returned. Otherwise, :const:`NOTSET` has been set using :meth:`setLevel`, it is returned. Otherwise,
the hierarchy is traversed towards the root until a value other than 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) .. method:: Logger.getChild(suffix)
@ -898,6 +900,12 @@ functions.
of the defined levels is passed in, the corresponding string representation is of the defined levels is passed in, the corresponding string representation is
returned. Otherwise, the string "Level %s" % lvl is returned. 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) .. function:: makeLogRecord(attrdict)