Skip to content

Fix mypy error when passing class method to with_argparser() and as_subcommand_to(). #1379

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

Merged
merged 1 commit into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
69 changes: 17 additions & 52 deletions cmd2/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
Optional,
Sequence,
Tuple,
Type,
TypeVar,
Union,
overload,
)

from . import (
Expand Down Expand Up @@ -65,19 +65,18 @@ def cat_decorator(func: CommandFunc) -> CommandFunc:
return cat_decorator


##########################
# The _parse_positionals and _arg_swap functions allow for additional positional args to be preserved
# in cmd2 command functions/callables. As long as the 2-ple of arguments we expect to be there can be
# found we can swap out the statement with each decorator's specific parameters
##########################


CommandParent = TypeVar('CommandParent', bound=Union['cmd2.Cmd', CommandSet])
CommandParentType = TypeVar('CommandParentType', bound=Union[Type['cmd2.Cmd'], Type[CommandSet]])


RawCommandFuncOptionalBoolReturn = Callable[[CommandParent, Union[Statement, str]], Optional[bool]]


##########################
# The _parse_positionals and _arg_swap functions allow for additional positional args to be preserved
# in cmd2 command functions/callables. As long as the 2-ple of arguments we expect to be there can be
# found we can swap out the statement with each decorator's specific parameters
##########################
def _parse_positionals(args: Tuple[Any, ...]) -> Tuple['cmd2.Cmd', Union[Statement, str]]:
"""
Helper function for cmd2 decorators to inspect the positional arguments until the cmd2.Cmd argument is found
Expand Down Expand Up @@ -265,28 +264,12 @@ def _set_parser_prog(parser: argparse.ArgumentParser, prog: str) -> None:
]


@overload
def with_argparser(
parser: argparse.ArgumentParser,
*,
ns_provider: Optional[Callable[..., argparse.Namespace]] = None,
preserve_quotes: bool = False,
with_unknown_args: bool = False,
) -> Callable[[ArgparseCommandFunc[CommandParent]], RawCommandFuncOptionalBoolReturn[CommandParent]]: ... # pragma: no cover


@overload
def with_argparser(
parser: Callable[[], argparse.ArgumentParser],
*,
ns_provider: Optional[Callable[..., argparse.Namespace]] = None,
preserve_quotes: bool = False,
with_unknown_args: bool = False,
) -> Callable[[ArgparseCommandFunc[CommandParent]], RawCommandFuncOptionalBoolReturn[CommandParent]]: ... # pragma: no cover


def with_argparser(
parser: Union[argparse.ArgumentParser, Callable[[], argparse.ArgumentParser]],
parser: Union[
argparse.ArgumentParser, # existing parser
Callable[[], argparse.ArgumentParser], # function or staticmethod
Callable[[CommandParentType], argparse.ArgumentParser], # Cmd or CommandSet classmethod
],
*,
ns_provider: Optional[Callable[..., argparse.Namespace]] = None,
preserve_quotes: bool = False,
Expand Down Expand Up @@ -413,32 +396,14 @@ def cmd_wrapper(*args: Any, **kwargs: Dict[str, Any]) -> Optional[bool]:
return arg_decorator


@overload
def as_subcommand_to(
command: str,
subcommand: str,
parser: argparse.ArgumentParser,
*,
help: Optional[str] = None,
aliases: Optional[List[str]] = None,
) -> Callable[[ArgparseCommandFunc[CommandParent]], ArgparseCommandFunc[CommandParent]]: ... # pragma: no cover


@overload
def as_subcommand_to(
command: str,
subcommand: str,
parser: Callable[[], argparse.ArgumentParser],
*,
help: Optional[str] = None,
aliases: Optional[List[str]] = None,
) -> Callable[[ArgparseCommandFunc[CommandParent]], ArgparseCommandFunc[CommandParent]]: ... # pragma: no cover


def as_subcommand_to(
command: str,
subcommand: str,
parser: Union[argparse.ArgumentParser, Callable[[], argparse.ArgumentParser]],
parser: Union[
argparse.ArgumentParser, # existing parser
Callable[[], argparse.ArgumentParser], # function or staticmethod
Callable[[CommandParentType], argparse.ArgumentParser], # Cmd or CommandSet classmethod
],
*,
help: Optional[str] = None,
aliases: Optional[List[str]] = None,
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@
('py:class', 'ArgparseCommandFunc'),
('py:class', 'argparse._SubParsersAction'),
('py:class', 'cmd2.decorators.CommandParent'),
('py:class', 'cmd2.decorators.CommandParentType'),
('py:class', 'cmd2.utils._T'),
('py:class', 'CommandParent'),
('py:class', 'frame'),
Expand Down
Loading