Skip to content

Commit

Permalink
pythongh-115811: Update documentation to add some Logger attributes. (p…
Browse files Browse the repository at this point in the history
  • Loading branch information
vsajip authored Feb 29, 2024
1 parent 04d1000 commit 3b6f4ca
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions Doc/library/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,27 @@ is the module's name in the Python package namespace.

.. class:: Logger

.. attribute:: Logger.name

This is the logger's name, and is the value that was passed to :func:`getLogger`
to obtain the logger.

.. note:: This attribute should be treated as read-only.

.. attribute:: Logger.level

The threshold of this logger, as set by the :meth:`setLevel` method.

.. note:: Do not set this attribute directly - always use :meth:`setLevel`,
which has checks for the level passed to it.

.. attribute:: Logger.parent

The parent logger of this logger. It may change based on later instantiation
of loggers which are higher up in the namespace hierarchy.

.. note:: This value should be treated as read-only.

.. attribute:: Logger.propagate

If this attribute evaluates to true, events logged to this logger will be
Expand Down Expand Up @@ -108,6 +129,21 @@ is the module's name in the Python package namespace.
scenario is to attach handlers only to the root logger, and to let
propagation take care of the rest.

.. attribute:: Logger.handlers

The list of handlers directly attached to this logger instance.

.. note:: This attribute should be treated as read-only; it is normally changed via
the :meth:`addHandler` and :meth:`removeHandler` methods, which use locks to ensure
thread-safe operation.

.. attribute:: Logger.disabled

This attribute disables handling of any events. It is set to ``False`` in the
initializer, and only changed by logging configuration code.

.. note:: This attribute should be treated as read-only.

.. method:: Logger.setLevel(level)

Sets the threshold for this logger to *level*. Logging messages which are less
Expand Down

0 comments on commit 3b6f4ca

Please sign in to comment.