Fix closing of callbacks on CLI exit #2680
Merged
Conversation
This file contains hidden or 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
kdeldycke
added a commit
to kdeldycke/click-extra
that referenced
this pull request
Feb 23, 2024
…ls and prevent state leaks Refs: pallets/click#2680
|
Note that this might be related to: #1053 |
[pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Add changelog entry Lint
…vanced documentation.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR forces the context to close itself on CLI exits.
This makes sure all callbacks registered by invoked options are properly called whenever a
ctx.exit()action is triggered. Which has the effect of preventing state leaks.These leaks cannot be witness in standard CLI operations, because on
ctx.exit()call, the OS process that is running the Python CLI will be destroyed.Still, in unittests, these state leaks will leads to flaky and non-deterministic tests, as the
pytest,toxor any other test framework will keep using the same Python interpreter. To demonstrate this, I implemented a unit test using loggers as a fixture, in addition to a generic unit test.Checklist:
CHANGES.rstsummarizing the change and linking to the issue... versionchanged::entries in any relevant code docs.pre-commithooks and fix any issues.pytestandtox, no tests failed.