Skip to content

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.

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

Open
mpouzoup wants to merge 8 commits into
base: master
Choose a base branch
from
+77 −2
Open

Handle Abort/Exit during shell completion #1487

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
56957e3
Handle Abort/Exit during shell completion
mpouzoup Jan 10, 2026
0e45ad2
Merge branch 'master' into fix-shell-completion-abort-exit
svlandeg Jan 12, 2026
76ff772
Add regression tests for Abort/Exit during shell completion
mpouzoup Jan 12, 2026
4dbf25b
🎨 Auto format
pre-commit-ci-lite[bot] Jan 12, 2026
a54d660
Add small test to cover default completion methods
mpouzoup Jan 12, 2026
259a928
Fix regression test for shell completion Abort/Exit
mpouzoup Jan 12, 2026
15d8cf4
Cover default FakeCompletion methods for coverage
mpouzoup Jan 12, 2026
257f788
🎨 Auto format
pre-commit-ci-lite[bot] Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions typer/completion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,22 @@ def shell_complete(
comp = comp_cls(cli, ctx_args, prog_name, complete_var)

if instruction == "source":
click.echo(comp.source())
try:
click.echo(comp.source())
except (click.exceptions.Abort, click.exceptions.Exit):
# During shell completion we should never show a traceback.
# If completion callbacks abort/exit, just return no output.
return 0
return 0

# Typer override to print the completion help msg with Rich
if instruction == "complete":
click.echo(comp.complete())
try:
click.echo(comp.complete())
except (click.exceptions.Abort, click.exceptions.Exit):
# During shell completion we should never show a traceback.
# If completion callbacks abort/exit, just return no output.
return 0
return 0
# Typer override end

Expand Down
Loading