GeezerVison is showing github.com — Warning filter message/module documentation is misleading · Issue #86438 · python/cpython

Warning filter message/module documentation is misleading #86438

New issue

Copy link

New issue

Copy link

Closed

Warning filter message/module documentation is misleading#86438

Copy link

Assignees

Labels

3.10 (EOL)end of lifeend of lifedocsDocumentation in the Doc dirDocumentation in the Doc dirtype-featureA feature request or enhancementA feature request or enhancement

Description

kevinoid

mannequin

opened

on Nov 5, 2020

Issue body actions

BPO	42272
Nosy	@kevinoid
PRs	bpo-42272: fix misleading warning filter message/module docs #23172

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-11-05.20:06:37.165>
labels = ['type-feature', '3.10', 'docs']
title = 'Warning filter message/module documentation is misleading'
updated_at = <Date 2021-08-28.08:27:10.953>
user = 'https://github.com/kevinoid'

bugs.python.org fields:

activity = <Date 2021-08-28.08:27:10.953>
actor = 'ananyadatta88'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-11-05.20:06:37.165>
creator = 'kevinoid'
dependencies = []
files = ['50238']
hgrepos = []
issue_num = 42272
keywords = ['patch']
message_count = 2.0
messages = ['380429', '400464']
nosy_count = 3.0
nosy_names = ['docs@python', 'kevinoid', 'ananyadatta88']
pr_nums = ['23172']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue42272'
versions = ['Python 3.10']

Activity

kevinoid commented on Nov 5, 2020
kevinoidmannequin
on Nov 5, 2020
MannequinAuthor
More actions
"The Warnings Filter" section of the documentation for the warnings module describes the message and module filters as "a string containing a regular expression". While that is true when they are arguments to the filterwarnings function, it is not true when they appear in -W or $PYTHONWARNINGS where they are matched literally (after stripping any starting/ending whitespace).

Additionally, in the "Describing Warning Filters" section, the example "error:::mymodule[.*]" does not behave as described. If it were used as an argument to filterwarnings, where it would be treated as a regular expression, it would match the (invalid) module names mymodule. or mymodule* while it would match mymodule[.*] literally if passed via -W or $PYTHONWARNINGS.
kevinoid
added
3.10 (EOL)end of lifeend of life
on Nov 5, 2020
kevinoid
assigned
docspython
on Nov 5, 2020
kevinoid
added
docsDocumentation in the Doc dirDocumentation in the Doc dir

type-featureA feature request or enhancementA feature request or enhancement
on Nov 5, 2020
ananyadatta88 commented on Aug 28, 2021
ananyadatta88mannequin
on Aug 28, 2021
Mannequin
More actions
No comments
ezio-melotti
transferred this issue from on Apr 10, 2022
ezio-melotti
self-assigned this
on May 25, 2022
ezio-melotti commented on May 30, 2022
ezio-melotti
on May 30, 2022
Member
More actions
Fixed in GH-23172, backported in GH-93342 and GH-93341. Thanks for the report and the PR!
ezio-melotti
closed this as completed on May 30, 2022
kevinoid commented on May 30, 2022
kevinoid
on May 30, 2022
ContributorAuthor
More actions
Thanks for reviewing and merging it @ezio-melotti!
Reacted by Ezio Melotti
ezio-melotti
added this to Warnings docs cleanupon May 30, 2022
ezio-melotti
moved this to Done in Warnings docs cleanupon May 30, 2022