data_quality_control.dqclogging module

Output messages of the package are implemented using the logging module.

To manage logging behavior in scripts and notebooks use configure_handlers().

For general information in logging in Python see:

• https://docs.python.org/3/howto/logging.html#logging-basic-tutorial

• https://docs.python.org/3/howto/logging-cookbook.html#using-logging-in-multiple-modules

data_quality_control.dqclogging.configure_handlers(loglevel_console, loglevel_file=None, logfilename=None, use_new_file=False)

Configure logging behavior.

This is the function you want to call in scripts or notebooks. It sets logging levels and handlers, i.e. where to the information is displayed. By default, standard output (console) is used. Additionally, a log file can be defined. Information levels can be different.

Parameters

• loglevel_console (str {"DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"}) – level of detail for console output

• loglevel_file (None or str {"DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"}) – Level of detail for file logging. If None logging to file is omitted

• logfilename (str) – Path & name of logfile. If None logging to file is omitted

• use_new_file (bool [False]) – If True and logfile exists, it will be overwritten. Otherwise new messages are appended.

Note

For logging to file both paramters loglevel_file and logfilename must not be None.

data_quality_control.dqclogging.create_logger()

Set logger for the package.

Should not be used directly.