darkmappy.logs.critical_log(message)

Log a critical message (e.g. core code failures etc).

Parameters

message – Message to log.

darkmappy.logs.debug_log(message)

Log a debug message (e.g. for background logs to assist debugging).

Parameters

message – Message to log.

darkmappy.logs.info_log(message)

Log an information message (e.g. evidence value printing, run completion etc).

Parameters

message – Message to log.

darkmappy.logs.setup_logging(custom_yaml_path=None, default_level=10)

initialise and configure logging.

Should be called at the beginning of code to initialise and configure the desired logging level. Logging levels can be ints in [0,50] where 10 is debug logging and 50 is critical logging.

Parameters

• custom_yaml_path (string) – Complete pathname of desired yaml logging configuration. If empty will provide default logging config.

• default_level (int) – Logging level at which to configure.

Raises

ValueError – Raised if logging.yaml is not in ./logs/ directory.

darkmappy.logs.warning_log(message)

Log a warning (e.g. for internal code warnings such as large dynamic ranges).

Parameters

message – Warning to log.