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.py
Go to the documentation of this file.
1# This file is part of dax_apdb
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21
22from __future__ import annotations
23
24__all__ = ["LoggingCli"]
25
26import argparse
27import logging
28
29_log_format = "%(asctime)s %(levelname)s %(name)s - %(message)s"
30
31
33 """Class that handles CLI logging options and logging configuration.
34
35 Parameters
36 ----------
37 parser : `argparse.ArgumentParser`
38 Parser for which to define logging options.
39 """
40
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
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
None process_args(self, argparse.Namespace args)
__init__(self, argparse.ArgumentParser parser)