Skip to content

Commit 1cef701

Browse files
Add logging verbosity shortcuts to LoggingConfig
Amp-Thread-ID: https://ampcode.com/threads/T-019e665f-205b-755b-ab28-497399c0e46d Co-authored-by: Amp <amp@ampcode.com>
1 parent 6dcf08e commit 1cef701

3 files changed

Lines changed: 69 additions & 41 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,11 @@ When the root logger is configured, noisy `httpx`/`httpcore` records are suppres
112112
Run-end events include HTTP attempt/byte/status/retry counters. Set
113113
`LoggingSettings.resource_sample_interval_seconds` to emit DEBUG
114114
`resource_sample` events and include process resource totals on run end. Set
115-
`SRC_LOG_LEVEL=INFO` for a run to omit DEBUG events from the log file. Use
116-
`resolve_log_level_name()` to map project-specific `--verbose/-v`, `--quiet/-q`,
117-
and `--silent/-s` flags to level names while leaving explicit level strings
118-
unchanged, or `logging_settings_from_config()` to build `LoggingSettings` from
119-
those conventions.
115+
`SRC_LOG_LEVEL=INFO` for a run to omit DEBUG events from the log file.
116+
`LoggingConfig` includes `--verbose/-v`, `--quiet/-q`, and `--silent/-s`
117+
shortcuts (also available as `SRC_LOG_VERBOSE`, `SRC_LOG_QUIET`, and
118+
`SRC_LOG_SILENT`). Use `logging_settings_from_config()` to build
119+
`LoggingSettings` from those conventions.
120120

