suppress pylint warn contextmanager-generator-missing-cleanup #3138
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nagworld9
requested review from
narrieta,
ZhidongPeng and
maddieford
as code owners
narrieta
reviewed
Jun 6, 2024
| @@ -284,6 +284,7 @@ def __setup_generic_test_env(self): | |||
| third_ext = extension_emulator(name="OSTCExtensions.ExampleHandlerLinux.thirdExtension") | |||
| fourth_ext = extension_emulator(name="Microsoft.Powershell.ExampleExtension") | |||
|
|
|||
| # pylint: disable=contextmanager-generator-missing-cleanup | |||
There was a problem hiding this comment.
this needs to be inline, on the line producing the warning
There was a problem hiding this comment.
also, if you can add a comment to each suppression pointing out what generator is triggering the warning, it'd be great
narrieta
approved these changes
Jun 7, 2024
maddieford
approved these changes
Jun 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fix for new warning from latest pylint.
_tests/ga/test_update.py:1203:12: W0135: The context used in function '_setup_test_for_ext_event_dirs_retention' will not be exited. (contextmanager-generator-missing-cleanup)_It looks like false positive according to documentation https://pylint.readthedocs.io/en/latest/user_guide/messages/warning/contextmanager-generator-missing-cleanup.html
The check can create false positives if yield is used inside an if-else block without custom cleanup. Use pylint: disable for these.
This warning not implemented in earlier versions of python (3.0 -3.7) So I disabled the warning with (bad-option-value) in GitHub workflow
Issue #
PR information
Quality of Code and Contribution Guidelines