"""Utility methods for logging tasks."""
import logging
from contextlib import contextmanager as _contextmanager
from typing import Any, Dict, List, Tuple, Union
FORMAT: str = "%(asctime)s.%(msecs)03d [%(name)s:%(levelname)s] %(message)s"
"""Default logging format; ``<date-format>.378 [rics:DEBUG] I'm a debug message!``"""
DATE_FORMAT: str = "%Y-%m-%dT%H:%M:%S"
"""Default logging date format; ``2022-02-05T11:17:05<logging-format>``"""
[docs]def basic_config(
*,
format: str = FORMAT, # noqa: A002
datefmt: str = DATE_FORMAT,
level: Union[int, str] = logging.INFO,
force: bool = True,
**kwargs: Any,
) -> None:
"""Do basic logging configuration with package defaults.
Simple wrapper for the standard :py:func:`logging.basicConfig`-method, using my personal preferences for defaults.
Args:
format: Format string for emitted messages; see :attr:`FORMAT`.
datefmt: Format string for date/time; see :attr:`DATE_FORMAT`.
level: Log level for the root logger. Default is ``logging.INFO``.
force: If ``True``, override existing configuration if it exists.
**kwargs: Keyword arguments for :py:func:`logging.basicConfig`.
Keyword Args:
_level: Additional log levels to set, replacing *double* underscores with dots to produce the logger names. For
example, passing ``rics__performance_level=logging.INFO`` will modify the `'rics.performance'`-logger.
Examples:
Basic usage.
>>> from rics.logs import basic_config, logging
>>> basic_config(level=logging.INFO, rics_level=logging.DEBUG)
>>> logging.getLogger("rics").debug("I'm a debug message!")
>>> logging.debug("I'm a debug message!")
>>> logging.critical("I'm a critical message!") # Doctest: +SKIP
2022-02-05T11:17:05.378 [rics:DEBUG] I'm a debug message!
2022-02-05T11:17:05.378 [root:CRITICAL] I'm a critical message!
"""
extra_levels, kwargs = _extract_extra_levels(**kwargs)
logging.basicConfig(level=level, format=format, datefmt=datefmt, force=force, **kwargs)
for name, level in extra_levels.items():
logging.getLogger(name).setLevel(level)
[docs]@_contextmanager
def disable_temporarily( # type: ignore[no-untyped-def]
logger: Union[logging.Logger, logging.LoggerAdapter], # type: ignore[type-arg]
*more_loggers: Union[logging.Logger, logging.LoggerAdapter], # type: ignore[type-arg]
): # noqa: ANN201
"""Temporarily disable logging.
Args:
logger: A logger to disable.
*more_loggers: Additional loggers to disable.
Yields:
Nothing.
Examples:
Disable all logging temporarily.
>>> import logging
>>> logging.basicConfig()
>>> with disable_temporarily(logging.root):
... logging.info("This message is ignored.")
"""
loggers: List[logging.Logger] = []
for lgr in (logger, *more_loggers):
while isinstance(lgr, logging.LoggerAdapter):
lgr = lgr.logger
loggers.append(lgr)
states = [lgr.disabled for lgr in loggers]
try:
for lgr in loggers:
lgr.disabled = True
yield
finally:
for lgr, old_state in zip(loggers, states):
lgr.disabled = old_state
def _extract_extra_levels(**kwargs: Any) -> Tuple[Dict[str, Union[int, str]], Dict[str, Any]]:
suffix = "_level"
levels: Dict[str, Union[int, str]] = {}
for key in list(kwargs.keys()):
if key and key.endswith(suffix):
wildcard_key = key[: -len(suffix)].replace("__", ".")
level = kwargs.pop(key)
if level is not None: # pragma: no cover
levels[wildcard_key] = level
return levels, kwargs