Add new gflags names. (#2489)

As a described in https://github.com/google/python-gflags/blob/master/absl_migration/migration_guidelines.md, gflags did a mass rename to PEP 8-style names.
2025-12-20 10:51:15 +08:00 · 2018-10-01 20:18:51 -07:00
parent 4122a70648
commit b2a9f2e383
1 changed files with 65 additions and 42 deletions
--- a/third_party/2/gflags.pyi
+++ b/third_party/2/gflags.pyi
@@ -1,7 +1,8 @@
 from typing import Any, Callable, Dict, Iterable, IO, List, Optional, Union
 from types import ModuleType

-class FlagsError(Exception): ...
+class Error(Exception): ...
+FlagsError = Error

 class DuplicateFlag(FlagsError): ...

@@ -12,55 +13,76 @@ class DuplicateFlagCannotPropagateNoneToSwig(DuplicateFlag): ...
 class DuplicateFlagError(DuplicateFlag):
    def __init__(self, flagname: str, flag_values: FlagValues, other_flag_values: FlagValues = ...) -> None: ...

-class IllegalFlagValue(FlagsError): ...
+class IllegalFlagValueError(FlagsError): ...
+IllegalFlagValue = IllegalFlagValueError

 class UnrecognizedFlag(FlagsError): ...

 class UnrecognizedFlagError(UnrecognizedFlag):
    def __init__(self, flagname: str, flagvalue: str = ...) -> None: ...

-def GetHelpWidth() -> int: ...
+def get_help_width() -> int: ...
+GetHelpWidth = get_help_width
 def CutCommonSpacePrefix(text) -> str: ...
-def TextWrap(text: str, length: int = ..., indent: str = ..., firstline_indent: str = ..., tabs: str = ...) -> str: ...
-def DocToHelp(doc: str) -> str: ...
+def text_wrap(text: str, length: int = ..., indent: str = ..., firstline_indent: str = ..., tabs: str = ...) -> str: ...
+TextWrap = text_wrap
+def doc_to_help(doc: str) -> str: ...
+DocToHelp = doc_to_help

 class FlagValues:
    def __init__(self) -> None: ...
    def UseGnuGetOpt(self, use_gnu_getopt: bool = ...) -> None: ...
-    def IsGnuGetOpt(self) -> bool: ...
+    def is_gnu_getopt(self) -> bool: ...
+    IsGnuGetOpt = is_gnu_getopt
 # TODO dict type
    def FlagDict(self) -> dict: ...
-    def FlagsByModuleDict(self) -> Dict[str, List[Flag]]: ...
-    def FlagsByModuleIdDict(self) -> Dict[int, List[Flag]]: ...
-    def KeyFlagsByModuleDict(self) -> Dict[str, List[Flag]]: ...
-    def FindModuleDefiningFlag(self, flagname: str, default: str = ...) -> str: ...
-    def FindModuleIdDefiningFlag(self, flagname: str, default: int = ...) -> int: ...
-    def AppendFlagValues(self, flag_values: FlagValues) -> None: ...
-    def RemoveFlagValues(self, flag_values: FlagValues) -> None: ...
+    def flags_by_module_dict(self) -> Dict[str, List[Flag]]: ...
+    FlagsByModuleDict = flags_by_module_dict
+    def flags_by_module_id_dict(self) -> Dict[int, List[Flag]]: ...
+    FlagsByModuleIdDict = flags_by_module_id_dict
+    def key_flags_by_module_dict(self) -> Dict[str, List[Flag]]: ...
+    KeyFlagsByModuleDict = key_flags_by_module_dict
+    def find_module_defining_flag(self, flagname: str, default: str = ...) -> str: ...
+    FindModuleDefiningFlag = find_module_defining_flag
+    def find_module_id_defining_flag(self, flagname: str, default: int = ...) -> int: ...
+    FindModuleIdDefiningFlag = find_module_id_defining_flag
+    def append_flag_values(self, flag_values: FlagValues) -> None: ...
+    AppendFlagValues = append_flag_values
+    def remove_flag_values(self, flag_values: FlagValues) -> None: ...
+    RemoveFlagValues = remove_flag_values
    def __setitem__(self, name: str, flag: Flag) -> None: ...
    def __getitem__(self, name: str) -> Flag: ...
    def __getattr__(self, name: str) -> Any: ...
    def __setattr__(self, name: str, value: Any): ...
    def __delattr__(self, flag_name: str) -> None: ...
-    def SetDefault(self, name: str, value: Any) -> None: ...
+    def set_default(self, name: str, value: Any) -> None: ...
+    SetDefault = set_default
    def __contains__(self, name: str) -> bool: ...
    has_key = __contains__
    def __iter__(self) -> Iterable[str]: ...
    def __call__(self, argv: List[str]) -> List[str]: ...
-    def Reset(self) -> None: ...
+    def reset(self) -> None: ...
+    Reset = reset
    def RegisteredFlags(self) -> List[str]: ...
-    def FlagValuesDict(self) -> Dict[str, Any]: ...
+    def flag_values_dict(self) -> Dict[str, Any]: ...
+    FlagValuesDict = flag_values_dict
    def __str__(self) -> str: ...
    def GetHelp(self, prefix: str = ...) -> str: ...
-    def ModuleHelp(self, module: Union[ModuleType, str]) -> str: ...
-    def MainModuleHelp(self) -> str: ...
+    def module_help(self, module: Union[ModuleType, str]) -> str: ...
+    ModuleHelp = module_help
+    def main_module_help(self) -> str: ...
+    MainModuleHelp = main_module_help
    def get(self, name: str, default: Any) -> Any: ...
    def ShortestUniquePrefixes(self, fl: Dict[str, Flag]) -> Dict[str, str]: ...
    def ExtractFilename(self, flagfile_str: str) -> str: ...
-    def ReadFlagsFromFiles(self, argv: List[str], force_gnu: bool = ...) -> List[str]: ...
-    def FlagsIntoString(self) -> str: ...
-    def AppendFlagsIntoFile(self, filename: str) -> None: ...
-    def WriteHelpInXMLFormat(self, outfile: IO[str] = ...) -> None: ...
+    def read_flags_from_files(self, argv: List[str], force_gnu: bool = ...) -> List[str]: ...
+    ReadFlagsFromFiles = read_flags_from_files
+    def flags_into_string(self) -> str: ...
+    FlagsIntoString = flags_into_string
+    def append_flags_into_file(self, filename: str) -> None: ...
+    AppendFlagsIntoFile = append_flags_into_file
+    def write_help_in_xml_format(self, outfile: IO[str] = ...) -> None: ...
+    WriteHelpInXMLFormat = write_help_in_xml_format
 # TODO validator: gflags_validators.Validator
    def AddValidator(self, validator: Any) -> None: ...

@@ -92,8 +114,10 @@ class Flag:
 class ArgumentParser(object):
    syntactic_help = ...  # type: str
 # TODO what is this
-    def Parse(self, argument: Any) -> Any: ...
-    def Type(self) -> str: ...
+    def parse(self, argument: Any) -> Any: ...
+    Parser = parse
+    def flag_type(self) -> str: ...
+    Type = flag_type
    def WriteCustomInfoInXMLFormat(self, outfile: IO[str], indent: str) -> None: ...

 class ArgumentSerializer:
@@ -103,23 +127,26 @@ class ListSerializer(ArgumentSerializer):
    def __init__(self, list_sep: str) -> None: ...
    def Serialize(self, value: List[Any]) -> str: ...

-def RegisterValidator(flag_name: str,
-                      checker: Callable[[Any], bool],
-                      message: str = ...,
-                      flag_values: FlagValues = ...) -> None: ...
-def MarkFlagAsRequired(flag_name: str, flag_values: FlagValues = ...) -> None: ...
+def register_validator(flag_name: str,
+                       checker: Callable[[Any], bool],
+                       message: str = ...,
+                       flag_values: FlagValues = ...) -> None: ...
+RegisterValidator = register_validator
+def mark_flag_as_required(flag_name: str, flag_values: FlagValues = ...) -> None: ...
+MarkFlagAsRequired = mark_flag_as_required

 def DEFINE(parser: ArgumentParser, name: str, default: Any, help: str,
           flag_values: FlagValues = ..., serializer: ArgumentSerializer = ..., **args: Any) -> None: ...
 def DEFINE_flag(flag: Flag, flag_values: FlagValues = ...) -> None: ...
-def DECLARE_key_flag(flag_name: str, flag_values: FlagValues = ...) -> None: ...
-def ADOPT_module_key_flags(module: ModuleType, flag_values: FlagValues = ...) -> None: ...
+def declare_key_flag(flag_name: str, flag_values: FlagValues = ...) -> None: ...
+DECLARE_key_flag = declare_key_flag
+def adopt_module_key_flags(module: ModuleType, flag_values: FlagValues = ...) -> None: ...
+ADOPT_module_key_flags = adopt_module_key_flags
 def DEFINE_string(name: str, default: Optional[str], help: str, flag_values: FlagValues = ..., **args: Any): ...

 class BooleanParser(ArgumentParser):
    def Convert(self, argument: Any) -> bool: ...
    def Parse(self, argument: Any) -> bool: ...
-    def Type(self) -> str: ...

 class BooleanFlag(Flag):
    def __init__(self, name: str, default: Optional[bool], help: str, short_name=..., **args: Any) -> None: ...
@@ -152,7 +179,6 @@ class FloatParser(NumericParser):
    syntactic_help = ...  # type: str
    def __init__(self, lower_bound: float = ..., upper_bound: float = ...) -> None: ...
    def Convert(self, argument: Any) -> float: ...
-    def Type(self) -> str: ...

 def DEFINE_float(name: str, default: Optional[float], help: str, lower_bound: float = ...,
                 upper_bound: float = ..., flag_values: FlagValues = ..., **args: Any) -> None: ...
@@ -163,7 +189,6 @@ class IntegerParser(NumericParser):
    syntactic_help = ...  # type: str
    def __init__(self, lower_bound: int = ..., upper_bound: int = ...) -> None: ...
    def Convert(self, argument: Any) -> int: ...
-    def Type(self) -> str: ...

 def DEFINE_integer(name: str, default: Optional[int], help: str, lower_bound: int = ...,
                   upper_bound: int = ..., flag_values: FlagValues = ..., **args: Any) -> None: ...
@@ -171,7 +196,6 @@ def DEFINE_integer(name: str, default: Optional[int], help: str, lower_bound: in
 class EnumParser(ArgumentParser):
    def __init__(self, enum_values: List[str]) -> None: ...
    def Parse(self, argument: Any) -> Any: ...
-    def Type(self) -> str: ...

 class EnumFlag(Flag):
    def __init__(self, name: str, default: Optional[str], help: str, enum_values: List[str],
@@ -183,7 +207,6 @@ def DEFINE_enum(name: str, default: Optional[str], enum_values: List[str], help:
 class BaseListParser(ArgumentParser):
    def __init__(self, token: str = ..., name: str = ...) -> None: ...
    def Parse(self, argument: Any) -> list: ...
-    def Type(self) -> str: ...

 class ListParser(BaseListParser):
    def __init__(self) -> None: ...
@@ -200,14 +223,14 @@ class MultiFlag(Flag):
    def __init__(self, *args: Any, **kwargs: Any) -> None: ...
    def Parse(self, arguments: Any) -> None: ...
    def Serialize(self) -> str: ...
-    def Type(self) -> str: ...

-def DEFINE_multistring(name: str, default: Optional[Union[str, List[str]]], help: str,
-                       flag_values: FlagValues = ..., **args: Any) -> None: ...
-
-def DEFINE_multi_int(name: str, default: Optional[Union[int, List[int]]], help: str, lower_bound: int = ...,
-                     upper_bound: int = ..., flag_values: FlagValues = ..., **args: Any) -> None: ...
+def DEFINE_multi_string(name: str, default: Optional[Union[str, List[str]]], help: str,
+                        flag_values: FlagValues = ..., **args: Any) -> None: ...
+DEFINE_multistring = DEFINE_multi_string

+def DEFINE_multi_integer(name: str, default: Optional[Union[int, List[int]]], help: str, lower_bound: int = ...,
+                         upper_bound: int = ..., flag_values: FlagValues = ..., **args: Any) -> None: ...
+DEFINE_multi_int = DEFINE_multi_integer

 def DEFINE_multi_float(name: str, default: Optional[Union[float, List[float]]], help: str,
                       lower_bound: float = ..., upper_bound: float = ...,