logging_cli.LoggingCli Class Reference

Public Member Functions
	__init__ (self, argparse.ArgumentParser parser)
None	process_args (self, argparse.Namespace args)

Protected Attributes
	_parser

Detailed Description

Class that handles CLI logging options and logging configuration.

Parameters
----------
parser : `argparse.ArgumentParser`
    Parser for which to define logging options.

Definition at line 32 of file logging_cli.py.

Constructor & Destructor Documentation

__init__()

logging_cli.LoggingCli.__init__	(		self,
		argparse.ArgumentParser	parser )

Definition at line 41 of file logging_cli.py.

    def __init__(self, parser: argparse.ArgumentParser):
        self._parser = parser
        parser.add_argument(
            "-l",
            "--log-level",
            dest="log_level",
            action="append",
            metavar="LEVEL|LOGGER=LEVEL[,...]",
            help="Global or per-logger logging level, comma-separated and can be specified multiple times",
            default=[],
        )
 

Member Function Documentation

process_args()

None logging_cli.LoggingCli.process_args	(		self,
		argparse.Namespace	args )

Configure Python logging based on command line options.

Definition at line 53 of file logging_cli.py.

    def process_args(self, args: argparse.Namespace) -> None:
        """Configure Python logging based on command line options."""
        global_level = logging.INFO
        logger_levels: dict[str, int] = {}
        for level_str in args.log_level:
            for spec in level_str.split(","):
                logger_name, sep, level_name = spec.rpartition("=")
                level = logging.getLevelNamesMapping().get(level_name.upper())
                if level is None:
                    self._parser.error(f"Unknown logging level {level_name!r} in {level_str!r}")
                if logger_name:
                    logger_levels[logger_name] = level
                else:
                    global_level = level
 
        logging.basicConfig(level=global_level, format=_log_format)
        for logger_name, level in logger_levels.items():
            logging.getLogger(logger_name).setLevel(level)
 
        # We want to remove `log_level` so that namespace can be converted to
        # a dict and passed as kwargs to scripts.
        del args.log_level

Member Data Documentation

_parser

logging_cli.LoggingCli._parser

protected

Definition at line 42 of file logging_cli.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/dax_apdb/g88963caddf+0cb8e002cc/python/lsst/dax/apdb/cli/logging_cli.py