Skip to content

Do not submit command when user presses enter to select a completion. #1613

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

Merged
kmvanbrunt merged 2 commits into from
Mar 23, 2026
Merged

Do not submit command when user presses enter to select a completion. #1613

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
832fa9a
Do not submit command line when user presses enter when selecting a c…
kmvanbrunt Mar 23, 2026
da219fe
Added pragma: no cover.
kmvanbrunt Mar 23, 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
12 changes: 9 additions & 3 deletions cmd2/cmd2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,11 +684,17 @@ def _create_main_session(self, auto_suggest: bool, completekey: str) -> PromptSe
Otherwise, uses dummy drivers to support non-interactive streams like
pipes or files.
"""
key_bindings = None
# Configure custom key bindings
key_bindings = KeyBindings()

# Add a binding for 'enter' that triggers only when a completion is selected.
# This allows accepting a completion without submitting the command.
@key_bindings.add('enter', filter=filters.completion_is_selected)
def _(event: Any) -> None: # pragma: no cover
event.current_buffer.complete_state = None

if completekey != self.DEFAULT_COMPLETEKEY:
# Configure prompt_toolkit `KeyBindings` with the custom key for completion
key_bindings = KeyBindings()

@key_bindings.add(completekey)
def _(event: Any) -> None: # pragma: no cover
"""Trigger completion."""
Expand Down
Loading