Merge pull request #11017 from erik-hasse/caplog-root-logger-docs
add a warning about modifying the root logger during tests
This commit is contained in:
commit
81cfb3fc87
1
AUTHORS
1
AUTHORS
|
@ -129,6 +129,7 @@ Eric Hunsberger
|
||||||
Eric Liu
|
Eric Liu
|
||||||
Eric Siegerman
|
Eric Siegerman
|
||||||
Erik Aronesty
|
Erik Aronesty
|
||||||
|
Erik Hasse
|
||||||
Erik M. Bray
|
Erik M. Bray
|
||||||
Evan Kepner
|
Evan Kepner
|
||||||
Evgeny Seliverstov
|
Evgeny Seliverstov
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
Added a warning about modifying the root logger during tests when using ``caplog``.
|
|
@ -172,6 +172,13 @@ the records for the ``setup`` and ``call`` stages during teardown like so:
|
||||||
|
|
||||||
The full API is available at :class:`pytest.LogCaptureFixture`.
|
The full API is available at :class:`pytest.LogCaptureFixture`.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
The ``caplog`` fixture adds a handler to the root logger to capture logs. If the root logger is
|
||||||
|
modified during a test, for example with ``logging.config.dictConfig``, this handler may be
|
||||||
|
removed and cause no logs to be captured. To avoid this, ensure that any root logger configuration
|
||||||
|
only adds to the existing handlers.
|
||||||
|
|
||||||
|
|
||||||
.. _live_logs:
|
.. _live_logs:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue