class wxflow.Logger(name: str = None, level: str = None, _format: str = '%(asctime)s - %(levelname)-8s - %(name)-12s: %(message)s', colored_log: bool = False, logfile_path: str | Path = None)

Bases: object

Improved logging

Initialize Logger

Parameters:

• name (str) – Name of the Logger object default : None

• level (str) – Desired Logging level default : ‘INFO’

• _format (str) – Desired Logging Format default : ‘%(asctime)s - %(levelname)-8s - %(name)-12s: %(message)s’

• colored_log (bool) – Use colored logging for stdout default: False

• logfile_path (str or Path) – Path for logging to a file default : None

classmethod add_file_handler(logfile_path: str | Path, level: str = 'INFO', _format: str = '%(asctime)s - %(levelname)-8s - %(name)-12s: %(message)s')

Create file handler. This classmethod will allow setting custom file handler on children Create stream handler This classmethod will allow setting a custom stream handler on children

Parameters:

• logfile_path (str or Path) – Path for writing out logfiles from logging default : False

• level (str) – logging level default : ‘INFO’

• _format (str) – logging format default : ‘%(asctime)s - %(levelname)-8s - %(name)-12s: %(message)s’

Returns:

handler – file handler of a logging object

Return type:

logging.Handler

classmethod add_handlers(logger: Logger, handlers: List[Handler])

Add a list of handlers to a logger

Parameters:

• logger (logging.Logger) – Logger object to add a new handler to

• handlers (list) – A list of handlers to be added to the logger object

Returns:

logger

Return type:

Logger object

classmethod add_stream_handler(level: str = 'INFO', _format: str = '%(asctime)s - %(levelname)-8s - %(name)-12s: %(message)s', colored_log: bool = False)

Create stream handler This classmethod will allow setting a custom stream handler on children

Parameters:

• level (str) – logging level default : ‘INFO’

• _format (str) – logging format default : ‘%(asctime)s - %(levelname)-8s - %(name)-12s: %(message)s’

• colored_log (bool) – enable colored output for stdout default : False

Returns:

handler – stream handler of a logging object

Return type:

logging.Handler

get_logger()

Return the logging object

Returns:

logger

Return type:

Logger object

wxflow.logit(logger, name=None, message=None)

Logger decorator to add logging to a function. Simply add: @logit(logger) before any function :Parameters: * logger (Logger) – Logger object

• name (str) – Name of the module to be logged default: __module__

• message (str) – Name of the function to be logged default: __name__