Skip to content

fix: fix annotated typing #1692

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
tleonhardt merged 4 commits into from
Jun 11, 2026
+19 −2
Merged

fix: fix annotated typing #1692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0ef6fb7
chore: fix annotated typing
KelvinChung2000 Jun 10, 2026
58655e0
Merge branch 'main' into feat/annotated-paramspec-typing
tleonhardt Jun 10, 2026
beeaced
fix(annotated): drop unnecessary string annotations, add changelog
KelvinChung2000 Jun 11, 2026
97bb805
Merge branch 'main' into feat/annotated-paramspec-typing
tleonhardt Jun 11, 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 @@ -5,6 +5,11 @@
- **complete_in_thread**: (boolean) if `True`, then completion will run in a separate
thread. If `False` then completion runs in the main thread and causes it to block if slow.
Defaults to `True`.

- Bug Fixes
- Fixed type hinting so that methods decorated with `with_annotated` no longer trigger spurious
mypy errors and preserve their original signature.

- Experimental features
- `@with_annotated` now supports `frozenset[T]` collection parameters, alongside the existing
`list[T]`, `set[T]`, and `tuple[T, ...]` collection types.
Expand Down
16 changes: 14 additions & 2 deletions cmd2/annotated.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,8 @@ def do_paint(
Any,
ClassVar,
Literal,
ParamSpec,
Protocol,
TypedDict,
TypeVar,
Union,
Expand Down Expand Up @@ -2137,8 +2139,18 @@ def handler(self_arg: Any, ns: Any) -> Any:
return handler, subcmd_name, parser_builder


_CommandParams = ParamSpec("_CommandParams")
Comment thread
tleonhardt marked this conversation as resolved.
_CommandReturn = TypeVar("_CommandReturn")


class _WithAnnotatedDecorator(Protocol):
"""The signature-preserving decorator ``with_annotated(...)`` returns (generic per call)."""

def __call__(self, fn: Callable[_CommandParams, _CommandReturn], /) -> Callable[_CommandParams, _CommandReturn]: ...


@overload
def with_annotated(func: Callable[..., Any]) -> Callable[..., Any]: ...
def with_annotated(func: Callable[_CommandParams, _CommandReturn]) -> Callable[_CommandParams, _CommandReturn]: ...


@overload
Expand All @@ -2161,7 +2173,7 @@ def with_annotated(
subcommand_title: str | None = ...,
subcommand_description: str | None = ...,
**parser_kwargs: Unpack[Cmd2ParserKwargs],
) -> Callable[[Callable[..., Any]], Callable[..., Any]]: ...
) -> _WithAnnotatedDecorator: ...


def with_annotated(
Expand Down
Loading