Skip to content

Doc update: clarify -W syntax #9464

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
merged 5 commits into from
Jan 4, 2022
Merged

Doc update: clarify -W syntax #9464

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4995bc3
Update capture-warnings.rst doc on syntax
dalvizu Dec 30, 2021
3b0132a
Update capture-warnings.rst
dalvizu Dec 30, 2021
40c49da
Update capture-warnings.rst
dalvizu Dec 31, 2021
90a4800
Update doc/en/how-to/capture-warnings.rst
dalvizu Jan 3, 2022
9d02ecb
Apply suggestions from code review
nicoddemus Jan 4, 2022
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
17 changes: 12 additions & 5 deletions doc/en/how-to/capture-warnings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,18 @@ Running pytest now produces this output:
-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
======================= 1 passed, 1 warning in 0.12s =======================

The ``-W`` flag can be passed to control which warnings will be displayed or even turn
them into errors:
Controlling warnings
--------------------

Similar to Python's `warning filter`_ and :option:`-W option <python:-W>` flag, pytest provides
its own ``-W`` flag to control which warnings are ignored, displayed, or turned into
errors. See the `warning filter`_ documentation for more
advanced use-cases.

.. _`warning filter`: https://docs.python.org/3/library/warnings.html#warning-filter

This code sample shows how to treat any ``UserWarning`` category class of warning
as an error:

.. code-block:: pytest

Expand Down Expand Up @@ -96,9 +106,6 @@ all other warnings into errors.
When a warning matches more than one option in the list, the action for the last matching option
is performed.

Both ``-W`` command-line option and ``filterwarnings`` ini option are based on Python's own
:option:`-W option <python:-W>` and :func:`warnings.simplefilter`, so please refer to those sections in the Python
documentation for other examples and advanced usage.

.. _`filterwarnings`:

Expand Down