mirrors/cpython
0
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-01-25 02:24:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

gh-103109: Document ignore_warnings() test support helper (#103110)

Browse Source 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
This commit is contained in:
Charlie Zhao 2023-04-03 06:18:25 +08:00 committed by GitHub
parent 6883007a86
commit 32937d6aa4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Doc/library/test.rst
View File

@ -1691,6 +1691,21 @@ The :mod:`test.support.warnings_helper` module provides support for warnings tes
.. versionadded:: 3.10
.. function:: ignore_warnings(*, category)
Suppress warnings that are instances of *category*,
which must be :exc:`Warning` or a subclass.
Roughly equivalent to :func:`warnings.catch_warnings`
with :meth:`warnings.simplefilter('ignore', category=category) <warnings.simplefilter>`.
For example::
@warning_helper.ignore_warnings(category=DeprecationWarning)
def test_suppress_warning():
# do something
.. versionadded:: 3.8
.. function:: check_no_resource_warning(testcase)
Context manager to check that no :exc:`ResourceWarning` was raised. You

2
Lib/test/support/warnings_helper.py
View File

@ -44,7 +44,7 @@ def check_syntax_warning(testcase, statement, errtext='',
def ignore_warnings(*, category):
"""Decorator to suppress deprecation warnings.
"""Decorator to suppress warnings.
Use of context managers to hide warnings make diffs
more noisy and tools like 'git blame' less useful.