Skip to content

Commit 6e724d3

Browse files
committed
Rename shortcut to alias
1 parent b6470e8 commit 6e724d3

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

src/src_py_lib/utils/logging.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -104,28 +104,28 @@ class LoggingConfig(Config):
104104
cli_flag="--verbose",
105105
cli_aliases=("-v",),
106106
cli_action="store_true",
107-
help="Shortcut for --src-log-level DEBUG",
107+
help="Alias for --src-log-level DEBUG",
108108
)
109109
quiet: bool = config_field(
110110
default=False,
111111
env_var=SRC_LOG_QUIET,
112112
cli_flag="--quiet",
113113
cli_aliases=("-q",),
114114
cli_action="store_true",
115-
help="Shortcut for --src-log-level WARNING",
115+
help="Alias for --src-log-level WARNING",
116116
)
117117
silent: bool = config_field(
118118
default=False,
119119
env_var=SRC_LOG_SILENT,
120120
cli_flag="--silent",
121121
cli_aliases=("-s",),
122122
cli_action="store_true",
123-
help="Shortcut for --src-log-level ERROR",
123+
help="Alias for --src-log-level ERROR",
124124
)
125125

126126
@model_validator(mode="after")
127-
def validate_log_level_shortcuts(self) -> Self:
128-
"""Require at most one shortcut for the terminal/log-file level."""
127+
def validate_log_level_alias(self) -> Self:
128+
"""Require at most one alias for the terminal/log-file level."""
129129
if sum((self.verbose, self.quiet, self.silent)) > 1:
130130
raise ValueError("choose only one of --verbose/-v, --quiet/-q, or --silent/-s")
131131
return self
@@ -139,9 +139,9 @@ def resolve_log_level_name(
139139
quiet: bool | None = None,
140140
silent: bool | None = None,
141141
) -> str | None:
142-
"""Resolve common CLI log-level shortcuts to a level name.
142+
"""Resolve common CLI log-level alias to a level name.
143143
144-
Shortcut flags intentionally only map to strings. Explicit log-level
144+
Alias flags intentionally only map to strings. Explicit log-level
145145
values are returned unchanged so `configure_logging()` owns parsing
146146
and fallback behavior.
147147
"""
@@ -172,7 +172,7 @@ def logging_settings_from_config(
172172
suppress_http_dependency_logs: bool = True,
173173
resource_sample_interval_seconds: float | None = None,
174174
) -> LoggingSettings:
175-
"""Return `LoggingSettings` using common CLI log-level shortcuts."""
175+
"""Return `LoggingSettings` using common CLI log-level alias."""
176176
explicit_level = resolve_log_level_name(config)
177177
return LoggingSettings(
178178
logger_name=logger_name,

tests/test_logging_http_clients.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,7 @@ def test_logging_config_mixin_adds_log_level_from_cli_and_env(self) -> None:
547547
self.assertTrue(cli_config.verbose)
548548
self.assertEqual(env_config.src_log_level, "ERROR")
549549

550-
def test_logging_config_rejects_multiple_log_level_shortcuts(self) -> None:
550+
def test_logging_config_rejects_multiple_log_level_alias(self) -> None:
551551
with self.assertRaisesRegex(ConfigError, "choose only one of --verbose"):
552552
load_config(
553553
LoggingExampleConfig,
@@ -556,7 +556,7 @@ def test_logging_config_rejects_multiple_log_level_shortcuts(self) -> None:
556556
resolve_op_refs=False,
557557
)
558558

559-
def test_resolve_log_level_name_maps_cli_shortcuts(self) -> None:
559+
def test_resolve_log_level_name_maps_cli_alias(self) -> None:
560560
self.assertEqual(resolve_log_level_name(verbose=True), "DEBUG")
561561
self.assertEqual(resolve_log_level_name(quiet=True), "WARNING")
562562
self.assertEqual(resolve_log_level_name(silent=True), "ERROR")

0 commit comments

Comments
 (0)