https://github.com/python/cpython/commit/3b6f4cadf19e6a4edd2cbbbc96a0a4024b395648
commit: 3b6f4cadf19e6a4edd2cbbbc96a0a4024b395648
branch: main
author: Vinay Sajip <[email protected]>
committer: willingc <[email protected]>
date: 2024-02-29T10:53:19-08:00
summary:
gh-115811: Update documentation to add some Logger attributes. (GH-116109)
files:
M Doc/library/logging.rst
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 39eb41ce1f1670..e38b7435498507 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -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
@@ -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
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
