8000 gh-93343: Expand warning filter examples by daniel-shimon · Pull Request #106618 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-93343: Expand warning filter examples #106618

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

gh-93343: Expand warning filter examples #106618

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e43adf8
gh-93343: Expand warning filter examples
daniel-shimon 8000 Jul 12, 2023
f3684a6
gh-93343: Add warning filters tests
daniel-shimon Jul 12, 2023
f16ae2d
Clarify escaped dots in regexes
daniel-shimon May 6, 2025
e6251be
Merge branch 'main' into gh-93343-extra-warning-examples
daniel-shimon May 6, 2025
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
Next Next commit
gh-93343: Expand warning filter examples 
    Add examples of warning filters and the difference between programatic and environmental filters.
  • Loading branch information
@daniel-shimon
daniel-shimon committed Jul 12, 2023
commit e43adf8955a362dc6122fa6da31a7548c235fef3
28 changes: 28 additions & 0 deletions Doc/library/warnings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,34 @@ Some examples::
ignore,default:::mymodule # Only report warnings triggered by "mymodule"
error:::mymodule # Convert warnings to errors in "mymodule"

.. _warning-filter-examples:

Warning Filter Examples
~~~~~~~~~~~~~~~~~~~~~~~

Here are some complex examples for filtering warnings.

Note that :func:`filterwarnings` filters have subtle differences
from :option:`-W` and :envvar:`PYTHONWARNINGS` regarding the *message* and *module*
parts of the filter (as described in :ref:`warning-filter`).

::

filterwarnings("ignore", message=".*generic", module=r"yourmodule\.submodule")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
filterwarnings("ignore", message=".*generic", module=r"yourmodule\.submodule")
filterwarnings("ignore", message="\.*generic", module="yourmodule\.submodule")

Shouldn't this be escaped as well? The r here is not necessary, and its usage should be consistent between the two args (assuming they are both regexes).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No since the first arg wants to capture strings that contain 'generic' so that the '.' catches everything, while the first arg want to capture 'yourmodule.submodule' specifically, meaning that the '.' actually captures dot and should be escaped

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, it sounds to me you should put that explanation into the docs, @daniel-shimon; if it is unclear for a reviewer, it is not going to be clear for the average docs reader ;)

# Ignore warnings in "yourmodule.submodule" which contain "generic"
filterwarnings("ignore", message="generic", module=r"yourmodule\.submodule")
# Ignore warnings in "yourmodule.submodule" which START with "generic"
filterwarnings("ignore", module="yourmodule.*")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
filterwarnings("ignore", module="yourmodule.*")
filterwarnings("ignore", module="yourmodule\.*")

I think this should be escaped too.

Copy link
Contributor
@erlend-aasland erlend-aasland Jul 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, instead of using comments, would it be clearer (formatting wise) to use multiple code blocks? (Goes for the change below as well)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No because here we actually want to catch all characters after 'yourmodule' and not only dot

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto: https://github.com/python/cpython/pull/106618/files#r1261710032

# Ignore all warnings in "yourmodule" and its submodules

-W "ignore:generic::yourmodule.submodule:"
# Ignore warnings in "yourmodule.submodule" which START with "generic"
# (but not those containing it).
# Also note that the '.' in the module does not need to be escaped
# since it is not a regex.
-W "ignore:::yourmodule:"
# Ignore all warnings in "yourmodule", but NOT in its submodules


.. _default-warning-filter:

Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Documentation/2023-07-11-08-46-13.gh-issue-93343.fw_eyw.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add examples of warning filters and the difference between programmatic and
environmental filters.
0