cement.core.log

Cement core log module.

class cement.core.log.LogHandler(**kw: Any)

Bases: LogInterface, Handler

Log handler implementation.

class Meta

Bases: Meta

class cement.core.log.LogInterface(**kw: Any)

Bases: Interface

This class defines the Log Interface. Handlers that implement this interface must provide the methods and attributes defined below. In general, most implementations should sub-class from the provided LogHandler base class as a starting point.

class Meta

Bases: Meta

Handler meta-data.

interface: str = 'log'

The string identifier of the interface.

abstractmethod debug(msg: str) → None

Log to the DEBUG facility.

Parameters:

msg (str) – The message to log.

abstractmethod error(msg: str) → None

Log to the ERROR facility.

Parameters:

msg (str) – The message to log.

abstractmethod fatal(msg: str) → None

Log to the FATAL facility.

Parameters:

msg (str) – The message to log.

abstractmethod get_level() → str

Return a string representation of the log level.

abstractmethod info(msg: str) → None

Log to the INFO facility.

Parameters:

msg (str) – The message to log.

abstractmethod set_level(level: str) → None

Set the log level. Must except atleast one of:

['INFO', 'WARNING', 'ERROR', 'DEBUG', or 'FATAL'].

abstractmethod warning(msg: str) → None

Log to the WARNING facility.

Parameters:

msg (str) – The message to log.