arrakis.logger

Logging module for arrakis

Attributes

logger

Classes

CustomFormatter	Formatter instances are used to convert a LogRecord to text.
TqdmToLogger	Output stream for TQDM which will output to logger module instead of
UltimateHelpFormatter	Help message formatter which retains formatting of all help text.

Functions

get_arrakis_logger(→ logging.Logger)

Will construct a logger object.

Module Contents

class arrakis.logger.CustomFormatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

Bases: logging.Formatter

Formatter instances are used to convert a LogRecord to text.

Formatters need to know how a LogRecord is constructed. They are responsible for converting a LogRecord to (usually) a string which can be interpreted by either a human or an external system. The base Formatter allows a formatting string to be specified. If none is supplied, the style-dependent default value, “%(message)s”, “{message}”, or “${message}”, is used.

The Formatter can be initialized with a format string which makes use of knowledge of the LogRecord attributes - e.g. the default value mentioned above makes use of the fact that the user’s message and arguments are pre- formatted into a LogRecord’s message attribute. Currently, the useful attributes in a LogRecord are described by:

%(name)s Name of the logger (logging channel) %(levelno)s Numeric logging level for the message (DEBUG, INFO,

WARNING, ERROR, CRITICAL)

%(levelname)s Text logging level for the message (“DEBUG”, “INFO”,

“WARNING”, “ERROR”, “CRITICAL”)

%(pathname)s Full pathname of the source file where the logging

call was issued (if available)

%(filename)s Filename portion of pathname %(module)s Module (name portion of filename) %(lineno)d Source line number where the logging call was issued

(if available)

%(funcName)s Function name %(created)f Time when the LogRecord was created (time.time()

return value)

%(asctime)s Textual time when the LogRecord was created %(msecs)d Millisecond portion of the creation time %(relativeCreated)d Time in milliseconds when the LogRecord was created,

relative to the time the logging module was loaded (typically at application startup time)

%(thread)d Thread ID (if available) %(threadName)s Thread name (if available) %(process)d Process ID (if available) %(message)s The result of record.getMessage(), computed just as

the record is emitted

format(record)

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.

FORMATS

blue = '\x1b[34;20m'

bold_red = '\x1b[31;1m'

format_str = '%(asctime)s.%(msecs)03d %(module)s - %(funcName)s: %(message)s'

green = '\x1b[32;20m'

grey = '\x1b[38;20m'

red = '\x1b[31;20m'

reset = '\x1b[0m'

yellow = '\x1b[33;20m'

class arrakis.logger.TqdmToLogger(logger, level=None)

Bases: io.StringIO

Output stream for TQDM which will output to logger module instead of the StdOut.

flush()

Flush write buffers, if applicable.

This is not implemented for read-only and non-blocking streams.

write(buf)

Write string to file.

Returns the number of characters written, which is always equal to the length of the string.

buf = ''

level = None

logger = None

class arrakis.logger.UltimateHelpFormatter(prog, indent_increment=2, max_help_position=24, width=None)

Bases: argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter

Help message formatter which retains formatting of all help text.

Only the name of this class is considered a public API. All the methods provided by the class are considered an implementation detail.

arrakis.logger.get_arrakis_logger(name: str = 'arrakis', attach_handler: bool = True) → logging.Logger

Will construct a logger object.

Parameters:

• name (str, optional) – Name of the logger to attempt to use. This is ignored if in a prefect flowrun. Defaults to ‘arrakis’.

• attach_handler (bool, optional) – Attacjes a custom StreamHandler. Defaults to True.

Returns:

The appropriate logger

Return type:

logging.Logger

arrakis.logger.logger