Skip to content

[3.11] gh-103109: Document ignore_warnings() test support helper (GH-103110) #103198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miss-islington merged 1 commit into from
Apr 2, 2023
Merged

[3.11] gh-103109: Document ignore_warnings() test support helper (GH-103110) #103198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions Doc/library/test.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1631,6 +1631,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
Expand Down
2 changes: 1 addition & 1 deletion Lib/test/support/warnings_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down