Log Levels

This module provides log level definitions for ctxlog.

class ctxlog.level.LogLevel(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

Log levels for ctxlog.

DEBUG = 10
INFO = 20
WARNING = 30
ERROR = 40
CRITICAL = 50
classmethod parse(level)[source]

Parse a string or int to a LogLevel.

Parameters:

level (Union[LogLevel, str, int]) – The log level as a string or int.

Return type:

LogLevel

Returns:

The corresponding LogLevel enum value.

Raises:

ValueError – If the level is not a valid log level.

classmethod from_string(level_str)[source]

Convert a string to a LogLevel.

Parameters:

level_str (str) – The string representation of the log level.

Return type:

LogLevel

Returns:

The corresponding LogLevel enum value.

Raises:

ValueError – If the string is not a valid log level.

__str__()[source]

Return the string representation of the log level.

Return type:

str

LogLevel Enum

class ctxlog.level.LogLevel(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: Enum

Log levels for ctxlog.

DEBUG = 10
INFO = 20
WARNING = 30
ERROR = 40
CRITICAL = 50
classmethod parse(level)[source]

Parse a string or int to a LogLevel.

Parameters:

level (Union[LogLevel, str, int]) – The log level as a string or int.

Return type:

LogLevel

Returns:

The corresponding LogLevel enum value.

Raises:

ValueError – If the level is not a valid log level.

classmethod from_string(level_str)[source]

Convert a string to a LogLevel.

Parameters:

level_str (str) – The string representation of the log level.

Return type:

LogLevel

Returns:

The corresponding LogLevel enum value.

Raises:

ValueError – If the string is not a valid log level.

__str__()[source]

Return the string representation of the log level.

Return type:

str

Type Aliases

ctxlog.level.LevelStr

alias of Literal[‘debug’, ‘info’, ‘warning’, ‘error’, ‘critical’]

ctxlog.level.LevelSpec

alias of LogLevel | Literal[‘debug’, ‘info’, ‘warning’, ‘error’, ‘critical’] | int