paidiverpy.utils.logging_functions

Logging utilities.

Classes

VerboseLevel	Verbose levels for logging.
ColorFormatter	Custom formatter to add colors to log messages.

Functions

initialise_logging(→ logging.Logger)	Initialise logging configuration.
check_raise_error(→ None)	Check if an error should be raised and raise it if necessary.

Module Contents

class paidiverpy.utils.logging_functions.VerboseLevel

Bases: enum.IntEnum

Verbose levels for logging.

class paidiverpy.utils.logging_functions.ColorFormatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

Bases: logging.Formatter

Custom formatter to add colors to log messages.

format(record: logging.LogRecord) → str

Format the log message with color.

Parameters:

record (logging.LogRecord) – The log record.

Returns:

The formatted log message.

Return type:

str

paidiverpy.utils.logging_functions.initialise_logging(verbose: int = 2, logger_name: str = 'paidiverpy') → logging.Logger

Initialise logging configuration.

Parameters:

• verbose (int) – Verbose level (0 = NONE, 1 = ERRORS_WARNINGS, 2 = INFO, 3 = DEBUG). Defaults to 2.

• logger_name (str) – The name of the logger. Defaults to “paidiverpy”.

Returns:

The logger object.

Return type:

logging.Logger

paidiverpy.utils.logging_functions.check_raise_error(raise_error: bool, message: str) → None

Check if an error should be raised and raise it if necessary.

Parameters:

• raise_error (bool) – Whether to raise an error.

• message (str) – The error message.

Raises:

ValueError – The error message.