Skip to content

Commit

Permalink
gh-92859: Doc: add info about logging.debug() calling basicConfig() (G…
Browse files Browse the repository at this point in the history
…H-93063) (GH-93151)

(cherry picked from commit 2176898)
  • Loading branch information
miss-islington committed May 23, 2022
1 parent f095058 commit cea6573
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
9 changes: 5 additions & 4 deletions Doc/howto/logging.rst
Expand Up @@ -178,10 +178,11 @@ following example::
raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)

The call to :func:`basicConfig` should come *before* any calls to :func:`debug`,
:func:`info` etc. As it's intended as a one-off simple configuration facility,
only the first call will actually do anything: subsequent calls are effectively
no-ops.
The call to :func:`basicConfig` should come *before* any calls to
:func:`debug`, :func:`info`, etc. Otherwise, those functions will call
:func:`basicConfig` for you with the default options. As it's intended as a
one-off simple configuration facility, only the first call will actually do
anything: subsequent calls are effectively no-ops.

If you run the above script several times, the messages from successive runs
are appended to the file *example.log*. If you want each run to start afresh,
Expand Down
8 changes: 8 additions & 0 deletions Doc/library/logging.rst
Expand Up @@ -242,6 +242,10 @@ is the module's name in the Python package namespace.
above example). In such circumstances, it is likely that specialized
:class:`Formatter`\ s would be used with particular :class:`Handler`\ s.

If no handler is attached to this logger (or any of its ancestors,
taking into account the relevant :attr:`Logger.propagate` attributes),
the message will be sent to the handler set on :attr:`lastResort`.

.. versionchanged:: 3.2
The *stack_info* parameter was added.

Expand Down Expand Up @@ -1038,6 +1042,10 @@ functions.
above example). In such circumstances, it is likely that specialized
:class:`Formatter`\ s would be used with particular :class:`Handler`\ s.

This function (as well as :func:`info`, :func:`warning`, :func:`error` and
:func:`critical`) will call :func:`basicConfig` if the root logger doesn't
have any handler attached.

.. versionchanged:: 3.2
The *stack_info* parameter was added.

Expand Down

0 comments on commit cea6573

Please sign in to comment.