Skip to content

Overhauled custom types. #1635

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
kmvanbrunt wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Overhauled custom types. #1635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
96d7d57
Improved type hints.
kmvanbrunt Apr 15, 2026
1407e18
Renamed Cmd.cmd_func() to Cmd.get_command_func().
kmvanbrunt Apr 15, 2026
b032bf0
Updated change log.
kmvanbrunt Apr 15, 2026
fc668f0
Made some type hints more strict.
kmvanbrunt Apr 16, 2026
f4e9f31
Simplified type aliases in decorators.py.
kmvanbrunt Apr 16, 2026
584fbdf
Fixed type checking for with_argument_list when passing preserve_quotes.
kmvanbrunt Apr 16, 2026
094223d
Updated comments.
kmvanbrunt Apr 16, 2026
643b066
Updated import.
kmvanbrunt Apr 16, 2026
c6f5a2c
Updated comment.
kmvanbrunt Apr 16, 2026
24592bc
Made type hints of with_category() and as_subcommand_to() more permis…
kmvanbrunt Apr 16, 2026
1801d64
Fixed CHANGELOG.
kmvanbrunt Apr 16, 2026
5d74fb2
Updated comments.
kmvanbrunt Apr 16, 2026
1dffe3f
Updated comments.
kmvanbrunt Apr 16, 2026
26ef9c9
Updated comments.
kmvanbrunt Apr 16, 2026
fc2b390
Simplified some code.
kmvanbrunt Apr 16, 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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ prompt is displayed.
driven by the `DEFAULT_CATEGORY` class variable (see **Simplified command categorization** in
the Enhancements section below for details).
- Removed `Cmd.undoc_header` since all commands are now considered categorized.
- Renamed `Cmd.cmd_func()` to `Cmd.get_command_func()`.
- Enhancements
- New `cmd2.Cmd` parameters
- **auto_suggest**: (boolean) if `True`, provide fish shell style auto-suggestions. These
Expand Down Expand Up @@ -107,6 +108,10 @@ prompt is displayed.
- Individual commands can still be manually moved using the `with_category()` decorator.
- For more details and examples, see the [Help](docs/features/help.md) documentation and the
`examples/default_categories.py` file.
- `CommandSet` is now a generic class, which allows developers to parameterize it with their
specific `cmd2.Cmd` subclass (e.g.,`class MyCommandSet(CommandSet[MyApp]):`). This provides
full type hints and IDE autocompletion for `self._cmd` without needing to override and cast
the property.

## 3.5.0 (April 13, 2026)

Expand Down
16 changes: 8 additions & 8 deletions cmd2/argparse_completer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@
from .exceptions import CompletionError
from .rich_utils import Cmd2SimpleTable
from .types import (
ChoicesProviderUnbound,
CmdOrSet,
CompleterUnbound,
CmdOrSetT,
Comment thread
tleonhardt marked this conversation as resolved.
UnboundChoicesProvider,
UnboundCompleter,
)

if TYPE_CHECKING: # pragma: no cover
Expand Down Expand Up @@ -214,7 +214,7 @@ def complete(
endidx: int,
tokens: Sequence[str],
*,
cmd_set: CommandSet | None = None,
cmd_set: CommandSet[Any] | None = None,
) -> Completions:
"""Complete text using argparse metadata.

Expand Down Expand Up @@ -469,7 +469,7 @@ def _handle_last_token(
consumed_arg_values: dict[str, list[str]],
used_flags: set[str],
skip_remaining_flags: bool,
cmd_set: CommandSet | None,
cmd_set: CommandSet[Any] | None,
) -> Completions:
"""Perform final completion step handling positionals and flags."""
# Check if we are completing a flag name. This check ignores strings with a length of one, like '-'.
Expand Down Expand Up @@ -734,11 +734,11 @@ def _choices_to_items(self, arg_state: _ArgumentState) -> list[CompletionItem]:

def _prepare_callable_params(
self,
to_call: ChoicesProviderUnbound[CmdOrSet] | CompleterUnbound[CmdOrSet],
to_call: UnboundChoicesProvider[CmdOrSetT] | UnboundCompleter[CmdOrSetT],
arg_state: _ArgumentState,
text: str,
consumed_arg_values: dict[str, list[str]],
cmd_set: CommandSet | None,
cmd_set: CommandSet[Any] | None,
) -> tuple[list[Any], dict[str, Any]]:
"""Resolve the instance and arguments required to call a choices/completer function."""
args: list[Any] = []
Expand Down Expand Up @@ -769,7 +769,7 @@ def _complete_arg(
arg_state: _ArgumentState,
consumed_arg_values: dict[str, list[str]],
*,
cmd_set: CommandSet | None = None,
cmd_set: CommandSet[Any] | None = None,
) -> Completions:
"""Completion routine for an argparse argument.

Expand Down
10 changes: 5 additions & 5 deletions cmd2/argparse_custom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,9 +262,9 @@ def get_choices(self) -> Choices:
from .rich_utils import Cmd2RichArgparseConsole
from .styles import Cmd2Style
from .types import (
ChoicesProviderUnbound,
CmdOrSet,
CompleterUnbound,
CmdOrSetT,
UnboundChoicesProvider,
UnboundCompleter,
)

if TYPE_CHECKING: # pragma: no cover
Expand Down Expand Up @@ -388,8 +388,8 @@ def _ActionsContainer_add_argument( # noqa: N802
self: argparse._ActionsContainer,
*args: Any,
nargs: int | str | tuple[int] | tuple[int, int] | tuple[int, float] | None = None,
choices_provider: ChoicesProviderUnbound[CmdOrSet] | None = None,
completer: CompleterUnbound[CmdOrSet] | None = None,
choices_provider: UnboundChoicesProvider[CmdOrSetT] | None = None,
completer: UnboundCompleter[CmdOrSetT] | None = None,
suppress_tab_hint: bool = False,
table_columns: Sequence[str | Column] | None = None,
**kwargs: Any,
Expand Down
Loading
Loading