tlo.logging package

Submodules

Module contents

disable(level: int) None

Disable all logging calls of specified level and below.

getLogger(name: str = 'tlo') Logger

Returns a TLO logger of the specified name

initialise(add_stdout_handler: bool = True, simulation_date_getter: ~typing.Callable[[], str] = <function _mock_simulation_date_getter>, root_level: int = 30, stdout_handler_level: int = 10, formatter: ~logging.Formatter = <logging.Formatter object>) None

Initialise logging system and set up root tlo logger.

Parameters:
  • add_stdout_handler – Whether to add a handler to output log entries to stdout.

  • simulation_date_getter – Zero-argument function returning simulation date as string in ISO format to use in log entries. Defaults to function returning a a fixed dummy date for use before a simulation has been initialised.

  • root_level – Logging level for root tlo logger.

  • formatter – Formatter to use for logging to stdout.

reset()

Reset global logging state to values at initial import.

set_output_file(log_path: ~pathlib.Path, formatter: ~logging.Formatter = <logging.Formatter object>) FileHandler

Add file handler to logger.

Parameters:

log_path – Path for file.

Returns:

File handler object.

set_logging_levels(custom_levels: Dict[str, int]) None

Set custom logging levels for disease modules

Parameters:

custom_levels – Dictionary of modules and their level, ‘*’ can be used as a key for all modules