Skip to content

bpo-42272: fix misleading warning filter message/module docs #23172

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 3 commits into from
May 30, 2022
Merged

bpo-42272: fix misleading warning filter message/module docs #23172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a2a6100
bpo-42272: improve message/module warning filter docs
kevinoid Nov 5, 2020
1767ef9
bpo-42272: remove bad submodule warning filter doc
kevinoid Nov 5, 2020
b15ea56
bpo-42272: add warning filter doc changes to NEWS
kevinoid May 26, 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
16 changes: 10 additions & 6 deletions Doc/library/warnings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,14 +154,19 @@ the disposition of the match. Each entry is a tuple of the form (*action*,
+---------------+----------------------------------------------+

* *message* is a string containing a regular expression that the start of
the warning message must match. The expression is compiled to always be
case-insensitive.
the warning message must match, case-insensitively. In :option:`-W` and
:envvar:`PYTHONWARNINGS`, *message* is a literal string that the start of the
warning message must contain (case-insensitively), ignoring any whitespace at
the start or end of *message*.

* *category* is a class (a subclass of :exc:`Warning`) of which the warning
category must be a subclass in order to match.

* *module* is a string containing a regular expression that the module name must
match. The expression is compiled to be case-sensitive.
* *module* is a string containing a regular expression that the start of the
fully-qualified module name must match, case-sensitively. In :option:`-W` and
:envvar:`PYTHONWARNINGS`, *module* is a literal string that the
fully-qualified module name must be equal to (case-sensitively), ignoring any
whitespace at the start or end of *module*.

* *lineno* is an integer that the line number where the warning occurred must
match, or ``0`` to match all line numbers.
Expand Down Expand Up @@ -207,8 +212,7 @@ Some examples::
error::ResourceWarning # Treat ResourceWarning messages as errors
default::DeprecationWarning # Show DeprecationWarning messages
ignore,default:::mymodule # Only report warnings triggered by "mymodule"
error:::mymodule[.*] # Convert warnings to errors in "mymodule"
# and any subpackages of "mymodule"
error:::mymodule # Convert warnings to errors in "mymodule"


.. _default-warning-filter:
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Documentation/2022-05-26-11-33-23.gh-issue-86438.kEGGmK.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Clarify that :option:`-W` and :envvar:`PYTHONWARNINGS` are matched literally
and case-insensitively, rather than as regular expressions, in
:mod:`warnings`.