banffprocessor.processor_logger package#

Submodules#

banffprocessor.processor_logger.processor_logger module#

banffprocessor.processor_logger.processor_logger.add_file_handlers(log_directory: str | Path = './/', trace_level: int | None = 20, filename: str = 'banffprocessor') → None[source]#

Add a file handler to the top-level logger, depending on trace_level.

If trace_level is greater than INFO, no file handlers are added. If exactly equal to INFO, an INFO-level handler is created. If less than INFO, a DEBUG-level handler is created. If there are already any existing FileHandlers (or subclass of FileHandler, such as RotatingFileHandler) attached, they are removed prior to adding any new ones. Also updates _c_handlers to list all current handlers which should receive C output. Filename for logs is: banffprocessor.log.

Parameters:

  • log_directory (str | Path, optional) – The directory where new log files should be created, defaults to “.//”

  • trace_level (int, optional) – The logging level to set the file handler for, defaults to logging.DEBUG

  • filename (str, optional) – The base filename to use for the filehandlers, defaults to banffprocessor

banffprocessor.processor_logger.processor_logger.get_c_handlers() → list[FileHandler][source]#

Get list of logging handler(s) which C code output should be written to.

banffprocessor.processor_logger.processor_logger.get_child_stream_logger(name: str) → Logger[source]#

Get a proc-level logger under name with no handlers but a single console debug stream.

banffprocessor.processor_logger.processor_logger.get_file_handler(filename: str, trace_level: int = 10) → RotatingFileHandler[source]#

Get a RotatingFileHandler object configured for the banffprocessor project.

The filename will be appended with the current datetime in order to allow a new file to be created every run.

Parameters:

  • filename (str, optional) – The base name to use for the new log file, defaults to LOG_FILE

  • trace_level (int, optional) – The logging level to set the file handler for, defaults to logging.DEBUG

Returns:

A RotatingFileHandler object configured for the banffprocessor project.

Return type:

RotatingFileHandler

banffprocessor.processor_logger.processor_logger.get_processor_child_logger(name: str) → Logger[source]#

Get the proc-level logger under name.

banffprocessor.processor_logger.processor_logger.setup_processor_logger() → Logger[source]#

Setup the Processor logger by initializing and configuring console and file output.

Returns:

_description_

Return type:

logging.Logger

Module contents#

Logging utilities for the Banff Processor.