mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-08 21:14:48 +08:00
354 lines
14 KiB
Python
354 lines
14 KiB
Python
from typing import IO, Any, Callable, Generator, Iterable, NoReturn, Pattern, Protocol, Sequence, Text, TypeVar, overload
|
|
|
|
_T = TypeVar("_T")
|
|
_ActionT = TypeVar("_ActionT", bound=Action)
|
|
_N = TypeVar("_N")
|
|
|
|
_Text = str | unicode
|
|
|
|
ONE_OR_MORE: str
|
|
OPTIONAL: str
|
|
PARSER: str
|
|
REMAINDER: str
|
|
SUPPRESS: str
|
|
ZERO_OR_MORE: str
|
|
_UNRECOGNIZED_ARGS_ATTR: str # undocumented
|
|
|
|
class ArgumentError(Exception):
|
|
argument_name: str | None
|
|
message: str
|
|
def __init__(self, argument: Action | None, message: str) -> None: ...
|
|
|
|
# undocumented
|
|
class _AttributeHolder:
|
|
def _get_kwargs(self) -> list[tuple[str, Any]]: ...
|
|
def _get_args(self) -> list[Any]: ...
|
|
|
|
# undocumented
|
|
class _ActionsContainer:
|
|
description: _Text | None
|
|
prefix_chars: _Text
|
|
argument_default: Any
|
|
conflict_handler: _Text
|
|
|
|
_registries: dict[_Text, dict[Any, Any]]
|
|
_actions: list[Action]
|
|
_option_string_actions: dict[_Text, Action]
|
|
_action_groups: list[_ArgumentGroup]
|
|
_mutually_exclusive_groups: list[_MutuallyExclusiveGroup]
|
|
_defaults: dict[str, Any]
|
|
_negative_number_matcher: Pattern[str]
|
|
_has_negative_number_optionals: list[bool]
|
|
def __init__(self, description: Text | None, prefix_chars: Text, argument_default: Any, conflict_handler: Text) -> None: ...
|
|
def register(self, registry_name: Text, value: Any, object: Any) -> None: ...
|
|
def _registry_get(self, registry_name: Text, value: Any, default: Any = ...) -> Any: ...
|
|
def set_defaults(self, **kwargs: Any) -> None: ...
|
|
def get_default(self, dest: Text) -> Any: ...
|
|
def add_argument(
|
|
self,
|
|
*name_or_flags: Text,
|
|
action: Text | type[Action] = ...,
|
|
nargs: int | Text = ...,
|
|
const: Any = ...,
|
|
default: Any = ...,
|
|
type: Callable[[Text], _T] | Callable[[str], _T] | FileType = ...,
|
|
choices: Iterable[_T] = ...,
|
|
required: bool = ...,
|
|
help: Text | None = ...,
|
|
metavar: Text | tuple[Text, ...] | None = ...,
|
|
dest: Text | None = ...,
|
|
version: Text = ...,
|
|
**kwargs: Any,
|
|
) -> Action: ...
|
|
def add_argument_group(self, *args: Any, **kwargs: Any) -> _ArgumentGroup: ...
|
|
def add_mutually_exclusive_group(self, **kwargs: Any) -> _MutuallyExclusiveGroup: ...
|
|
def _add_action(self, action: _ActionT) -> _ActionT: ...
|
|
def _remove_action(self, action: Action) -> None: ...
|
|
def _add_container_actions(self, container: _ActionsContainer) -> None: ...
|
|
def _get_positional_kwargs(self, dest: Text, **kwargs: Any) -> dict[str, Any]: ...
|
|
def _get_optional_kwargs(self, *args: Any, **kwargs: Any) -> dict[str, Any]: ...
|
|
def _pop_action_class(self, kwargs: Any, default: type[Action] | None = ...) -> type[Action]: ...
|
|
def _get_handler(self) -> Callable[[Action, Iterable[tuple[Text, Action]]], Any]: ...
|
|
def _check_conflict(self, action: Action) -> None: ...
|
|
def _handle_conflict_error(self, action: Action, conflicting_actions: Iterable[tuple[Text, Action]]) -> NoReturn: ...
|
|
def _handle_conflict_resolve(self, action: Action, conflicting_actions: Iterable[tuple[Text, Action]]) -> None: ...
|
|
|
|
class _FormatterClass(Protocol):
|
|
def __call__(self, prog: str) -> HelpFormatter: ...
|
|
|
|
class ArgumentParser(_AttributeHolder, _ActionsContainer):
|
|
prog: _Text
|
|
usage: _Text | None
|
|
epilog: _Text | None
|
|
formatter_class: _FormatterClass
|
|
fromfile_prefix_chars: _Text | None
|
|
add_help: bool
|
|
|
|
# undocumented
|
|
_positionals: _ArgumentGroup
|
|
_optionals: _ArgumentGroup
|
|
_subparsers: _ArgumentGroup | None
|
|
def __init__(
|
|
self,
|
|
prog: Text | None = ...,
|
|
usage: Text | None = ...,
|
|
description: Text | None = ...,
|
|
epilog: Text | None = ...,
|
|
parents: Sequence[ArgumentParser] = ...,
|
|
formatter_class: _FormatterClass = ...,
|
|
prefix_chars: Text = ...,
|
|
fromfile_prefix_chars: Text | None = ...,
|
|
argument_default: Any = ...,
|
|
conflict_handler: Text = ...,
|
|
add_help: bool = ...,
|
|
) -> None: ...
|
|
# The type-ignores in these overloads should be temporary. See:
|
|
# https://github.com/python/typeshed/pull/2643#issuecomment-442280277
|
|
@overload
|
|
def parse_args(self, args: Sequence[Text] | None = ...) -> Namespace: ...
|
|
@overload
|
|
def parse_args(self, args: Sequence[Text] | None, namespace: None) -> Namespace: ... # type: ignore[misc]
|
|
@overload
|
|
def parse_args(self, args: Sequence[Text] | None, namespace: _N) -> _N: ...
|
|
@overload
|
|
def parse_args(self, *, namespace: None) -> Namespace: ... # type: ignore[misc]
|
|
@overload
|
|
def parse_args(self, *, namespace: _N) -> _N: ...
|
|
def add_subparsers(
|
|
self,
|
|
*,
|
|
title: Text = ...,
|
|
description: Text | None = ...,
|
|
prog: Text = ...,
|
|
parser_class: type[ArgumentParser] = ...,
|
|
action: type[Action] = ...,
|
|
option_string: Text = ...,
|
|
dest: Text | None = ...,
|
|
help: Text | None = ...,
|
|
metavar: Text | None = ...,
|
|
) -> _SubParsersAction: ...
|
|
def print_usage(self, file: IO[str] | None = ...) -> None: ...
|
|
def print_help(self, file: IO[str] | None = ...) -> None: ...
|
|
def format_usage(self) -> str: ...
|
|
def format_help(self) -> str: ...
|
|
def parse_known_args(
|
|
self, args: Sequence[Text] | None = ..., namespace: Namespace | None = ...
|
|
) -> tuple[Namespace, list[str]]: ...
|
|
def convert_arg_line_to_args(self, arg_line: Text) -> list[str]: ...
|
|
def exit(self, status: int = ..., message: Text | None = ...) -> NoReturn: ...
|
|
def error(self, message: Text) -> NoReturn: ...
|
|
# undocumented
|
|
def _get_optional_actions(self) -> list[Action]: ...
|
|
def _get_positional_actions(self) -> list[Action]: ...
|
|
def _parse_known_args(self, arg_strings: list[Text], namespace: Namespace) -> tuple[Namespace, list[str]]: ...
|
|
def _read_args_from_files(self, arg_strings: list[Text]) -> list[Text]: ...
|
|
def _match_argument(self, action: Action, arg_strings_pattern: Text) -> int: ...
|
|
def _match_arguments_partial(self, actions: Sequence[Action], arg_strings_pattern: Text) -> list[int]: ...
|
|
def _parse_optional(self, arg_string: Text) -> tuple[Action | None, Text, Text | None] | None: ...
|
|
def _get_option_tuples(self, option_string: Text) -> list[tuple[Action, Text, Text | None]]: ...
|
|
def _get_nargs_pattern(self, action: Action) -> _Text: ...
|
|
def _get_values(self, action: Action, arg_strings: list[Text]) -> Any: ...
|
|
def _get_value(self, action: Action, arg_string: Text) -> Any: ...
|
|
def _check_value(self, action: Action, value: Any) -> None: ...
|
|
def _get_formatter(self) -> HelpFormatter: ...
|
|
def _print_message(self, message: str, file: IO[str] | None = ...) -> None: ...
|
|
|
|
class HelpFormatter:
|
|
# undocumented
|
|
_prog: _Text
|
|
_indent_increment: int
|
|
_max_help_position: int
|
|
_width: int
|
|
_current_indent: int
|
|
_level: int
|
|
_action_max_length: int
|
|
_root_section: Any
|
|
_current_section: Any
|
|
_whitespace_matcher: Pattern[str]
|
|
_long_break_matcher: Pattern[str]
|
|
_Section: type[Any] # Nested class
|
|
def __init__(
|
|
self, prog: Text, indent_increment: int = ..., max_help_position: int = ..., width: int | None = ...
|
|
) -> None: ...
|
|
def _indent(self) -> None: ...
|
|
def _dedent(self) -> None: ...
|
|
def _add_item(self, func: Callable[..., _Text], args: Iterable[Any]) -> None: ...
|
|
def start_section(self, heading: Text | None) -> None: ...
|
|
def end_section(self) -> None: ...
|
|
def add_text(self, text: Text | None) -> None: ...
|
|
def add_usage(
|
|
self, usage: Text | None, actions: Iterable[Action], groups: Iterable[_ArgumentGroup], prefix: Text | None = ...
|
|
) -> None: ...
|
|
def add_argument(self, action: Action) -> None: ...
|
|
def add_arguments(self, actions: Iterable[Action]) -> None: ...
|
|
def format_help(self) -> _Text: ...
|
|
def _join_parts(self, part_strings: Iterable[Text]) -> _Text: ...
|
|
def _format_usage(
|
|
self, usage: Text, actions: Iterable[Action], groups: Iterable[_ArgumentGroup], prefix: Text | None
|
|
) -> _Text: ...
|
|
def _format_actions_usage(self, actions: Iterable[Action], groups: Iterable[_ArgumentGroup]) -> _Text: ...
|
|
def _format_text(self, text: Text) -> _Text: ...
|
|
def _format_action(self, action: Action) -> _Text: ...
|
|
def _format_action_invocation(self, action: Action) -> _Text: ...
|
|
def _metavar_formatter(self, action: Action, default_metavar: Text) -> Callable[[int], tuple[_Text, ...]]: ...
|
|
def _format_args(self, action: Action, default_metavar: Text) -> _Text: ...
|
|
def _expand_help(self, action: Action) -> _Text: ...
|
|
def _iter_indented_subactions(self, action: Action) -> Generator[Action, None, None]: ...
|
|
def _split_lines(self, text: Text, width: int) -> list[_Text]: ...
|
|
def _fill_text(self, text: Text, width: int, indent: Text) -> _Text: ...
|
|
def _get_help_string(self, action: Action) -> _Text | None: ...
|
|
def _get_default_metavar_for_optional(self, action: Action) -> _Text: ...
|
|
def _get_default_metavar_for_positional(self, action: Action) -> _Text: ...
|
|
|
|
class RawDescriptionHelpFormatter(HelpFormatter): ...
|
|
class RawTextHelpFormatter(RawDescriptionHelpFormatter): ...
|
|
class ArgumentDefaultsHelpFormatter(HelpFormatter): ...
|
|
|
|
class Action(_AttributeHolder):
|
|
option_strings: Sequence[_Text]
|
|
dest: _Text
|
|
nargs: int | _Text | None
|
|
const: Any
|
|
default: Any
|
|
type: Callable[[str], Any] | FileType | None
|
|
choices: Iterable[Any] | None
|
|
required: bool
|
|
help: _Text | None
|
|
metavar: _Text | tuple[_Text, ...] | None
|
|
def __init__(
|
|
self,
|
|
option_strings: Sequence[Text],
|
|
dest: Text,
|
|
nargs: int | Text | None = ...,
|
|
const: _T | None = ...,
|
|
default: _T | str | None = ...,
|
|
type: Callable[[Text], _T] | Callable[[str], _T] | FileType | None = ...,
|
|
choices: Iterable[_T] | None = ...,
|
|
required: bool = ...,
|
|
help: Text | None = ...,
|
|
metavar: Text | tuple[Text, ...] | None = ...,
|
|
) -> None: ...
|
|
def __call__(
|
|
self, parser: ArgumentParser, namespace: Namespace, values: Text | Sequence[Any] | None, option_string: Text | None = ...
|
|
) -> None: ...
|
|
|
|
class Namespace(_AttributeHolder):
|
|
def __init__(self, **kwargs: Any) -> None: ...
|
|
def __getattr__(self, name: Text) -> Any: ...
|
|
def __setattr__(self, name: Text, value: Any) -> None: ...
|
|
def __contains__(self, key: str) -> bool: ...
|
|
|
|
class FileType:
|
|
# undocumented
|
|
_mode: _Text
|
|
_bufsize: int
|
|
def __init__(self, mode: Text = ..., bufsize: int | None = ...) -> None: ...
|
|
def __call__(self, string: Text) -> IO[Any]: ...
|
|
|
|
# undocumented
|
|
class _ArgumentGroup(_ActionsContainer):
|
|
title: _Text | None
|
|
_group_actions: list[Action]
|
|
def __init__(
|
|
self, container: _ActionsContainer, title: Text | None = ..., description: Text | None = ..., **kwargs: Any
|
|
) -> None: ...
|
|
|
|
# undocumented
|
|
class _MutuallyExclusiveGroup(_ArgumentGroup):
|
|
required: bool
|
|
_container: _ActionsContainer
|
|
def __init__(self, container: _ActionsContainer, required: bool = ...) -> None: ...
|
|
|
|
# undocumented
|
|
class _StoreAction(Action): ...
|
|
|
|
# undocumented
|
|
class _StoreConstAction(Action):
|
|
def __init__(
|
|
self,
|
|
option_strings: Sequence[Text],
|
|
dest: Text,
|
|
const: Any,
|
|
default: Any = ...,
|
|
required: bool = ...,
|
|
help: Text | None = ...,
|
|
metavar: Text | tuple[Text, ...] | None = ...,
|
|
) -> None: ...
|
|
|
|
# undocumented
|
|
class _StoreTrueAction(_StoreConstAction):
|
|
def __init__(
|
|
self, option_strings: Sequence[Text], dest: Text, default: bool = ..., required: bool = ..., help: Text | None = ...
|
|
) -> None: ...
|
|
|
|
# undocumented
|
|
class _StoreFalseAction(_StoreConstAction):
|
|
def __init__(
|
|
self, option_strings: Sequence[Text], dest: Text, default: bool = ..., required: bool = ..., help: Text | None = ...
|
|
) -> None: ...
|
|
|
|
# undocumented
|
|
class _AppendAction(Action): ...
|
|
|
|
# undocumented
|
|
class _AppendConstAction(Action):
|
|
def __init__(
|
|
self,
|
|
option_strings: Sequence[Text],
|
|
dest: Text,
|
|
const: Any,
|
|
default: Any = ...,
|
|
required: bool = ...,
|
|
help: Text | None = ...,
|
|
metavar: Text | tuple[Text, ...] | None = ...,
|
|
) -> None: ...
|
|
|
|
# undocumented
|
|
class _CountAction(Action):
|
|
def __init__(
|
|
self, option_strings: Sequence[Text], dest: Text, default: Any = ..., required: bool = ..., help: Text | None = ...
|
|
) -> None: ...
|
|
|
|
# undocumented
|
|
class _HelpAction(Action):
|
|
def __init__(
|
|
self, option_strings: Sequence[Text], dest: Text = ..., default: Text = ..., help: Text | None = ...
|
|
) -> None: ...
|
|
|
|
# undocumented
|
|
class _VersionAction(Action):
|
|
version: _Text | None
|
|
def __init__(
|
|
self, option_strings: Sequence[Text], version: Text | None = ..., dest: Text = ..., default: Text = ..., help: Text = ...
|
|
) -> None: ...
|
|
|
|
# undocumented
|
|
class _SubParsersAction(Action):
|
|
_ChoicesPseudoAction: type[Any] # nested class
|
|
_prog_prefix: _Text
|
|
_parser_class: type[ArgumentParser]
|
|
_name_parser_map: dict[_Text, ArgumentParser]
|
|
choices: dict[_Text, ArgumentParser]
|
|
_choices_actions: list[Action]
|
|
def __init__(
|
|
self,
|
|
option_strings: Sequence[Text],
|
|
prog: Text,
|
|
parser_class: type[ArgumentParser],
|
|
dest: Text = ...,
|
|
help: Text | None = ...,
|
|
metavar: Text | tuple[Text, ...] | None = ...,
|
|
) -> None: ...
|
|
# TODO: Type keyword args properly.
|
|
def add_parser(self, name: Text, **kwargs: Any) -> ArgumentParser: ...
|
|
def _get_subactions(self) -> list[Action]: ...
|
|
|
|
# undocumented
|
|
class ArgumentTypeError(Exception): ...
|
|
|
|
# undocumented
|
|
def _ensure_value(namespace: Namespace, name: Text, value: Any) -> Any: ...
|
|
|
|
# undocumented
|
|
def _get_action_name(argument: Action | None) -> str | None: ...
|