nmk.logs¶

Attributes¶

`LOG_FORMAT`	Displayed logs format
`LOG_FORMAT_DEBUG`	File logs format
`NmkLogger`	Root logger instance

Classes¶

NmkLogWrapper

Wrapped logger, handling logs with emojis!

Functions¶

`logging_initial_setup`(...)	Logging setup for nmk
`logging_finalize_setup`(log_file_str, ...)	Finalize logs setup, once nmk project folder has been setup
`logging_shutdown`(args, model_keywords)	Shutdown nmk logging (i.e. remove file handler if any)

Module Contents¶

nmk.logs.LOG_FORMAT = '%(asctime)s (%(levelname).1s) %(prefix)s%(name)s %(message)s'¶: Displayed logs format

nmk.logs.LOG_FORMAT_DEBUG = '%(asctime)s.%(msecs)03d (%(levelname).1s) %(prefix)s%(name)s %(message)s -...¶: File logs format

class nmk.logs.NmkLogWrapper(logger: logging.Logger)¶

Wrapped logger, handling logs with emojis!

Parameters:: logger – logger instance to be wrapped

log(level: int, emoji: str, line: str)¶

Log provided message string + emoji, on required level

Parameters:

level – log level
emoji – emoji code or format string
line – message string to be logged

info(emoji: str, line: str)¶

Log provided message string + emoji, on INFO level

Parameters:

emoji – emoji code or format string
line – message string to be logged

debug(line: str)¶

Log provided message string (with default emoji), on DEBUG level

Parameters:: line – message string to be logged

error(line: str)¶

Log provided message string (with default emoji), on ERROR level

Parameters:: line – message string to be logged

warning(line: str)¶

Log provided message string (with default emoji), on WARNING level

Parameters:: line – message string to be logged

nmk.logs.NmkLogger¶: Root logger instance

nmk.logs.logging_initial_setup(args: argparse.Namespace) → logging.handlers.MemoryHandler | None¶

Logging setup for nmk

Parameters:: args – parsed args from the command line
Returns:: memory handler used for logging, or None if no logs are enabled

nmk.logs.logging_finalize_setup(log_file_str: str, model_paths_keywords: dict[str, str], memory_handler: logging.handlers.MemoryHandler | None)¶

Finalize logs setup, once nmk project folder has been setup

Parameters:

log_file_str – log file path pattern (from command line args)
model_paths_keywords – keywords to be used in the log file path pattern (computed from nmk model)
memory_handler – memory handler used for logging, or None if no logs are enabled

nmk.logs.logging_shutdown(args: argparse.Namespace, model_keywords: dict[str, str])¶

Shutdown nmk logging (i.e. remove file handler if any)

Parameters:

args – parsed args from the command line
model_keywords – keywords to be used in the log file path pattern (computed from nmk model)