LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
Loading...
Searching...
No Matches
logging_cli.LoggingCli Class Reference

Public Member Functions

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

Protected Attributes

 _parser = 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.

41 def __init__(self, parser: argparse.ArgumentParser):
42 self._parser = parser
43 parser.add_argument(
44 "-l",
45 "--log-level",
46 dest="log_level",
47 action="append",
48 metavar="LEVEL|LOGGER=LEVEL[,...]",
49 help="Global or per-logger logging level, comma-separated and can be specified multiple times",
50 default=[],
51 )
52

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.

53 def process_args(self, args: argparse.Namespace) -> None:
54 """Configure Python logging based on command line options."""
55 global_level = logging.INFO
56 # Suppress chatty cassandra.cluster logger by default.
57 logger_levels: dict[str, int] = {
58 "cassandra.cluster": logging.WARNING,
59 "botocore": logging.WARNING,
60 }
61 for level_str in args.log_level:
62 for spec in level_str.split(","):
63 logger_name, sep, level_name = spec.rpartition("=")
64 level = logging.getLevelNamesMapping().get(level_name.upper())
65 if level is None:
66 self._parser.error(f"Unknown logging level {level_name!r} in {level_str!r}")
67 if logger_name:
68 logger_levels[logger_name] = level
69 else:
70 global_level = level
71
72 logging.basicConfig(level=global_level, format=_log_format)
73 for logger_name, level in logger_levels.items():
74 logging.getLogger(logger_name).setLevel(level)
75
76 # We want to remove `log_level` so that namespace can be converted to
77 # a dict and passed as kwargs to scripts.
78 del args.log_level

Member Data Documentation

◆ _parser

logging_cli.LoggingCli._parser = parser
protected

Definition at line 42 of file logging_cli.py.


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