traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document the 'record' argument for test.test_support.catch_warning().

This commit is contained in:
Brett Cannon 2008-05-08 20:20:54 +00:00
parent 5d023c3afa
commit 98b9c07ab7
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/library/test.rst
View File

@ -283,13 +283,15 @@ The :mod:`test.test_support` module defines the following functions:
This will run all tests defined in the named module. This will run all tests defined in the named module.
.. function:: catch_warning() .. function:: catch_warning(record=True)
This is a context manager that guards the warnings filter from being Return a context manager that guards the warnings filter from being
permanently changed and records the data of the last warning that has been permanently changed and records the data of the last warning that has been
issued. issued. The ``record`` argument specifies whether any raised warnings are
captured by the object returned by :func:`warnings.catch_warning` or allowed
to propagate as normal.
Use like this:: The context manager is typically used like this::
with catch_warning() as w: with catch_warning() as w:
warnings.warn("foo") warnings.warn("foo")