cornflakes.logging package

Submodules

cornflakes.logging.logger module

class cornflakes.logging.logger.LoggerMetaClass(classname, bases, class_dict)[Quellcode]

Bases: type

LoggerMetaClass used for metaclass.

class cornflakes.logging.logger.LoggerProtocol(*args, **kwargs)[Quellcode]

Bases: Protocol

LoggerProtocol used for Type Annotation.

logger: Logger

Module contents

cornflakes Logger.

attach_log([obj, log_level, default_level, ...])

Function decorator to attach Logger to functions.

setup_logging([default_path, default_level, ...])

Setup logging configuration.
cornflakes.logging.attach_log(obj=None, log_level=None, default_level=None, default_path='logging.yaml', env_key='LOG_CFG')

Function decorator to attach Logger to functions.

Parameter:

  • obj – Logger function or class to attach the logging to.

  • log_level (int | None) – log-level for the current object logging.

  • default_path (str) – Default path to logging config file.

  • default_level (int | None) – Default log-level (Logging.INFO).

  • env_key (str) – Environment key to use for logging configuration.

Rückgabe:

Object with attached logging instance

cornflakes.logging.setup_logging(default_path='logging.yaml', default_level=None, env_key='LOG_CFG', force=False, loggers=None, handlers=None, **kwargs)

Setup logging configuration.

Parameter:

  • force (bool) – Overwrite current log-level

  • default_path (str) – Default path to logging config file.

  • default_level (int | None) – Default log-level (Logging.INFO).

  • env_key (str) – Environment key to use for logging configuration.

  • loggers (List[str] | None) – List of loggers to set log-level for.

  • handlers (List[str] | None) – List of handlers to set log-level for.

  • kwargs – arguments to pass to rich_handler