sunflare.log#

class sunflare.log.Loggable#

Mixin class to extend log records with the class name and the user defined ID.

Models and controllers can inherit from this class to have a consistent log format.

All methods allow to forward extra arguments to the logger calls as documented in the logging module.

critical(msg, *args, **kwargs)#

Log a critical message in the core logger.

Parameters:

  • msg (str) – String to log.

  • *args (Any) – Additional positional arguments for logging.Logger.critical.

  • **kwargs (Any) – Additional keyword arguments for logging.Logger.critical.

Return type:

None

debug(msg, *args, **kwargs)#

Log a debug message in the core logger.

Parameters:

  • msg (str) – String to log.

  • *args (Any) – Additional positional arguments for logging.Logger.debug.

  • **kwargs (Any) – Additional keyword arguments for logging.Logger.debug.

Return type:

None

error(msg, *args, **kwargs)#

Log an error. message in the core logger.

Parameters:

  • msg (str) – String to log.

  • *args (Any) – Additional positional arguments for logging.Logger.error.

  • **kwargs (Any) – Additional keyword arguments for logging.Logger.error.

Return type:

None

exception(msg, *args, **kwargs)#

Log an exception message in the core logger.

Parameters:

  • msg (str) – String to log.

  • *args (Any) – Additional positional arguments for logging.Logger.exception.

  • **kwargs (Any) – Additional keyword arguments for logging.Logger.exception.

Return type:

None

info(msg, *args, **kwargs)#

Log an info message in the core logger.

Parameters:

  • msg (str) – String to log.

  • *args (Any) – Additional positional arguments for logging.Logger.info.

  • **kwargs (Any) – Additional keyword arguments for logging.Logger.info.

Return type:

None

property name: str#

Class instance unique identifier.

This property should be implemented by model classes by default.

Meta-private:

warning(msg, *args, **kwargs)#

Log a warning message in the core logger.

Parameters:

  • msg (str) – String to log.

  • *args (Any) – Additional positional arguments for logging.Logger.warning.

  • **kwargs (Any) – Additional keyword arguments for logging.Logger.warning.

Return type:

None