Check logging

Checks dealing with logging module

Module private variables

logging_strict.util.check_logging.__all__: tuple[str, str, str, str, str, str] = ("is_assume_root", "check_logger", "check_level_name",    "check_level", "check_formatter", "str2int")

Exported objects from this module

Module objects

logging_strict.util.check_logging.check_formatter(format_='%(levelname)s %(module)s %(funcName)s: %(lineno)d: %(message)s')

Check logging format str

Parameters:

format_ (Any | None) –

Default LOG_FORMAT

Can pass in anything. Intended to be a logging format str

Returns:

True if a valid logging formatter str otherwise False

Return type:

bool

logging_strict.util.check_logging.check_level(level)

Check whether or not level can be normalized into a logging level name

Parameters:

level (Any | None) – str or int or logging.INFO (, etc) or Any

Returns:

True level can be normalized otherwise False

Return type:

bool

logging_strict.util.check_logging.check_level_name(logger_name)

Check logger level name

Parameters:

logger_name (typing.Any | None) – Logger name can be a logging.Logger, str

Returns:

True check pass otherwise False

Return type:

bool

logging_strict.util.check_logging.check_logger(logger)

Check working with a logging.Logger

Parameters:

logger (typing.Any | str | None) – Logger name can be a logging.Logger or str

Returns:

Would produce a normalized logger

Return type:

bool

logging_strict.util.check_logging.is_assume_root(logger_name)

Consider all these to be root:

  • None

  • Empty string

  • String containing only whitespace

  • “root”

Parameters:

logger_name (Any | None) – A logger name

Returns:

True if should assume is root loger name otherwise False

Return type:

bool

logging_strict.util.check_logging.str2int(level=None)

Support both integer levels as int or as a str. Try to convert. If possible to convert str -> int. Otherwise False

Parameters:

level (Any | None) – Can be

Returns:

False if cannot convert str -> int otherwise the int

Return type:

int | bool