gh-103109: Add documentation for `ignore_warnings` by CharlieZhao95 · Pull Request #103110 · python/cpython · GitHub

Add documentation for ignore_warnings
Improve the comment in function ignore_warnings

Issue: Improve the documentation for ignore_warnings #103109

Standard reminder: You can directly apply the suggestion below by simply clicking Commit suggestion, entering a descriptive commit message and then clicking Commit changes

One fix for some textual errors/issues, otherwise LGTM - thanks @CharlieZhao95 !

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

LGTM, thanks @CharlieZhao95 !

Please add a versionadded:: 3.8. Also, I think there's some relevant information in the docstring that should be included in the docs, namely that this decorator should be used with care since tools like git blame may become less useful with warnings suppressed. Forget that last part; too little coffee for me! ☕ ☕ ☕

Also note that there's a targeted variant called ignore_warnings_from (that's also undocumented1).

Note that a lot of the test support functions are undocumented, some deliberately so, simply because they're mostly for internal use. ↩

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Oh BTW, would you mind reflowing this according to SemBr (within 79 chars line width)? If not, I'll do that before merging.

would you mind reflowing this according to SemBr (within 79 chars line width)? If not, I'll do that before merging.

Oh! Thanks for your suggestion. I love these nits! This doesn't look too hard, I can try to get it done, and I'll try to follow the SemBr spec going forward. Improvements are always good! 😃

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Also note that there's a targeted variant called ignore_warnings_from (that's also undocumented1).

BTW, I didn't find the code that matches ignore_warnings_from, please let me know if it is my problem. :)

BTW, I didn't find the code that matches ignore_warnings_from, please let me know if it is my problem. :)

FWIW I couldn't find it either, grepping the codebase for that string and also searching the repo, issues, commits, PRs, etc. on GitHub (except for this one, of course).

Sorry, that was a typo on my side :) It's ignore_deprecations_from:

cpython/Lib/test/support/__init__.py

Lines 2217 to 2225 in c1e71ce

    
           def ignore_deprecations_from(module: str, *, like: str) -> object: 
        
               token = object() 
        
               warnings.filterwarnings( 
        
                   "ignore", 
        
                   category=DeprecationWarning, 
        
                   module=module, 
        
                   message=like + fr"(?#support{id(token)})", 
        
               ) 
        
               return token

And, as far as I can see, it is only used in the tests for test.support, so there is no need to document it.

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

LGTM again, thanks @CharlieZhao95

Thanks @CharlieZhao95 for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

…onGH-103110) (cherry picked from commit 32937d6) Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

GH-103198 is a backport of this pull request to the 3.11 branch.

GH-103199 is a backport of this pull request to the 3.10 branch.

…onGH-103110) (cherry picked from commit 32937d6) Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

(cherry picked from commit 32937d6) Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

…on#103110) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Add docs for ignore_warnings

e86de80

bedevere-bot mentioned this pull request Mar 29, 2023

Improve the documentation for ignore_warnings #103109

Closed

bedevere-bot added the awaiting review label Mar 29, 2023

erlend-aasland requested a review from CAM-Gerlach March 29, 2023 13:04

CAM-Gerlach added docs Documentation in the Doc dir skip news needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Mar 29, 2023

CAM-Gerlach reviewed Mar 29, 2023

View reviewed changes

Comment thread Doc/library/test.rst Outdated

Update Doc/library/test.rst

69cf474

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

CAM-Gerlach approved these changes Mar 30, 2023

View reviewed changes

bedevere-bot added awaiting core review and removed awaiting review labels Mar 30, 2023

CAM-Gerlach requested a review from erlend-aasland March 30, 2023 03:14

erlend-aasland requested changes Mar 30, 2023

View reviewed changes

bedevere-bot added awaiting changes and removed awaiting core review labels Mar 30, 2023

CAM-Gerlach reviewed Mar 30, 2023

View reviewed changes

Comment thread Doc/library/test.rst

CharlieZhao95 and others added 2 commits March 31, 2023 09:08

Update Doc/library/test.rst

51764fb

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

Fix trailing whitespace and line width

0626568

CAM-Gerlach requested a review from erlend-aasland March 31, 2023 06:40

erlend-aasland reviewed Mar 31, 2023

View reviewed changes

Comment thread Doc/library/test.rst Outdated

CAM-Gerlach reviewed Mar 31, 2023

View reviewed changes

Comment thread Doc/library/test.rst Outdated

Comment thread Doc/library/test.rst Outdated

Update Doc/library/test.rst

0c8e310

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

CAM-Gerlach approved these changes Apr 1, 2023

View reviewed changes

CAM-Gerlach requested a review from erlend-aasland April 1, 2023 17:17

erlend-aasland approved these changes Apr 2, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Apr 2, 2023

erlend-aasland merged commit 32937d6 into python:main Apr 2, 2023

bedevere-bot removed the awaiting merge label Apr 2, 2023

bedevere-bot removed the needs backport to 3.11 only security fixes label Apr 2, 2023

bedevere-bot removed the needs backport to 3.10 only security fixes label Apr 2, 2023

miss-islington added a commit that referenced this pull request Apr 2, 2023

gh-103109 : Document ignore_warnings() test support helper (GH-103110 )

9a8ce95

(cherry picked from commit 32937d6) Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

miss-islington added a commit that referenced this pull request Apr 2, 2023

gh-103109 : Document ignore_warnings() test support helper (GH-103110 )

0854bdf

(cherry picked from commit 32937d6) Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

arhadthedev removed a link to an issue Apr 7, 2023

MANAGER CREDENTIALS #103345

Closed

gaogaotiantian pushed a commit to gaogaotiantian/cpython that referenced this pull request Apr 8, 2023

pythongh-103109 : Document ignore_warnings() test support helper (pyth…

ced3c8b

…on#103110) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

warsaw pushed a commit to warsaw/cpython that referenced this pull request Apr 11, 2023

pythongh-103109 : Document ignore_warnings() test support helper (pyth…

a1e44a6

…on#103110) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

gh-103109: Add documentation for `ignore_warnings` by CharlieZhao95 · Pull Request #103110 · python/cpython · GitHub

Uh oh!

Uh oh!

gh-103109: Add documentation for ignore_warnings - #103110

gh-103109: Add documentation for ignore_warnings#103110erlend-aasland merged 5 commits intopython:mainpython/cpython:mainfrom CharlieZhao95:doc/ignore_warningsCharlieZhao95/cpython:doc/ignore_warningsCopy head branch name to clipboard

Conversation

CharlieZhao95 commented Mar 29, 2023 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CAM-Gerlach left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

erlend-aasland left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Footnotes

Uh oh!

bedevere-bot commented Mar 30, 2023

Uh oh!

erlend-aasland commented Mar 30, 2023

Uh oh!

CharlieZhao95 commented Mar 30, 2023

Uh oh!

Uh oh!

CharlieZhao95 commented Mar 31, 2023

Uh oh!

CAM-Gerlach commented Mar 31, 2023

Uh oh!

erlend-aasland commented Mar 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington commented Apr 2, 2023

Uh oh!

bedevere-bot commented Apr 2, 2023

Uh oh!

bedevere-bot commented Apr 2, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

gh-103109: Add documentation for ignore_warnings#103110
erlend-aasland merged 5 commits into
python:mainfrom
CharlieZhao95:doc/ignore_warnings

CharlieZhao95 commented Mar 29, 2023 •
edited by bedevere-bot
Loading

CAM-Gerlach left a comment •
edited
Loading

erlend-aasland left a comment •
edited
Loading

erlend-aasland commented Mar 31, 2023 •
edited
Loading