summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2021-03-08 12:16:20 +0100
committerGitHub <noreply@github.com>2021-03-08 03:16:20 -0800
commitbbba28212ce0f58096a4043f32442c6e727b74fc (patch)
tree7c4bc5795fdf260c15f4f4ac0d45f5d41e291929
parentc25910a135c2245accadb324b40dd6453015e056 (diff)
downloadcpython-git-bbba28212ce0f58096a4043f32442c6e727b74fc.tar.gz
bpo-43353: Document that logging.getLevelName() accepts string representation of logging level. (GH-24693)
[bpo-43353]() Automerge-Triggered-By: GH:vsajip
-rw-r--r--Doc/library/logging.rst25
-rw-r--r--Lib/logging/__init__.py8
2 files changed, 23 insertions, 10 deletions
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 431a5849fa..70a703dde1 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -1113,18 +1113,27 @@ functions.
.. function:: getLevelName(level)
- Returns the textual representation of logging level *level*. If the level is one
- of the predefined levels :const:`CRITICAL`, :const:`ERROR`, :const:`WARNING`,
- :const:`INFO` or :const:`DEBUG` then you get the corresponding string. If you
- have associated levels with names using :func:`addLevelName` then the name you
- have associated with *level* is returned. If a numeric value corresponding to one
- of the defined levels is passed in, the corresponding string representation is
- returned. Otherwise, the string 'Level %s' % level is returned.
+ Returns the textual or numeric representation of logging level *level*.
+
+ If *level* is one of the predefined levels :const:`CRITICAL`, :const:`ERROR`,
+ :const:`WARNING`, :const:`INFO` or :const:`DEBUG` then you get the
+ corresponding string. If you have associated levels with names using
+ :func:`addLevelName` then the name you have associated with *level* is
+ returned. If a numeric value corresponding to one of the defined levels is
+ passed in, the corresponding string representation is returned.
+
+ The *level* parameter also accepts a string representation of the level such
+ as 'INFO'. In such cases, this functions returns the corresponding numeric
+ value of the level.
+
+ If no matching numeric or string value is passed in, the string
+ 'Level %s' % level is returned.
.. note:: Levels are internally integers (as they need to be compared in the
logging logic). 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`).
+ ``%(levelname)s`` format specifier (see :ref:`logrecord-attributes`), and
+ vice versa.
.. versionchanged:: 3.4
In Python versions earlier than 3.4, this function could also be passed a
diff --git a/Lib/logging/__init__.py b/Lib/logging/__init__.py
index 50b7378cd6..411aa53a0b 100644
--- a/Lib/logging/__init__.py
+++ b/Lib/logging/__init__.py
@@ -118,7 +118,7 @@ _nameToLevel = {
def getLevelName(level):
"""
- Return the textual representation of logging level 'level'.
+ Return the textual or numeric representation of logging level 'level'.
If the level is one of the predefined levels (CRITICAL, ERROR, WARNING,
INFO, DEBUG) then you get the corresponding string. If you have
@@ -128,7 +128,11 @@ def getLevelName(level):
If a numeric value corresponding to one of the defined levels is passed
in, the corresponding string representation is returned.
- Otherwise, the string "Level %s" % level is returned.
+ If a string representation of the level is passed in, the corresponding
+ numeric value is returned.
+
+ If no matching numeric or string value is passed in, the string
+ 'Level %s' % level is returned.
"""
# See Issues #22386, #27937 and #29220 for why it's this way
result = _levelToName.get(level)