kennard_stone.logging package#
Logging utilities of kennard_stone.
- class kennard_stone.logging.catch_default_handler#
Disable the default handler temporarily, as a context manager.
Examples
>>> _logger = get_child_logger(__name__) >>> with catch_default_handler(): ... _logger.info("not logged") >>> _logger.info("logged")
- kennard_stone.logging.disable_default_handler() None#
Disable the default handler.
- kennard_stone.logging.enable_default_handler() None#
Enable the default handler.
- kennard_stone.logging.get_child_logger(name: str, propagate: bool = True) Logger#
Get a child logger of the library root logger.
- Parameters:
name (str) – Name of the module, usually
__name__. It must be a submodule of kennard_stone or “__main__”.propagate (bool, default=True) – Whether to propagate records to the handlers of the parent logger.
- Returns:
Child logger.
- Return type:
logging.Logger
- Raises:
ValueError – If
nameis neither a submodule of kennard_stone nor “__main__”.
- kennard_stone.logging.get_handler(handler: HANDLER, formatter: Formatter | None = None, level=0) HANDLER#
Configure a handler with a formatter and a level.
- Parameters:
handler (logging.Handler) – Handler to configure.
formatter (logging.Formatter, default=None) – Formatter to set. If None, the default formatter is used.
level (int, default=logging.NOTSET) – Level to set.
- Returns:
The given handler, configured.
- Return type:
logging.Handler
- kennard_stone.logging.get_root_logger() Logger#
Get the root logger of this library.
- Returns:
library root logger
- Return type:
Logger