ample.util.logging_util module¶

class LogColorFormatter(fmt=None, datefmt=None)[source]¶

Bases: logging.Formatter

Formatter for log messages

format(record)[source]¶

Format the specified record as text.

The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

class LogColors[source]¶

Bases: enum.Enum

Color container for log messages

CRITICAL = 31¶

DEBUG = 34¶

DEFAULT = 0¶

ERROR = 31¶

WARNING = 33¶

setup_console_logging(level=20, formatstr='%(message)s\n')[source]¶

Set up logging to the console - required for the individual modules.

Parameters:	level (int) – Sets the threshold for the console output to level. formatstr (str) – The string used to format the log messages
Returns:	logger – The root logger
Return type:	:obj:logging.logger

setup_file_logging(logfile, level=10, formatstr='%(asctime)s - %(name)s - %(levelname)s - %(message)s')[source]¶

Set up logging to a file - required for the individual modules.

Parameters:	logfile (str) – The path to the logfile that output will be written to. level (int) – Sets the threshold for the console output to level. formatstr (str) – The string used to format the log messages
Returns:	logger – The root logger
Return type:	:obj:logging.logger

setup_logging(argso)[source]¶

Read JSON config for logger and return root logger

Also sets the path to the AMPLE logfile in the dictionary (required for pyrvapi)