Skip to content

Commit

Permalink
[3.10] gh-96727: Document restrictions on Handler.emit() with respect…
Browse files Browse the repository at this point in the history
… to locking. (GH-96948) (GH-96951)

(cherry picked from commit 6ad47b4)
  • Loading branch information
vsajip authored Sep 20, 2022
1 parent dcff50a commit 7a8ac38
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Doc/library/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,22 @@ subclasses. However, the :meth:`__init__` method in subclasses needs to call
is intended to be implemented by subclasses and so raises a
:exc:`NotImplementedError`.

.. warning:: This method is called after a handler-level lock is acquired, which
is released after this method returns. When you override this method, note
that you should be careful when calling anything that invokes other parts of
the logging API which might do locking, because that might result in a
deadlock. Specifically:

* Logging configuration APIs acquire the module-level lock, and then
individual handler-level locks as those handlers are configured.

* Many logging APIs lock the module-level lock. If such an API is called
from this method, it could cause a deadlock if a configuration call is
made on another thread, because that thread will try to acquire the
module-level lock *before* the handler-level lock, whereas this thread
tries to acquire the module-level lock *after* the handler-level lock
(because in this method, the handler-level lock has already been acquired).

For a list of handlers included as standard, see :mod:`logging.handlers`.

.. _formatter-objects:
Expand Down

0 comments on commit 7a8ac38

Please sign in to comment.