Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+cc8870d3f5,g07dc498a13+5aa0b8792f,g0fba68d861+80045be308,g1409bbee79+5aa0b8792f,g1a7e361dbc+5aa0b8792f,g1fd858c14a+f64bc332a9,g208c678f98+1ae86710ed,g35bb328faa+fcb1d3bbc8,g4d2262a081+47ad8a29a8,g4d39ba7253+9633a327c1,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+9633a327c1,g668ecb457e+25d63fd678,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+8b64ca622a,g89139ef638+5aa0b8792f,g89e1512fd8+04325574d3,g8d6b6b353c+9633a327c1,g9125e01d80+fcb1d3bbc8,g989de1cb63+5aa0b8792f,g9f33ca652e+b196626af7,ga9baa6287d+9633a327c1,gaaedd4e678+5aa0b8792f,gabe3b4be73+1e0a283bba,gb1101e3267+71e32094df,gb58c049af0+f03b321e39,gb90eeb9370+2807b1ad02,gcf25f946ba+8b64ca622a,gd315a588df+a39986a76f,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+4e42d81ab7,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,gfe73954cf8+a1301e4c20,w.2025.11
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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] = {"cassandra.cluster": logging.WARNING}
58 for level_str in args.log_level:
59 for spec in level_str.split(","):
60 logger_name, sep, level_name = spec.rpartition("=")
61 level = logging.getLevelNamesMapping().get(level_name.upper())
62 if level is None:
63 self._parser.error(f"Unknown logging level {level_name!r} in {level_str!r}")
64 if logger_name:
65 logger_levels[logger_name] = level
66 else:
67 global_level = level
68
69 logging.basicConfig(level=global_level, format=_log_format)
70 for logger_name, level in logger_levels.items():
71 logging.getLogger(logger_name).setLevel(level)
72
73 # We want to remove `log_level` so that namespace can be converted to
74 # a dict and passed as kwargs to scripts.
75 del args.log_level
None process_args(self, argparse.Namespace args)
__init__(self, argparse.ArgumentParser parser)