Skip to content

Commit ddc8edf

Browse files
committed
logging: minor typing, rename function
`get_log_level_for_setting` reflects better what the function does, and it does not require a (trivial) docstring.
1 parent bdd22fd commit ddc8edf

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/_pytest/logging.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88
from typing import Generator
99
from typing import List
1010
from typing import Mapping
11+
from typing import Optional
1112

1213
import pytest
1314
from _pytest import nodes
1415
from _pytest.compat import nullcontext
1516
from _pytest.config import _strtobool
17+
from _pytest.config import Config
1618
from _pytest.config import create_terminal_writer
1719
from _pytest.pathlib import Path
1820

@@ -448,17 +450,15 @@ def caplog(request):
448450
result._finalize()
449451

450452

451-
def get_actual_log_level(config, *setting_names):
452-
"""Return the actual logging level."""
453-
453+
def get_log_level_for_setting(config: Config, *setting_names: str) -> Optional[int]:
454454
for setting_name in setting_names:
455455
log_level = config.getoption(setting_name)
456456
if log_level is None:
457457
log_level = config.getini(setting_name)
458458
if log_level:
459459
break
460460
else:
461-
return
461+
return None
462462

463463
if isinstance(log_level, str):
464464
log_level = log_level.upper()
@@ -483,7 +483,7 @@ class LoggingPlugin:
483483
"""Attaches to the logging module and captures log messages for each test.
484484
"""
485485

486-
def __init__(self, config):
486+
def __init__(self, config: Config) -> None:
487487
"""Creates a new plugin to capture log messages.
488488
489489
The formatter can be safely shared across all handlers so
@@ -503,9 +503,9 @@ def __init__(self, config):
503503
get_option_ini(config, "log_date_format"),
504504
get_option_ini(config, "log_auto_indent"),
505505
)
506-
self.log_level = get_actual_log_level(config, "log_level")
506+
self.log_level = get_log_level_for_setting(config, "log_level")
507507

508-
self.log_file_level = get_actual_log_level(config, "log_file_level")
508+
self.log_file_level = get_log_level_for_setting(config, "log_file_level")
509509
self.log_file_format = get_option_ini(config, "log_file_format", "log_format")
510510
self.log_file_date_format = get_option_ini(
511511
config, "log_file_date_format", "log_date_format"
@@ -518,7 +518,7 @@ def __init__(self, config):
518518
if log_file:
519519
self.log_file_handler = logging.FileHandler(
520520
log_file, mode="w", encoding="UTF-8"
521-
)
521+
) # type: Optional[logging.FileHandler]
522522
self.log_file_handler.setFormatter(self.log_file_formatter)
523523
else:
524524
self.log_file_handler = None
@@ -568,7 +568,7 @@ def _setup_cli_logging(self):
568568
get_option_ini(config, "log_auto_indent"),
569569
)
570570

571-
log_cli_level = get_actual_log_level(config, "log_cli_level", "log_level")
571+
log_cli_level = get_log_level_for_setting(config, "log_cli_level", "log_level")
572572
self.log_cli_handler = log_cli_handler
573573
self.live_logs_context = lambda: catching_logs(
574574
log_cli_handler, formatter=log_cli_formatter, level=log_cli_level

0 commit comments

Comments
 (0)