Enot logging package

enot.logging package contains common logging utilities which are used by ENOT package, and can also be used by ENOT users.

prepare_log(log_path=None, create_log_directory=True, log_format='%(asctime)s %(message)s', logging_level=20, logger_name=None, console_mode=True)

Prepare logging setup.

Parameters

  • log_path (str, Path, or None, optional) – Path to log file. Defaults to None, which disables file logging.

  • create_log_directory (bool, optional) – Whether to manually create log file directory, if it does not exist. Default: True.

  • log_format (str, optional) – Log format for logger. Default format is “%(asctime)s %(message)s”.

  • logging_level (int, optional) – Level of log for logging.Logger. Default value is logging.INFO, which makes logger to print all info messages.

  • logger_name (str or None, optional) – The name of created logger. If it is None - the default logger is used. Defaults to None.

  • console_mode (bool, optional) – Whether to log to stdout or not. Default: True.

Returns

Initialized logger.

Return type

logging.Logger

logging_config(log_path=None, create_log_directory=True, log_format='%(asctime)s %(message)s', logging_level=20, logger_name='_common_logger', console_mode=True, logging_level_env_var_name='LOGGING_LEVEL')

Prepare logging setup.

This function checks environment variables to get logging level. If logging_level is None, then it is obtained from environment variable with name stored in logging_level_env_var_name. When this variable does not exist, logging.WARNING level is used.

Parameters

  • log_path (str, Path, or None, optional) – Path to log file. Defaults to None, which disables file logging.

  • create_log_directory (bool, optional) – Whether to manually create log file directory, if it does not exist. Default: True.

  • log_format (str, optional) – Log format for logger. Default format is “%(asctime)s %(message)s”.

  • logging_level (int or None, optional) – Level of log for logging.Logger. When it is None - logging level is extracted from environment variables. Default value is logging.INFO, which makes logger to print all info messages.

  • logger_name (str or None, optional) – The name of created logger. If it is None - the default logger is used. Default name: “_common_logger”.

  • console_mode (bool, optional) – Whether to log to stdout or not. Default: True.

  • logging_level_env_var_name (str, optional) – Name of environment variable with logging level. This parameter is only used when logging_level is None. Default name: “LOGGING_LEVEL”.

Returns

Initialized logger.

Return type

logging.Logger