121121
```python
122122
import src_py_lib as src

‎src/src_py_lib/utils/logging.py‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,23 @@
2323
from concurrent.futures import Executor, Future
2424
from dataclasses import dataclass, field
2525
from pathlib import Path
26-
from typing import Any, Final, cast
26+
from typing import Any, Final, Self, cast
2727

2828
if sys.platform != "win32":
2929
import resource
3030

31+
from pydantic import model_validator
32+
3133
from src_py_lib.utils.config import Config, config_field, config_snapshot
3234

3335
RUN: Final[str] = secrets.token_hex(4)
3436
DEFAULT_LOGS_DIR: Final[Path] = Path("logs")
3537
DEFAULT_RETAIN_FILES: Final[int] = 50
3638
DEFAULT_LOG_FILE_LEVEL: Final[str] = "debug"
3739
SRC_LOG_LEVEL: Final[str] = "SRC_LOG_LEVEL"
40+
SRC_LOG_VERBOSE: Final[str] = "SRC_LOG_VERBOSE"
41+
SRC_LOG_QUIET: Final[str] = "SRC_LOG_QUIET"
42+
SRC_LOG_SILENT: Final[str] = "SRC_LOG_SILENT"
3843
TRACE_SPAN_BYTES: Final[int] = 4
3944
MEBIBYTE: Final[int] = 1024 * 1024
4045
SECRET_FIELD_FRAGMENTS: Final[tuple[str, ...]] = (
@@ -93,6 +98,37 @@ class LoggingConfig(Config):
9398
metavar="LEVEL",
9499
help="Log level (default: INFO)",
95100
)
101+
verbose: bool = config_field(
102+
default=False,
103+
env_var=SRC_LOG_VERBOSE,
104+
cli_flag="--verbose",
105+
cli_aliases=("-v",),
106+
cli_action="store_true",
107+
help="Shortcut for --src-log-level DEBUG",
108+
)
109+
quiet: bool = config_field(
110+
default=False,
111+
env_var=SRC_LOG_QUIET,
112+
cli_flag="--quiet",
113+
cli_aliases=("-q",),
114+
cli_action="store_true",
115+
help="Shortcut for --src-log-level WARNING",
116+
)
117+
silent: bool = config_field(
118+
default=False,
119+
env_var=SRC_LOG_SILENT,
120+
cli_flag="--silent",
121+
cli_aliases=("-s",),
122+
cli_action="store_true",
123+
help="Shortcut for --src-log-level ERROR",
124+
)
125+
126+
@model_validator(mode="after")
127+
def validate_log_level_shortcuts(self) -> Self:
128+
"""Require at most one shortcut for the terminal/log-file level."""
129+
if sum((self.verbose, self.quiet, self.silent)) > 1:
130+
raise ValueError("choose only one of --verbose/-v, --quiet/-q, or --silent/-s")
131+
return self
96132

97133

98134
def resolve_log_level_name(

‎tests/test_logging_http_clients.py‎

Lines changed: 27 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -273,32 +273,6 @@ class LoggingExampleConfig(LoggingConfig):
273273
"""Config model composed from shared logging fields."""
274274

275275

276-
class LoggingShortcutConfig(LoggingConfig):
277-
"""Logging config model with common CLI verbosity shortcuts."""
278-
279-
verbose: bool = config_field(
280-
default=False,
281-
env_var="LOGGING_SHORTCUT_VERBOSE",
282-
cli_flag="--verbose",
283-
cli_aliases=("-v",),
284-
cli_action="store_true",
285-
)
286-
quiet: bool = config_field(
287-
default=False,
288-
env_var="LOGGING_SHORTCUT_QUIET",
289-
cli_flag="--quiet",
290-
cli_aliases=("-q",),
291-
cli_action="store_true",
292-
)
293-
silent: bool = config_field(
294-
default=False,
295-
env_var="LOGGING_SHORTCUT_SILENT",
296-
cli_flag="--silent",
297-
cli_aliases=("-s",),
298-
cli_action="store_true",
299-
)
300-
301-
302276
class ConfigTest(unittest.TestCase):
303277
def test_load_config_env_file_uses_dotenv_parser(self) -> None:
304278
with tempfile.TemporaryDirectory() as directory:
@@ -518,7 +492,7 @@ def test_config_field_supports_numeric_bounds(self) -> None:
518492
def test_logging_config_mixin_adds_log_level_from_cli_and_env(self) -> None:
519493
parser = argparse.ArgumentParser()
520494
add_config_arguments(parser, LoggingExampleConfig)
521-
args = parser.parse_args(["--src-log-level", "INFO"])
495+
args = parser.parse_args(["--src-log-level", "INFO", "-v"])
522496

523497
cli_config = load_config_from_args(
524498
LoggingExampleConfig,
@@ -534,26 +508,44 @@ def test_logging_config_mixin_adds_log_level_from_cli_and_env(self) -> None:
534508
)
535509

536510
self.assertEqual(cli_config.src_log_level, "INFO")
511+
self.assertTrue(cli_config.verbose)
537512
self.assertEqual(env_config.src_log_level, "ERROR")
538513

514+
def test_logging_config_rejects_multiple_log_level_shortcuts(self) -> None:
515+
with self.assertRaisesRegex(ConfigError, "choose only one of --verbose"):
516+
load_config(
517+
LoggingExampleConfig,
518+
env_file=None,
519+
env={"SRC_LOG_VERBOSE": "true", "SRC_LOG_QUIET": "true"},
520+
resolve_op_refs=False,
521+
)
522+
539523
def test_resolve_log_level_name_maps_cli_shortcuts(self) -> None:
540524
self.assertEqual(resolve_log_level_name(verbose=True), "DEBUG")
541525
self.assertEqual(resolve_log_level_name(quiet=True), "WARNING")
542526
self.assertEqual(resolve_log_level_name(silent=True), "ERROR")
543527
self.assertEqual(resolve_log_level_name(log_level="trace"), "trace")
544-
self.assertIsNone(resolve_log_level_name())
528+
self.assertIsNone(resolve_log_level_name(object()))
545529

546-
config = LoggingShortcutConfig(src_log_level="INFO")
530+
config = LoggingExampleConfig(src_log_level="INFO")
547531
self.assertEqual(resolve_log_level_name(config), "INFO")
548-
verbose_config = LoggingShortcutConfig(src_log_level="INFO", verbose=True)
532+
verbose_config = LoggingExampleConfig(src_log_level="INFO", verbose=True)
549533
self.assertEqual(resolve_log_level_name(verbose_config), "DEBUG")
550534
quiet_config = config_parse_args(
551-
LoggingShortcutConfig,
535+
LoggingExampleConfig,
552536
argv=["-q"],
553537
env={},
554538
resolve_op_refs=False,
555539
)
556540
self.assertEqual(resolve_log_level_name(quiet_config), "WARNING")
541+
env_config = load_config(
542+
LoggingExampleConfig,
543+
env_file=None,
544+
env={"SRC_LOG_SILENT": "true"},
545+
resolve_op_refs=False,
546+
)
547+
self.assertTrue(env_config.silent)
548+
self.assertEqual(resolve_log_level_name(env_config), "ERROR")
557549

558550
def test_logging_settings_from_config_maps_common_cli_levels(self) -> None:
559551
default_settings = logging_settings_from_config(
@@ -563,12 +555,12 @@ def test_logging_settings_from_config_maps_common_cli_levels(self) -> None:
563555
self.assertEqual(default_settings.log_file_level, "debug")
564556
self.assertEqual(default_settings.resource_sample_interval_seconds, 2.5)
565557

566-
quiet_config = LoggingShortcutConfig(src_log_level="INFO", quiet=True)
558+
quiet_config = LoggingExampleConfig(src_log_level="INFO", quiet=True)
567559
quiet_settings = logging_settings_from_config(quiet_config)
568560
self.assertEqual(quiet_settings.terminal_level, "WARNING")
569561
self.assertEqual(quiet_settings.log_file_level, "WARNING")
570562

571-
log_level_config = LoggingShortcutConfig(src_log_level="ERROR")
563+
log_level_config = LoggingExampleConfig(src_log_level="ERROR")
572564
log_level_settings = logging_settings_from_config(log_level_config)
573565
self.assertEqual(log_level_settings.terminal_level, "ERROR")
574566
self.assertEqual(log_level_settings.log_file_level, "ERROR")
@@ -792,7 +784,7 @@ def test_log_and_level_helpers_use_string_levels(self) -> None:
792784
)
793785
)
794786
try:
795-
log("bogus", "fallback_debug", logger_name=logger_name)
787+
log("bogus", "fallback_info", logger_name=logger_name)
796788
warning("warning_event", logger_name=logger_name)
797789
error("error_event", logger_name=logger_name)
798790
critical("critical_event", logger_name=logger_name)
@@ -804,7 +796,7 @@ def test_log_and_level_helpers_use_string_levels(self) -> None:
804796

805797
rows = [json.loads(line) for line in log_file.read_text().splitlines()]
806798
levels = {row["event"]: row["level"] for row in rows}
807-
self.assertEqual(levels["fallback_debug"], "DEBUG")
799+
self.assertEqual(levels["fallback_info"], "INFO")
808800
self.assertEqual(levels["warning_event"], "WARNING")
809801
self.assertEqual(levels["error_event"], "ERROR")
810802
self.assertEqual(levels["critical_event"], "CRITICAL")

0 commit comments

Comments
 (0)