mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-07 20:54:28 +08:00
update OptParse to work on 2and3 (#1164)
* update OptParse to work on 2and3 * remove duplicative dunder methods in Option * Union Nones to Optional and Text->_Text
This commit is contained in:
Ethan
226
stdlib/2and3/optparse.pyi
Normal file
226
stdlib/2and3/optparse.pyi
Normal file
@@ -0,0 +1,226 @@
|
||||
# Generated by pytype, with only minor tweaks. Might be incomplete.
|
||||
import sys
|
||||
from typing import Any, Optional, List, Callable, Tuple, Dict, Iterable, Union, Mapping, IO
|
||||
|
||||
# See https://groups.google.com/forum/#!topic/python-ideas/gA1gdj3RZ5g
|
||||
if sys.version_info >= (3,):
|
||||
_Text = str
|
||||
else:
|
||||
_Text = Union[str, unicode]
|
||||
|
||||
NO_DEFAULT = ... # type: Tuple[_Text, ...]
|
||||
SUPPRESS_HELP = ... # type: _Text
|
||||
SUPPRESS_USAGE = ... # type: _Text
|
||||
|
||||
def check_builtin(option: Option, opt: Any, value: _Text) -> Any: ...
|
||||
def check_choice(option: Option, opt: Any, value: _Text) -> Any: ...
|
||||
if sys.version_info >= (3,):
|
||||
def isbasestring(x: Any) -> bool: ...
|
||||
|
||||
class OptParseError(Exception):
|
||||
msg = ... # type: _Text
|
||||
def __init__(self, msg: _Text) -> None: ...
|
||||
|
||||
class BadOptionError(OptParseError):
|
||||
opt_str = ... # type: _Text
|
||||
def __init__(self, opt_str: _Text) -> None: ...
|
||||
|
||||
class AmbiguousOptionError(BadOptionError):
|
||||
possibilities = ... # type: Iterable[_Text]
|
||||
def __init__(self, opt_str: _Text, possibilities: List[_Text]) -> None: ...
|
||||
|
||||
class OptionError(OptParseError):
|
||||
msg = ... # type: _Text
|
||||
option_id = ... # type: _Text
|
||||
def __init__(self, msg: _Text, option: Option) -> None: ...
|
||||
|
||||
class OptionConflictError(OptionError): ...
|
||||
|
||||
class OptionValueError(OptParseError): ...
|
||||
|
||||
|
||||
class HelpFormatter:
|
||||
NO_DEFAULT_VALUE = ... # type: _Text
|
||||
_long_opt_fmt = ... # type: _Text
|
||||
_short_opt_fmt = ... # type: _Text
|
||||
current_indent = ... # type: int
|
||||
default_tag = ... # type: _Text
|
||||
help_position = ... # type: Any
|
||||
help_width = ... # type: Any
|
||||
indent_increment = ... # type: int
|
||||
level = ... # type: int
|
||||
max_help_position = ... # type: int
|
||||
option_strings = ... # type: Dict[Option, _Text]
|
||||
parser = ... # type: OptionParser
|
||||
short_first = ... # type: Any
|
||||
width = ... # type: int
|
||||
def __init__(self, indent_increment: int, max_help_position: int, width: Optional[int], short_first: int) -> None: ...
|
||||
def _format__Text(self, _Text: _Text) -> _Text: ...
|
||||
def dedent(self) -> None: ...
|
||||
def expand_default(self, option: Option) -> _Text: ...
|
||||
def format_description(self, description: _Text) -> _Text: ...
|
||||
def format_epilog(self, epilog) -> _Text: ...
|
||||
def format_heading(self, heading: Any) -> _Text: ...
|
||||
def format_option(self, option: OptionParser) -> _Text: ...
|
||||
def format_option_strings(self, option: OptionParser) -> Any: ...
|
||||
def format_usage(self, usage: Any) -> _Text: ...
|
||||
def indent(self) -> None: ...
|
||||
def set_long_opt_delimiter(self, delim: _Text) -> None: ...
|
||||
def set_parser(self, parser: OptionParser) -> None: ...
|
||||
def set_short_opt_delimiter(self, delim: _Text) -> None: ...
|
||||
def store_option_strings(self, parser: OptionParser) -> None: ...
|
||||
|
||||
class IndentedHelpFormatter(HelpFormatter):
|
||||
def __init__(self,
|
||||
indent_increment: int = ...,
|
||||
max_help_position: int = ...,
|
||||
width: Optional[int] = ...,
|
||||
short_first: int = ...) -> None: ...
|
||||
def format_heading(self, heading: _Text) -> _Text: ...
|
||||
def format_usage(self, usage: _Text) -> _Text: ...
|
||||
|
||||
class TitledHelpFormatter(HelpFormatter):
|
||||
def __init__(self,
|
||||
indent_increment: int = ...,
|
||||
max_help_position: int = ...,
|
||||
width: Optional[int] = ...,
|
||||
short_first: int = ...) -> None: ...
|
||||
def format_heading(self, heading: _Text) -> _Text: ...
|
||||
def format_usage(self, usage: _Text) -> _Text: ...
|
||||
|
||||
class Option:
|
||||
ACTIONS = ... # type: Tuple[_Text, ...]
|
||||
ALWAYS_TYPED_ACTIONS = ... # type: Tuple[_Text, ...]
|
||||
ATTRS = ... # type: List[_Text]
|
||||
CHECK_METHODS = ... # type: Optional[List[Callable]]
|
||||
CONST_ACTIONS = ... # type: Tuple[_Text, ...]
|
||||
STORE_ACTIONS = ... # type: Tuple[_Text, ...]
|
||||
TYPED_ACTIONS = ... # type: Tuple[_Text, ...]
|
||||
TYPES = ... # type: Tuple[_Text, ...]
|
||||
TYPE_CHECKER = ... # type: Dict[_Text, Callable]
|
||||
_long_opts = ... # type: List[_Text]
|
||||
_short_opts = ... # type: List[_Text]
|
||||
action = ... # type: _Text
|
||||
dest = ... # type: Any
|
||||
nargs = ... # type: int
|
||||
type = ... # type: Any
|
||||
def __init__(self, *opts, **attrs) -> None: ...
|
||||
def _check_action(self) -> None: ...
|
||||
def _check_callback(self) -> None: ...
|
||||
def _check_choice(self) -> None: ...
|
||||
def _check_const(self) -> None: ...
|
||||
def _check_dest(self) -> None: ...
|
||||
def _check_nargs(self) -> None: ...
|
||||
def _check_opt_strings(self, opts: Optional[_Text]) -> Any: ...
|
||||
def _check_type(self) -> None: ...
|
||||
def _set_attrs(self, attrs: Dict[_Text, Any]) -> None: ...
|
||||
def _set_opt_strings(self, opts: _Text) -> None: ...
|
||||
def check_value(self, opt: Any, value: Any) -> Any: ...
|
||||
def convert_value(self, opt: Any, value: Any) -> Any: ...
|
||||
def get_opt_string(self) -> _Text: ...
|
||||
def process(self, opt: Any, value: Any, values: Any, parser: OptionParser) -> int: ...
|
||||
def take_action(self, action: _Text, dest: _Text, opt: Any, value: Any, values: Any, parser: OptionParser) -> int: ...
|
||||
def takes_value(self) -> bool: ...
|
||||
|
||||
make_option = Option
|
||||
|
||||
class OptionContainer:
|
||||
_long_opt = ... # type: Dict[_Text, Option]
|
||||
_short_opt = ... # type: Dict[_Text, Option]
|
||||
conflict_handler = ... # type: _Text
|
||||
defaults = ... # type: Dict[_Text, Any]
|
||||
description = ... # type: Any
|
||||
option_class = ... # type: Any
|
||||
def __init__(self, option_class: Option, conflict_handler: Any, description: Any) -> None: ...
|
||||
def _check_conflict(self, option: Any) -> None: ...
|
||||
def _create_option_mappings(self) -> None: ...
|
||||
def _share_option_mappings(self, parser: OptionParser) -> None: ...
|
||||
def add_option(self, *args, **kwargs) -> Any: ...
|
||||
def add_options(self, option_list: List[Option]) -> None: ...
|
||||
def destroy(self) -> None: ...
|
||||
def format_description(self, formatter: Optional[HelpFormatter]) -> Any: ...
|
||||
def format_help(self, formatter: Optional[HelpFormatter]) -> _Text: ...
|
||||
def format_option_help(self, formatter: Optional[HelpFormatter]) -> _Text: ...
|
||||
def get_description(self) -> Any: ...
|
||||
def get_option(self, opt_str: _Text) -> Optional[Option]: ...
|
||||
def has_option(self, opt_str: _Text) -> bool: ...
|
||||
def remove_option(self, opt_str: _Text) -> None: ...
|
||||
def set_conflict_handler(self, handler: Any) -> None: ...
|
||||
def set_description(self, description: Any) -> None: ...
|
||||
|
||||
class OptionGroup(OptionContainer):
|
||||
option_list = ... # type: List[Option]
|
||||
parser = ... # type: OptionParser
|
||||
title = ... # type: _Text
|
||||
def __init__(self, parser: OptionParser, title: _Text, description: Optional[_Text]) -> None: ...
|
||||
def _create_option_list(self) -> None: ...
|
||||
def set_title(self, title: _Text) -> None: ...
|
||||
|
||||
class OptionParser(OptionContainer):
|
||||
allow_interspersed_args = ... # type: bool
|
||||
epilog = ... # type: Any
|
||||
formatter = ... # type: HelpFormatter
|
||||
largs = ... # type: Optional[List[_Text]]
|
||||
option_groups = ... # type: List[OptionParser]
|
||||
option_list = ... # type: List[Any]
|
||||
process_default_values = ... # type: Any
|
||||
prog = ... # type: Any
|
||||
rargs = ... # type: Optional[List[Any]]
|
||||
standard_option_list = ... # type: List
|
||||
usage = ... # type: Optional[_Text]
|
||||
values = ... # type: Any
|
||||
version = ... # type: _Text
|
||||
def __init__(self, usage: Optional[_Text] = ...,
|
||||
option_list: List[Option] = ...,
|
||||
option_class: Option = ...,
|
||||
version: Optional[_Text] = ...,
|
||||
conflict_handler: _Text = ...,
|
||||
description: Optional[_Text] = ...,
|
||||
formatter: Optional[HelpFormatter] = ...,
|
||||
add_help_option: bool = ...,
|
||||
prog: Optional[_Text] = ...,
|
||||
epilog: Optional[_Text] = ...) -> None: ...
|
||||
def _add_help_option(self) -> None: ...
|
||||
def _add_version_option(self) -> None: ...
|
||||
def _create_option_list(self) -> None: ...
|
||||
def _get_all_options(self) -> List[Any]: ...
|
||||
def _get_args(self, args: Iterable) -> List[Any]: ...
|
||||
def _init_parsing_state(self) -> None: ...
|
||||
def _match_long_opt(self, opt: _Text) -> _Text: ...
|
||||
def _populate_option_list(self, option_list: List[Option], add_help: bool = ...) -> None: ...
|
||||
def _process_args(self, largs: List[_Text], rargs: List, values: Values) -> None: ...
|
||||
def _process_long_opt(self, rargs: List, values: Any) -> None: ...
|
||||
def _process_short_opts(self, rargs: List, values: Any) -> None: ...
|
||||
def add_option_group(self, *args, **kwargs) -> OptionParser: ...
|
||||
def check_values(self, values: Any, args) -> Tuple[Any, ...]: ...
|
||||
def disable_interspersed_args(self) -> None: ...
|
||||
def enable_interspersed_args(self) -> None: ...
|
||||
def error(self, msg: _Text) -> None: ...
|
||||
def exit(self, status: int = ..., msg: Optional[str] = ...) -> None: ...
|
||||
def expand_prog_name(self, s: Optional[_Text]) -> Any: ...
|
||||
def format_epilog(self, formatter: HelpFormatter) -> Any: ...
|
||||
def format_help(self, formatter: Optional[HelpFormatter] = ...) -> _Text: ...
|
||||
def format_option_help(self, formatter: Optional[HelpFormatter] = ...) -> _Text: ...
|
||||
def get_default_values(self) -> Values: ...
|
||||
def get_option_group(self, opt_str: _Text) -> Any: ...
|
||||
def get_prog_name(self) -> _Text: ...
|
||||
def get_usage(self) -> _Text: ...
|
||||
def get_version(self) -> _Text: ...
|
||||
def parse_args(self, args: Optional[List[_Text]] = ..., values: Optional[Values] = ...) -> Tuple[Any, ...]: ...
|
||||
def print_usage(self, file: Optional[IO[str]] = ...) -> None: ...
|
||||
def print_help(self, file: Optional[IO[str]] = ...) -> None: ...
|
||||
def print_version(self, file: Optional[IO[str]] = ...) -> None: ...
|
||||
def set_default(self, dest: Any, value: Any) -> None: ...
|
||||
def set_defaults(self, **kwargs) -> None: ...
|
||||
def set_process_default_values(self, process: Any) -> None: ...
|
||||
def set_usage(self, usage: _Text) -> None: ...
|
||||
|
||||
|
||||
class Values:
|
||||
def __init__(self, defaults: Optional[Mapping[str, Any]] = ...) -> None: ...
|
||||
def _update(self, dict: Dict[_Text, Any], mode: Any) -> None: ...
|
||||
def _update_careful(self, dict: Dict[_Text, Any]) -> None: ...
|
||||
def _update_loose(self, dict: Dict[_Text, Any]) -> None: ...
|
||||
def ensure_value(self, attr: Any, value: Any) -> Any: ...
|
||||
def read_file(self, filename: _Text, mode: _Text) -> None: ...
|
||||
def read_module(self, modname: _Text, mode: _Text) -> None: ...
|
||||
Reference in New Issue
Block a user