sdkagent

abseil-py API reference

110 public APIs from abseil-py (abseil/abseil-py) — 36 classes, 30 functions, 44 methods. Signatures extracted by static analysis of the actual source.

Repository: abseil/abseil-py

KindCount
Classes36
Functions30
Methods44

API list

classabsl.app.ExceptionHandler
Base exception handler from which other may inherit.
methodabsl.app.ExceptionHandler.handle(exc)
Do something with the current exception.
classabsl.app.HelpFlag
Special boolean flag that displays usage and raises SystemExit.
classabsl.app.HelpXMLFlag
Similar to HelpfullFlag, but generates output in XML format.
classabsl.app.HelpshortFlag
--helpshort is an alias for --help.
classabsl.app.OnlyCheckFlagsFlag
Similar to HelpFlag, but only checks flag definitions.
funcabsl.app.define_help_flags()
Registers help flags.
funcabsl.app.install_exception_handler(handler)
Installs an exception handler.
funcabsl.app.run(main, argv=None, flags_parser=parse_flags_with_usage)
Begins executing the program.
funcabsl.command_name.set_kernel_process_name(name:str | bytes) -> None
Changes the Kernel's /proc/self/status process name on Linux.
classabsl.flags._argument_parser.ArgumentParser
Base class used to parse and convert arguments.
methodabsl.flags._argument_parser.ArgumentParser.flag_type() -> str
Returns a string representing the type of the flag.
methodabsl.flags._argument_parser.ArgumentParser.parse(argument:str) -> _T | None
Parses the string argument and returns the native value.
classabsl.flags._argument_parser.BaseListParser
Base class for a parser of lists of strings.
methodabsl.flags._argument_parser.BaseListParser.flag_type() -> str
See base class.
methodabsl.flags._argument_parser.BaseListParser.parse(argument:str) -> list[str]
See base class.
classabsl.flags._argument_parser.BooleanParser
Parser of boolean values.
methodabsl.flags._argument_parser.BooleanParser.flag_type() -> str
See base class.
methodabsl.flags._argument_parser.BooleanParser.parse(argument:str | int) -> bool
See base class.
classabsl.flags._argument_parser.EnumClassListSerializer
A serializer for :class:`MultiEnumClass` flags.
methodabsl.flags._argument_parser.EnumClassListSerializer.serialize(value:_ET | list[_ET]) -> str
See base class.
classabsl.flags._argument_parser.EnumClassParser
Parser of an Enum class member.
methodabsl.flags._argument_parser.EnumClassParser.flag_type() -> str
See base class.
methodabsl.flags._argument_parser.EnumParser.flag_type() -> str
See base class.
classabsl.flags._argument_parser.FloatParser
Parser of floating point values.
methodabsl.flags._argument_parser.FloatParser.convert(argument:int | float | str) -> float
Returns the float value of argument.
methodabsl.flags._argument_parser.FloatParser.flag_type() -> str
See base class.
classabsl.flags._argument_parser.IntegerParser
Parser of an integer value.
methodabsl.flags._argument_parser.IntegerParser.convert(argument:int | str) -> int
Returns the int value of argument.
methodabsl.flags._argument_parser.IntegerParser.flag_type() -> str
See base class.
classabsl.flags._argument_parser.ListParser
Parser for a comma-separated list of strings.
methodabsl.flags._argument_parser.ListParser.parse(argument:str | list[str]) -> list[str]
Parses argument as comma-separated list of strings.
classabsl.flags._argument_parser.NumericParser
Parser of numeric values.
methodabsl.flags._argument_parser.NumericParser.convert(argument:str | _N) -> _N
Returns the correct numeric value of argument.
methodabsl.flags._argument_parser.NumericParser.is_outside_bounds(val:_N) -> bool
Returns whether the value is outside the bounds or not.
methodabsl.flags._argument_parser.NumericParser.parse(argument:str | _N) -> _N
See base class.
classabsl.flags._argument_parser.WhitespaceSeparatedListParser
Parser for a whitespace-separated list of strings.
funcabsl.flags._defines.declare_key_flag(flag_name:str | _flagvalues.FlagHolder, flag_values:_flagvalues.FlagValues=_flagvalues.FLAGS) -> None
Declares one flag as key to the current module.
funcabsl.flags._defines.override_value(flag_holder:_flagvalues.FlagHolder[_T], value:_T) -> None
Overrides the value of the provided flag.
funcabsl.flags._defines.set_default(flag_holder:_flagvalues.FlagHolder[_T], value:_T) -> None
Changes the default value of the provided flag object.
classabsl.flags._exceptions.CantOpenFlagFileError
Raised when flagfile fails to open.
classabsl.flags._exceptions.DuplicateFlagError
Raised if there is a flag naming conflict.
classabsl.flags._exceptions.Error
The base class for all flags errors.
classabsl.flags._exceptions.IllegalFlagValueError
Raised when the flag command line argument is illegal.
classabsl.flags._exceptions.UnrecognizedFlagError
Raised when a flag is unrecognized.
classabsl.flags._exceptions.ValidationError
Raised when flag validator constraint is not satisfied.
classabsl.flags._flag.BooleanFlag
Basic boolean flag.
classabsl.flags._flag.EnumClassFlag
Basic enum flag; its value is an enum class's member.
classabsl.flags._flag.Flag
Information about a command-line flag.
methodabsl.flags._flag.Flag.flag_type() -> str
Returns a str that describes the type of the flag.
methodabsl.flags._flag.Flag.parse(argument:str | _T) -> None
Parses string and sets flag value.
methodabsl.flags._flag.Flag.serialize() -> str
Serializes the flag.
classabsl.flags._flag.MultiEnumClassFlag
A multi_enum_class flag.
classabsl.flags._flag.MultiFlag
A flag that can appear multiple time on the command-line.
methodabsl.flags._flag.MultiFlag.flag_type()
See base class.
classabsl.flags._flagvalues.FlagHolder
Holds a defined flag.
methodabsl.flags._flagvalues.FlagHolder.default() -> _T_co
Returns the default value of the flag.
methodabsl.flags._flagvalues.FlagHolder.serialize() -> str
Returns a serialized representation of the flag.
methodabsl.flags._flagvalues.FlagHolder.value() -> _T_co
Returns the value of the flag.
classabsl.flags._flagvalues.FlagValues
Registry of :class:`~absl.flags.Flag` objects.
methodabsl.flags._flagvalues.FlagValues.append_flag_values(flag_values:'FlagValues') -> None
Appends flags registered in another FlagValues instance.
methodabsl.flags._flagvalues.FlagValues.get_flag_value(name:str, default:Any) -> Any
Returns the value of a flag (if not None) or a default value.
methodabsl.flags._flagvalues.FlagValues.get_flags_for_module(module:str | Any) -> list[Flag]
Returns the list of flags defined by a module.
methodabsl.flags._flagvalues.FlagValues.get_help(prefix:str='', include_special_flags:bool=True) -> str
Returns a help string for all known flags.
methodabsl.flags._flagvalues.FlagValues.get_key_flags_for_module(module:str | Any) -> list[Flag]
Returns the list of key flags for a module.
methodabsl.flags._flagvalues.FlagValues.is_parsed() -> bool
Returns whether flags were parsed.
methodabsl.flags._flagvalues.FlagValues.main_module_help() -> str
Describes the key flags of the main module.
methodabsl.flags._flagvalues.FlagValues.mark_as_parsed() -> None
Explicitly marks flags as parsed.
methodabsl.flags._flagvalues.FlagValues.module_help(module:Any) -> str
Describes the key flags of a module.
methodabsl.flags._flagvalues.FlagValues.register_flag_by_module(module_name:str, flag:Flag) -> None
Records the module that defines a specific flag.
methodabsl.flags._flagvalues.FlagValues.register_flag_by_module_id(module_id:int, flag:Flag) -> None
Records the module that defines a specific flag.
methodabsl.flags._flagvalues.FlagValues.register_key_flag_for_module(module_name:str, flag:Flag) -> None
Specifies that a flag is a key flag for a module.
methodabsl.flags._flagvalues.FlagValues.set_default(name:str, value:Any) -> None
Changes the default value of the named flag object.
methodabsl.flags._flagvalues.FlagValues.set_gnu_getopt(gnu_getopt:bool=True) -> None
Sets whether or not to use GNU style scanning.
methodabsl.flags._flagvalues.FlagValues.validate_all_flags() -> None
Verifies whether all flags pass validation.
methodabsl.flags._flagvalues.FlagValues.write_help_in_xml_format(outfile:TextIO | None=None) -> None
Outputs flag documentation in XML format.
classabsl.flags._flagvalues.ReloadDetector
Helper class for detecting reloads.
funcabsl.flags._flagvalues.resolve_flag_ref(flag_ref:str | FlagHolder, flag_values:FlagValues) -> tuple[str, FlagValues]
Helper to validate and resolve a flag reference argument.
funcabsl.flags._helpers.create_xml_dom_element(doc:minidom.Document, name:str, value:Any) -> minidom.Element
Returns an XML DOM element with name and text value.
funcabsl.flags._helpers.doc_to_help(doc:str) -> str
Takes a __doc__ string and reformats it as help.
funcabsl.flags._helpers.flag_dict_to_args(flag_map:dict[str, Any], multi_flags:set[str] | None=None) -> Iterable[str]
Convert a dict of values into process call parameters.
funcabsl.flags._helpers.get_flag_suggestions(attempt:str, longopt_list:Sequence[str]) -> list[str]
Returns helpful similar matches for an invalid flag.
funcabsl.flags._helpers.trim_docstring(docstring:str) -> str
Removes indentation from triple-quoted strings.
classabsl.flags._validators_classes.MultiFlagsValidator
Validator behind register_multi_flags_validator method.
classabsl.flags._validators_classes.SingleFlagValidator
Validator behind register_validator() method.
classabsl.flags._validators_classes.Validator
Base class for flags validators.
classabsl.flags.argparse_flags.ArgumentParser
Custom ArgumentParser class to support special absl flags.
classabsl.logging.ABSLHandler
Abseil Python logging module's log handler.
classabsl.logging.PythonFormatter
Formatter class used by :class:`~absl.logging.PythonHandler`.
classabsl.logging.PythonHandler
The handler class used by Abseil Python logging implementation.
methodabsl.logging.PythonHandler.close()
Closes the stream to which we are writing.
methodabsl.logging.PythonHandler.emit(record)
Prints a record out to some streams.
methodabsl.logging.PythonHandler.flush()
Flushes all log files.
funcabsl.logging.debug(msg, *args, **kwargs)
Logs a debug message.
funcabsl.logging.error(msg, *args, **kwargs)
Logs an error message.
funcabsl.logging.fatal(msg, *args, **kwargs)
Logs a fatal message.
funcabsl.logging.flush()
Flushes all log files.
funcabsl.logging.get_absl_handler()
Returns the absl handler instance.
funcabsl.logging.get_absl_logger()
Returns the absl logger instance.
funcabsl.logging.get_log_file_name(level=INFO)
Returns the name of the log file.
funcabsl.logging.get_verbosity()
Returns the logging verbosity.
funcabsl.logging.info(msg, *args, **kwargs)
Logs an info message.
funcabsl.logging.level_debug()
Returns True if debug logging is turned on.
funcabsl.logging.level_error()
Returns True if error logging is turned on.
funcabsl.logging.level_info()
Returns True if info logging is turned on.
funcabsl.logging.log(level, msg, *args, **kwargs)
Logs ``msg % args`` at absl logging level ``level``.
funcabsl.logging.set_verbosity(v)
Sets the logging verbosity.
funcabsl.logging.use_absl_handler()
Uses the ABSL logging handler for logging.
funcabsl.logging.warn(msg, *args, **kwargs)
Deprecated, use 'warning' instead.
funcabsl.logging.warning(msg, *args, **kwargs)
Logs a warning message.

About this data

These signatures were extracted from the public source of abseil/abseil-py using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries