-
-
Notifications
You must be signed in to change notification settings - Fork 851
Handle Abort/Exit during shell completion #1487
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.
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
Open
mpouzoup
wants to merge
8
commits into
fastapi:master
Choose a base branch
from
mpouzoup:fix-shell-completion-abort-exit
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
56957e3
Handle Abort/Exit during shell completion
mpouzoup 0e45ad2
Merge branch 'master' into fix-shell-completion-abort-exit
svlandeg 76ff772
Add regression tests for Abort/Exit during shell completion
mpouzoup 4dbf25b
🎨 Auto format
pre-commit-ci-lite[bot] a54d660
Add small test to cover default completion methods
mpouzoup 259a928
Fix regression test for shell completion Abort/Exit
mpouzoup 15d8cf4
Cover default FakeCompletion methods for coverage
mpouzoup 257f788
🎨 Auto format
pre-commit-ci-lite[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import click | ||
| import pytest | ||
| from typer.completion import shell_complete | ||
|
|
||
|
|
||
| class _FakeCompletion: | ||
| def __init__(self, cli, ctx_args, prog_name, complete_var): | ||
| self.cli = cli | ||
| self.ctx_args = ctx_args | ||
| self.prog_name = prog_name | ||
| self.complete_var = complete_var | ||
|
|
||
| def source(self): | ||
| # This will be overridden per-test via monkeypatch on the class | ||
| return "" | ||
|
|
||
| def complete(self): | ||
| # This will be overridden per-test via monkeypatch on the class | ||
| return "" | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "instruction", | ||
| ["complete_zsh", "source_zsh"], | ||
| ) | ||
| @pytest.mark.parametrize( | ||
| "exc", | ||
| [click.exceptions.Abort, click.exceptions.Exit], | ||
| ) | ||
| def test_shell_complete_handles_abort_and_exit(monkeypatch, capsys, instruction, exc): | ||
| monkeypatch.setattr( | ||
| click.shell_completion, | ||
| "get_completion_class", | ||
| lambda shell: _FakeCompletion, | ||
| ) | ||
|
|
||
| if instruction.startswith("complete"): | ||
| monkeypatch.setattr( | ||
| _FakeCompletion, "complete", lambda self: (_ for _ in ()).throw(exc()) | ||
| ) | ||
| else: | ||
| monkeypatch.setattr( | ||
| _FakeCompletion, "source", lambda self: (_ for _ in ()).throw(exc()) | ||
| ) | ||
|
|
||
| cli = click.Command("demo") | ||
|
|
||
| code = shell_complete( | ||
| cli=cli, | ||
| ctx_args={}, | ||
| prog_name="demo", | ||
| complete_var="_DEMO_COMPLETE", | ||
| instruction=instruction, | ||
| ) | ||
|
|
||
| out = capsys.readouterr() | ||
| assert code == 0 | ||
| assert out.out == "" | ||
| assert out.err == "" | ||
|
|
||
|
|
||
| def test_fake_completion_default_methods_are_covered(): | ||
| fc = _FakeCompletion(click.Command("demo"), {}, "demo", "_DEMO_COMPLETE") | ||
| assert fc.complete() == "" | ||
| assert fc.source() == "" | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just to avoid coverage issues on this particular file, right? As it's a test file, it's cleaner to just add
# pragma: no coverto those respective lines, no need to have a test testing the test 😉