Skip to content
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

Jump to bottom

Fix false-positive with contextmanager missing cleanup #9654

Merged
merged 4 commits into from
May 20, 2024
Merged

Fix false-positive with contextmanager missing cleanup #9654

merged 4 commits into from
May 20, 2024

Conversation

cdce8p
Copy link
Member

@cdce8p cdce8p commented May 19, 2024

Type of Changes

Type
βœ“ πŸ› Bug fix

Description

An attempt at fixing the false-positives with the contextmanager-generator-missing-cleanup check where no cleanup happens after a singular yield.

Closes #9625

@cdce8p cdce8p added False Positive 🦟 A message is emitted but nothing is wrong with the code backport maintenance/3.2.x labels May 19, 2024
@cdce8p cdce8p added this to the 3.2.2 milestone May 19, 2024
@cdce8p cdce8p mentioned this pull request May 19, 2024
Closed
@codecov Codecov
Copy link

codecov bot commented May 19, 2024 •
edited

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 95.84%. Comparing base (fbc1ed3) to head (509eb93).
Report is 20 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #9654   +/-   ##
=======================================
  Coverage   95.84%   95.84%           
=======================================
  Files         174      174           
  Lines       18896    18915   +19     
=======================================
+ Hits        18110    18129   +19     
  Misses        786      786
Files Coverage Ξ”
pylint/checkers/base/function_checker.py 93.10% <100.00%> (-6.90%) ⬇️

... and 9 files with indirect coverage changes

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
Pierre-Sassoulas
Pierre-Sassoulas reviewed May 20, 2024
View reviewed changes
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

We might want to document the known false positives from #9625 (comment) in dΓ©tails.rst ?

@cdce8p
Copy link
Member Author

cdce8p commented May 20, 2024

We might want to document the known false positives from #9625 (comment) in details.rst ?

Done. I've also updated the error node to use the with_node instead of the FuncDef. While technically this might be a small breaking change, I think this improves the error message especially for long generator functions with multiple if blocks.

@cdce8p cdce8p force-pushed the false-positive-contextmanager-cleanup branch from 814d0d4 to 509eb93 Compare May 20, 2024 06:14
Pierre-Sassoulas
Pierre-Sassoulas approved these changes May 20, 2024
View reviewed changes
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

LGTM

@github-actions GitHub Actions
Copy link
Contributor

πŸ€– According to the primer, this change has no effect on the checked open source code. πŸ€–πŸŽ‰

This comment was generated for commit 509eb93

@cdce8p cdce8p merged commit 5a01bc1 into pylint-dev:main May 20, 2024
44 checks passed
@cdce8p cdce8p deleted the false-positive-contextmanager-cleanup branch May 20, 2024 06:31
github-actions bot pushed a commit that referenced this pull request May 20, 2024
@cdce8p @github-actions
Fix false-positive with contextmanager missing cleanup (#9654)
b1dcf47 
(cherry picked from commit 5a01bc1)
@github-actions github-actions bot mentioned this pull request May 20, 2024
Merged
cdce8p pushed a commit that referenced this pull request May 20, 2024
@github-actions
Fix false-positive with contextmanager missing cleanup (#9654) (#9657)
98c5af9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Pierre-Sassoulas Pierre-Sassoulas Pierre-Sassoulas approved these changes

Assignees
No one assigned
Labels
backport maintenance/3.2.x False Positive 🦟 A message is emitted but nothing is wrong with the code
Projects
None yet
Milestone
3.2.2
2 participants
@cdce8p @Pierre-Sassoulas