nautical.log package

Submodules

nautical.log.log module

class nautical.log.log.NauticalLogFormatter(use_color: bool = True)

Bases: Formatter

Colored log formatter with per-level ANSI styling when outputting to a TTY.

green = '\x1b[32;20m'

blue = '\x1b[34;20m'

yellow = '\x1b[33;20m'

red = '\x1b[31;20m'

purple = '\x1b[35;20m'

reset = '\x1b[0m'

fmt = '[🌊 %(levelname)s %(asctime)s %(name)s]: %(message)s'

__init__(use_color: bool = True) → None

Initialize the formatter with specified format strings.

Initialize the formatter either with the specified format string, or a default as described above. Allow for specialized date formatting with the optional datefmt argument. If datefmt is omitted, you get an ISO8601-like (or RFC 3339-like) format.

Use a style parameter of ‘%’, ‘{’ or ‘$’ to specify that you want to use one of %-formatting, str.format() ({}) formatting or string.Template formatting in your format string.

Changed in version 3.2: Added the style parameter.

format(record: LogRecord) → str

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.

nautical.log.log.get_logger(name: str = 'nautical') → Logger

Get a logger with nautical formatting.

Parameters:

name – Logger name (use __name__ for per-module loggers)

Returns:

Configured logger instance

Module contents

nautical.log.get_logger(name: str = 'nautical') → Logger

Get a logger with nautical formatting.

Parameters:

name – Logger name (use __name__ for per-module loggers)

Returns:

Configured logger instance