.config/coc/extensions/node_modules/coc-pyright/node_modules/pyright/dist/typeshed-fallback/stdlib/optparse.pyi

   1 from typing import IO, Any, AnyStr, Callable, Iterable, Mapping, Sequence, Tuple, Type, overload
   2
   3 NO_DEFAULT: Tuple[str, ...]
   4 SUPPRESS_HELP: str
   5 SUPPRESS_USAGE: str
   6
   7 def check_builtin(option: Option, opt: Any, value: str) -> Any: ...
   8 def check_choice(option: Option, opt: Any, value: str) -> Any: ...
   9
  10 class OptParseError(Exception):
  11     msg: str
  12     def __init__(self, msg: str) -> None: ...
  13
  14 class BadOptionError(OptParseError):
  15     opt_str: str
  16     def __init__(self, opt_str: str) -> None: ...
  17
  18 class AmbiguousOptionError(BadOptionError):
  19     possibilities: Iterable[str]
  20     def __init__(self, opt_str: str, possibilities: Sequence[str]) -> None: ...
  21
  22 class OptionError(OptParseError):
  23     msg: str
  24     option_id: str
  25     def __init__(self, msg: str, option: Option) -> None: ...
  26
  27 class OptionConflictError(OptionError): ...
  28 class OptionValueError(OptParseError): ...
  29
  30 class HelpFormatter:
  31     NO_DEFAULT_VALUE: str
  32     _long_opt_fmt: str
  33     _short_opt_fmt: str
  34     current_indent: int
  35     default_tag: str
  36     help_position: Any
  37     help_width: Any
  38     indent_increment: int
  39     level: int
  40     max_help_position: int
  41     option_strings: dict[Option, str]
  42     parser: OptionParser
  43     short_first: Any
  44     width: int
  45     def __init__(self, indent_increment: int, max_help_position: int, width: int | None, short_first: int) -> None: ...
  46     def dedent(self) -> None: ...
  47     def expand_default(self, option: Option) -> str: ...
  48     def format_description(self, description: str) -> str: ...
  49     def format_epilog(self, epilog: str) -> str: ...
  50     def format_heading(self, heading: Any) -> str: ...
  51     def format_option(self, option: Option) -> str: ...
  52     def format_option_strings(self, option: Option) -> str: ...
  53     def format_usage(self, usage: Any) -> str: ...
  54     def indent(self) -> None: ...
  55     def set_long_opt_delimiter(self, delim: str) -> None: ...
  56     def set_parser(self, parser: OptionParser) -> None: ...
  57     def set_short_opt_delimiter(self, delim: str) -> None: ...
  58     def store_option_strings(self, parser: OptionParser) -> None: ...
  59
  60 class IndentedHelpFormatter(HelpFormatter):
  61     def __init__(
  62         self, indent_increment: int = ..., max_help_position: int = ..., width: int | None = ..., short_first: int = ...
  63     ) -> None: ...
  64     def format_heading(self, heading: str) -> str: ...
  65     def format_usage(self, usage: str) -> str: ...
  66
  67 class TitledHelpFormatter(HelpFormatter):
  68     def __init__(
  69         self, indent_increment: int = ..., max_help_position: int = ..., width: int | None = ..., short_first: int = ...
  70     ) -> None: ...
  71     def format_heading(self, heading: str) -> str: ...
  72     def format_usage(self, usage: str) -> str: ...
  73
  74 class Option:
  75     ACTIONS: Tuple[str, ...]
  76     ALWAYS_TYPED_ACTIONS: Tuple[str, ...]
  77     ATTRS: list[str]
  78     CHECK_METHODS: list[Callable[..., Any]] | None
  79     CONST_ACTIONS: Tuple[str, ...]
  80     STORE_ACTIONS: Tuple[str, ...]
  81     TYPED_ACTIONS: Tuple[str, ...]
  82     TYPES: Tuple[str, ...]
  83     TYPE_CHECKER: dict[str, Callable[..., Any]]
  84     _long_opts: list[str]
  85     _short_opts: list[str]
  86     action: str
  87     dest: str | None
  88     default: Any
  89     nargs: int
  90     type: Any
  91     callback: Callable[..., Any] | None
  92     callback_args: Tuple[Any, ...] | None
  93     callback_kwargs: dict[str, Any] | None
  94     help: str | None
  95     metavar: str | None
  96     def __init__(self, *opts: str | None, **attrs: Any) -> None: ...
  97     def _check_action(self) -> None: ...
  98     def _check_callback(self) -> None: ...
  99     def _check_choice(self) -> None: ...
 100     def _check_const(self) -> None: ...
 101     def _check_dest(self) -> None: ...
 102     def _check_nargs(self) -> None: ...
 103     def _check_opt_strings(self, opts: Iterable[str | None]) -> list[str]: ...
 104     def _check_type(self) -> None: ...
 105     def _set_attrs(self, attrs: dict[str, Any]) -> None: ...
 106     def _set_opt_strings(self, opts: Iterable[str]) -> None: ...
 107     def check_value(self, opt: str, value: Any) -> Any: ...
 108     def convert_value(self, opt: str, value: Any) -> Any: ...
 109     def get_opt_string(self) -> str: ...
 110     def process(self, opt: Any, value: Any, values: Any, parser: OptionParser) -> int: ...
 111     def take_action(self, action: str, dest: str, opt: Any, value: Any, values: Any, parser: OptionParser) -> int: ...
 112     def takes_value(self) -> bool: ...
 113
 114 make_option = Option
 115
 116 class OptionContainer:
 117     _long_opt: dict[str, Option]
 118     _short_opt: dict[str, Option]
 119     conflict_handler: str
 120     defaults: dict[str, Any]
 121     description: Any
 122     option_class: Type[Option]
 123     def __init__(self, option_class: Type[Option], conflict_handler: Any, description: Any) -> None: ...
 124     def _check_conflict(self, option: Any) -> None: ...
 125     def _create_option_mappings(self) -> None: ...
 126     def _share_option_mappings(self, parser: OptionParser) -> None: ...
 127     @overload
 128     def add_option(self, opt: Option) -> Option: ...
 129     @overload
 130     def add_option(self, *args: str | None, **kwargs: Any) -> Any: ...
 131     def add_options(self, option_list: Iterable[Option]) -> None: ...
 132     def destroy(self) -> None: ...
 133     def format_description(self, formatter: HelpFormatter | None) -> Any: ...
 134     def format_help(self, formatter: HelpFormatter | None) -> str: ...
 135     def format_option_help(self, formatter: HelpFormatter | None) -> str: ...
 136     def get_description(self) -> Any: ...
 137     def get_option(self, opt_str: str) -> Option | None: ...
 138     def has_option(self, opt_str: str) -> bool: ...
 139     def remove_option(self, opt_str: str) -> None: ...
 140     def set_conflict_handler(self, handler: Any) -> None: ...
 141     def set_description(self, description: Any) -> None: ...
 142
 143 class OptionGroup(OptionContainer):
 144     option_list: list[Option]
 145     parser: OptionParser
 146     title: str
 147     def __init__(self, parser: OptionParser, title: str, description: str | None = ...) -> None: ...
 148     def _create_option_list(self) -> None: ...
 149     def set_title(self, title: str) -> None: ...
 150
 151 class Values:
 152     def __init__(self, defaults: Mapping[str, Any] | None = ...) -> None: ...
 153     def _update(self, dict: Mapping[str, Any], mode: Any) -> None: ...
 154     def _update_careful(self, dict: Mapping[str, Any]) -> None: ...
 155     def _update_loose(self, dict: Mapping[str, Any]) -> None: ...
 156     def ensure_value(self, attr: str, value: Any) -> Any: ...
 157     def read_file(self, filename: str, mode: str = ...) -> None: ...
 158     def read_module(self, modname: str, mode: str = ...) -> None: ...
 159     def __getattr__(self, name: str) -> Any: ...
 160     def __setattr__(self, name: str, value: Any) -> None: ...
 161
 162 class OptionParser(OptionContainer):
 163     allow_interspersed_args: bool
 164     epilog: str | None
 165     formatter: HelpFormatter
 166     largs: list[str] | None
 167     option_groups: list[OptionGroup]
 168     option_list: list[Option]
 169     process_default_values: Any
 170     prog: str | None
 171     rargs: list[Any] | None
 172     standard_option_list: list[Option]
 173     usage: str | None
 174     values: Values | None
 175     version: str
 176     def __init__(
 177         self,
 178         usage: str | None = ...,
 179         option_list: Iterable[Option] | None = ...,
 180         option_class: Type[Option] = ...,
 181         version: str | None = ...,
 182         conflict_handler: str = ...,
 183         description: str | None = ...,
 184         formatter: HelpFormatter | None = ...,
 185         add_help_option: bool = ...,
 186         prog: str | None = ...,
 187         epilog: str | None = ...,
 188     ) -> None: ...
 189     def _add_help_option(self) -> None: ...
 190     def _add_version_option(self) -> None: ...
 191     def _create_option_list(self) -> None: ...
 192     def _get_all_options(self) -> list[Option]: ...
 193     def _get_args(self, args: Iterable[Any]) -> list[Any]: ...
 194     def _init_parsing_state(self) -> None: ...
 195     def _match_long_opt(self, opt: str) -> str: ...
 196     def _populate_option_list(self, option_list: Iterable[Option], add_help: bool = ...) -> None: ...
 197     def _process_args(self, largs: list[Any], rargs: list[Any], values: Values) -> None: ...
 198     def _process_long_opt(self, rargs: list[Any], values: Any) -> None: ...
 199     def _process_short_opts(self, rargs: list[Any], values: Any) -> None: ...
 200     @overload
 201     def add_option_group(self, __opt_group: OptionGroup) -> OptionGroup: ...
 202     @overload
 203     def add_option_group(self, *args: Any, **kwargs: Any) -> OptionGroup: ...
 204     def check_values(self, values: Values, args: list[str]) -> tuple[Values, list[str]]: ...
 205     def disable_interspersed_args(self) -> None: ...
 206     def enable_interspersed_args(self) -> None: ...
 207     def error(self, msg: str) -> None: ...
 208     def exit(self, status: int = ..., msg: str | None = ...) -> None: ...
 209     def expand_prog_name(self, s: str | None) -> Any: ...
 210     def format_epilog(self, formatter: HelpFormatter) -> Any: ...
 211     def format_help(self, formatter: HelpFormatter | None = ...) -> str: ...
 212     def format_option_help(self, formatter: HelpFormatter | None = ...) -> str: ...
 213     def get_default_values(self) -> Values: ...
 214     def get_option_group(self, opt_str: str) -> Any: ...
 215     def get_prog_name(self) -> str: ...
 216     def get_usage(self) -> str: ...
 217     def get_version(self) -> str: ...
 218     def parse_args(self, args: Sequence[AnyStr] | None = ..., values: Values | None = ...) -> tuple[Values, list[AnyStr]]: ...
 219     def print_usage(self, file: IO[str] | None = ...) -> None: ...
 220     def print_help(self, file: IO[str] | None = ...) -> None: ...
 221     def print_version(self, file: IO[str] | None = ...) -> None: ...
 222     def set_default(self, dest: Any, value: Any) -> None: ...
 223     def set_defaults(self, **kwargs: Any) -> None: ...
 224     def set_process_default_values(self, process: Any) -> None: ...
 225     def set_usage(self, usage: str) -> None: ...