Skip to content

Commit

Permalink
gh-101100: Fix sphinx warnings in howto/logging.rst (#114846)
Browse files Browse the repository at this point in the history
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
  • Loading branch information
sobolevn and hugovk authored Feb 1, 2024
1 parent c9c6e04 commit dc01b91
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 24 deletions.
43 changes: 22 additions & 21 deletions Doc/howto/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,7 @@ custom handlers) are the following configuration methods:

* The :meth:`~Handler.setLevel` method, just as in logger objects, specifies the
lowest severity that will be dispatched to the appropriate destination. Why
are there two :func:`setLevel` methods? The level set in the logger
are there two :meth:`~Handler.setLevel` methods? The level set in the logger
determines which severity of messages it will pass to its handlers. The level
set in each handler determines which messages that handler will send on.

Expand Down Expand Up @@ -774,29 +774,29 @@ What happens if no configuration is provided

If no logging configuration is provided, it is possible to have a situation
where a logging event needs to be output, but no handlers can be found to
output the event. The behaviour of the logging package in these
circumstances is dependent on the Python version.
output the event.

For versions of Python prior to 3.2, the behaviour is as follows:
The event is output using a 'handler of last resort', stored in
:data:`lastResort`. This internal handler is not associated with any
logger, and acts like a :class:`~logging.StreamHandler` which writes the
event description message to the current value of ``sys.stderr`` (therefore
respecting any redirections which may be in effect). No formatting is
done on the message - just the bare event description message is printed.
The handler's level is set to ``WARNING``, so all events at this and
greater severities will be output.

* If *logging.raiseExceptions* is ``False`` (production mode), the event is
silently dropped.
.. versionchanged:: 3.2

* If *logging.raiseExceptions* is ``True`` (development mode), a message
'No handlers could be found for logger X.Y.Z' is printed once.
For versions of Python prior to 3.2, the behaviour is as follows:

In Python 3.2 and later, the behaviour is as follows:
* If :data:`raiseExceptions` is ``False`` (production mode), the event is
silently dropped.

* The event is output using a 'handler of last resort', stored in
``logging.lastResort``. This internal handler is not associated with any
logger, and acts like a :class:`~logging.StreamHandler` which writes the
event description message to the current value of ``sys.stderr`` (therefore
respecting any redirections which may be in effect). No formatting is
done on the message - just the bare event description message is printed.
The handler's level is set to ``WARNING``, so all events at this and
greater severities will be output.
* If :data:`raiseExceptions` is ``True`` (development mode), a message
'No handlers could be found for logger X.Y.Z' is printed once.

To obtain the pre-3.2 behaviour, ``logging.lastResort`` can be set to ``None``.
To obtain the pre-3.2 behaviour,
:data:`lastResort` can be set to ``None``.

.. _library-config:

Expand Down Expand Up @@ -998,7 +998,7 @@ Logged messages are formatted for presentation through instances of the
use with the % operator and a dictionary.

For formatting multiple messages in a batch, instances of
:class:`~handlers.BufferingFormatter` can be used. In addition to the format
:class:`BufferingFormatter` can be used. In addition to the format
string (which is applied to each message in the batch), there is provision for
header and trailer format strings.

Expand Down Expand Up @@ -1034,7 +1034,8 @@ checks to see if a module-level variable, :data:`raiseExceptions`, is set. If
set, a traceback is printed to :data:`sys.stderr`. If not set, the exception is
swallowed.

.. note:: The default value of :data:`raiseExceptions` is ``True``. This is
.. note::
The default value of :data:`raiseExceptions` is ``True``. This is
because during development, you typically want to be notified of any
exceptions that occur. It's advised that you set :data:`raiseExceptions` to
``False`` for production usage.
Expand Down Expand Up @@ -1072,7 +1073,7 @@ You can write code like this::
expensive_func2())

so that if the logger's threshold is set above ``DEBUG``, the calls to
:func:`expensive_func1` and :func:`expensive_func2` are never made.
``expensive_func1`` and ``expensive_func2`` are never made.

.. note:: In some cases, :meth:`~Logger.isEnabledFor` can itself be more
expensive than you'd like (e.g. for deeply nested loggers where an explicit
Expand Down
16 changes: 14 additions & 2 deletions Doc/library/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -531,12 +531,12 @@ subclasses. However, the :meth:`!__init__` method in subclasses needs to call

This method should be called from handlers when an exception is encountered
during an :meth:`emit` call. If the module-level attribute
``raiseExceptions`` is ``False``, exceptions get silently ignored. This is
:data:`raiseExceptions` is ``False``, exceptions get silently ignored. This is
what is mostly wanted for a logging system - most users will not care about
errors in the logging system, they are more interested in application
errors. You could, however, replace this with a custom handler if you wish.
The specified record is the one which was being processed when the exception
occurred. (The default value of ``raiseExceptions`` is ``True``, as that is
occurred. (The default value of :data:`raiseExceptions` is ``True``, as that is
more useful during development).


Expand Down Expand Up @@ -1494,6 +1494,18 @@ Module-Level Attributes

.. versionadded:: 3.2

.. attribute:: raiseExceptions

Used to see if exceptions during handling should be propagated.

Default: ``True``.

If :data:`raiseExceptions` is ``False``,
exceptions get silently ignored. This is what is mostly wanted
for a logging system - most users will not care about errors in
the logging system, they are more interested in application errors.


Integration with the warnings module
------------------------------------

Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Doc/extending/extending.rst
Doc/glossary.rst
Doc/howto/descriptor.rst
Doc/howto/enum.rst
Doc/howto/logging.rst
Doc/library/ast.rst
Doc/library/asyncio-extending.rst
Doc/library/asyncio-policy.rst
Expand Down

0 comments on commit dc01b91

Please sign in to comment.