Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-32212: Updated logging documentation to make parameter names more consistent with source. (GH-4765)

This commit is contained in:
Vinay Sajip 2017-12-09 11:09:04 +00:00 committed by GitHub
parent 5f841b5538
commit a9f8df646a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
Doc/library/logging.rst
View File

@ -91,12 +91,12 @@ is the module's name in the Python package namespace.
scenario is to attach handlers only to the root logger, and to let scenario is to attach handlers only to the root logger, and to let
propagation take care of the rest. propagation take care of the rest.
.. method:: Logger.setLevel(lvl) .. method:: Logger.setLevel(level)
Sets the threshold for this logger to *lvl*. Logging messages which are less Sets the threshold for this logger to *level*. Logging messages which are less
severe than *lvl* will be ignored; logging messages which have severity *lvl* severe than *level* will be ignored; logging messages which have severity *level*
or higher will be emitted by whichever handler or handlers service this logger, or higher will be emitted by whichever handler or handlers service this logger,
unless a handler's level has been set to a higher severity level than *lvl*. unless a handler's level has been set to a higher severity level than *level*.
When a logger is created, the level is set to :const:`NOTSET` (which causes When a logger is created, the level is set to :const:`NOTSET` (which causes
all messages to be processed when the logger is the root logger, or delegation all messages to be processed when the logger is the root logger, or delegation
@ -117,7 +117,7 @@ is the module's name in the Python package namespace.
See :ref:`levels` for a list of levels. See :ref:`levels` for a list of levels.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
The *lvl* parameter now accepts a string representation of the The *level* parameter now accepts a string representation of the
level such as 'INFO' as an alternative to the integer constants level such as 'INFO' as an alternative to the integer constants
such as :const:`INFO`. Note, however, that levels are internally stored such as :const:`INFO`. Note, however, that levels are internally stored
as integers, and methods such as e.g. :meth:`getEffectiveLevel` and as integers, and methods such as e.g. :meth:`getEffectiveLevel` and
@ -267,14 +267,14 @@ is the module's name in the Python package namespace.
message. This method should only be called from an exception handler. message. This method should only be called from an exception handler.
.. method:: Logger.addFilter(filt) .. method:: Logger.addFilter(filter)
Adds the specified filter *filt* to this logger. Adds the specified filter *filter* to this logger.
.. method:: Logger.removeFilter(filt) .. method:: Logger.removeFilter(filter)
Removes the specified filter *filt* from this logger. Removes the specified filter *filter* from this logger.
.. method:: Logger.filter(record) .. method:: Logger.filter(record)
@ -393,33 +393,34 @@ subclasses. However, the :meth:`__init__` method in subclasses needs to call
Releases the thread lock acquired with :meth:`acquire`. Releases the thread lock acquired with :meth:`acquire`.
.. method:: Handler.setLevel(lvl) .. method:: Handler.setLevel(level)
Sets the threshold for this handler to *lvl*. Logging messages which are less Sets the threshold for this handler to *level*. Logging messages which are
severe than *lvl* will be ignored. When a handler is created, the level is set less severe than *level* will be ignored. When a handler is created, the
to :const:`NOTSET` (which causes all messages to be processed). level is set to :const:`NOTSET` (which causes all messages to be
processed).
See :ref:`levels` for a list of levels. See :ref:`levels` for a list of levels.
.. versionchanged:: 3.2 .. versionchanged:: 3.2
The *lvl* parameter now accepts a string representation of the The *level* parameter now accepts a string representation of the
level such as 'INFO' as an alternative to the integer constants level such as 'INFO' as an alternative to the integer constants
such as :const:`INFO`. such as :const:`INFO`.
.. method:: Handler.setFormatter(form) .. method:: Handler.setFormatter(fmt)
Sets the :class:`Formatter` for this handler to *form*. Sets the :class:`Formatter` for this handler to *fmt*.
.. method:: Handler.addFilter(filt) .. method:: Handler.addFilter(filter)
Adds the specified filter *filt* to this handler. Adds the specified filter *filter* to this handler.
.. method:: Handler.removeFilter(filt) .. method:: Handler.removeFilter(filter)
Removes the specified filter *filt* from this handler. Removes the specified filter *filter* from this handler.
.. method:: Handler.filter(record) .. method:: Handler.filter(record)