floris.logging_manager

floris.logging_manager#

Functions

configure_console_log([enabled, level])

Sets whether the log statements are displayed in the console logging, and, if enabled, the log level to use.

configure_file_log([enabled, level])

Sets whether the log statements are exported to a log file, and, if enabled, the log level to use.

Classes

LoggingManager()

This class provide an easy access to the global logger.

TracebackInfoFilter([clear])

Clear or restore the exception on log records
floris.logging_manager.configure_console_log(enabled=True, level='INFO')[source]#

Sets whether the log statements are displayed in the console logging, and, if enabled, the log level to use. If not explicitly configured, console logging is ON at the INFO level.

Args:
enabled (bool, optional): Whether to enable console logging.

Defaults to True.

level (str, optional): If enabled is True, sets the level that the

logging module displays. This level is the minimum and all messages at a higher level are included. Valid values are

  • CRITICAL

  • ERROR

  • WARNING

  • INFO

  • DEBUG

Defaults to "INFO".

floris.logging_manager.configure_file_log(enabled=True, level='INFO')[source]#

Sets whether the log statements are exported to a log file, and, if enabled, the log level to use. If not explicitly configured, file logging is OFF.

Args:
enabled (bool, optional): Whether to enable file logging.

This argument defaults to True.

level (str, optional): If enabled is True, sets the level that the

logging module displays. This level is the minimum and all messages at a higher level are included. Valid values are

  • CRITICAL

  • ERROR

  • WARNING

  • INFO

  • DEBUG

Defaults to "INFO".

class floris.logging_manager.TracebackInfoFilter(clear=True)[source]#

Clear or restore the exception on log records

filter(record)[source]#

Determine if the specified record is to be logged.

Returns True if the record should be logged, or False otherwise. If deemed appropriate, the record may be modified in-place.

class floris.logging_manager.LoggingManager[source]#

This class provide an easy access to the global logger. The virtual property here allows a simple and dynamic method for obtaining the correct logger for the calling class.

property logger#