Merged revisions 62873,62887,62892-62896,62904 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r62873 | raymond.hettinger | 2008-05-08 12:18:13 -0500 (Thu, 08 May 2008) | 1 line
Issue 2778. Document the temporary frozenset swap in __contains__(), remove(), and discard().
........
r62887 | brett.cannon | 2008-05-08 14:50:51 -0500 (Thu, 08 May 2008) | 5 lines
Make test.test_support.catch_warning() take an argument specifying if any
triggered warnings should be captured. This allows the context manager to be
used to just prevent the internal state of the 'warnings' framework and thus
allow triggered warnings to be displayed.
........
r62892 | brett.cannon | 2008-05-08 15:20:24 -0500 (Thu, 08 May 2008) | 4 lines
Fix a bug introduced by the addition of the 'record' argument to
test.test_support.catch_warning() where showwarning() was not being set
properly.
........
r62893 | brett.cannon | 2008-05-08 15:20:54 -0500 (Thu, 08 May 2008) | 2 lines
Document the 'record' argument for test.test_support.catch_warning().
........
r62894 | brett.cannon | 2008-05-08 15:23:06 -0500 (Thu, 08 May 2008) | 4 lines
Fix sys.flags to properly expose bytes_warning.
Closes issue #2790.
........
r62895 | brett.cannon | 2008-05-08 15:23:54 -0500 (Thu, 08 May 2008) | 2 lines
Add a missing entry on the fix for issue #2790.
........
r62896 | brett.cannon | 2008-05-08 15:24:43 -0500 (Thu, 08 May 2008) | 2 lines
Add test.test_support.catch_warning()'s new argument.
........
r62904 | benjamin.peterson | 2008-05-08 17:09:54 -0500 (Thu, 08 May 2008) | 2 lines
Replace instances of os.path.walk with os.walk
........
diff --git a/Doc/library/test.rst b/Doc/library/test.rst
index 6c35d50..a6a3584 100644
--- a/Doc/library/test.rst
+++ b/Doc/library/test.rst
@@ -283,13 +283,15 @@
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
- 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:
warnings.warn("foo")