Skip to content

formatting

LoggingFormatBuilder 

>>> logging_format: str = LoggingFormatBuilder(separator=" | ") \
...     .add_asctime() \
...     .add_levelname(".3") \
...     .add_module("<10") \
...     .add_lineno(">3") \
...     .add_message() \
...     .build()
Source code in src/loggext/formatting/builder.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
class LoggingFormatBuilder:
    r"""
    ```pycon

    >>> logging_format: str = LoggingFormatBuilder(separator=" | ") \
    ...     .add_asctime() \
    ...     .add_levelname(".3") \
    ...     .add_module("<10") \
    ...     .add_lineno(">3") \
    ...     .add_message() \
    ...     .build()

    ```
    """

    _separator: str
    _parts: t.List[str]

    def __init__(self, *, separator: str = ":"):
        self._separator = separator
        self._parts = []

    def build(self) -> str:
        r""" create the final logging-format """
        return self._separator.join(self._parts)

    def add_field(self, name: str, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" adds a custom field """
        if fmt is None:
            self._parts.append(f"{{{name}}}")
        else:
            self._parts.append(f"{{{name}:{fmt}}}")
        return self

    def add_literal(self, literal: str) -> 'LoggingFormatBuilder':
        r""" adds a literal string as given """
        self._parts.append(literal)
        return self

    def add_asctime(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r"""
        Human-readable time when the LogRecord was created.
        By default, this is of the form ‘2003-07-08 16:49:45,896’
        (the numbers after the comma are millisecond portion of the time).
        """
        return self.add_field('asctime', fmt)

    def add_created(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Time when the LogRecord was created (as returned by time.time()). """
        return self.add_field('created', fmt)

    def add_filename(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Filename portion of pathname. """
        return self.add_field('filename', fmt)

    def add_funcname(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Name of function containing the logging call. """
        return self.add_field('funcName', fmt)

    def add_levelname(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Numeric logging level for the message (DEBUG, INFO, WARNING, ERROR, CRITICAL). """
        return self.add_field('levelname', fmt)

    def add_levelno(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Numeric logging level for the message (DEBUG, INFO, WARNING, ERROR, CRITICAL). """
        return self.add_field('levelno', fmt)

    def add_lineno(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Source line number where the logging call was issued (if available). """
        return self.add_field('lineno', fmt)

    def add_message(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" The logged message, computed as msg % args. This is set when Formatter.format() is invoked. """
        return self.add_field('message', fmt)

    def add_module(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Module (name portion of filename). """
        return self.add_field('module', fmt)

    def add_msecs(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Millisecond portion of the time when the LogRecord was created. """
        return self.add_field('msecs', fmt)

    def add_name(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Name of the logger used to log the call. """
        return self.add_field('name', fmt)

    def add_pathname(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Full pathname of the source file where the logging call was issued (if available). """
        return self.add_field('pathname', fmt)

    def add_process(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Process ID (if available) """
        return self.add_field('process', fmt)

    def add_processname(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Process name (if available) """
        return self.add_field('processName', fmt)

    def add_relativecreated(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Time in milliseconds when the LogRecord was created, relative to the time the logging module was loaded."""
        return self.add_field('relativeCreated', fmt)

    def add_thread(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Thread ID (if available) """
        return self.add_field('thread', fmt)

    def add_threadname(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" Thread name (if available) """
        return self.add_field('threadName', fmt)

    def add_taskname(self, fmt: str = None) -> 'LoggingFormatBuilder':
        r""" asyncio.Task name (if available) """
        return self.add_field('taskName', fmt)

add_asctime(fmt=None)

Human-readable time when the LogRecord was created. By default, this is of the form ‘2003-07-08 16:49:45,896’ (the numbers after the comma are millisecond portion of the time).

Source code in src/loggext/formatting/builder.py 
50
51
52
53
54
55
56
def add_asctime(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r"""
    Human-readable time when the LogRecord was created.
    By default, this is of the form ‘2003-07-08 16:49:45,896’
    (the numbers after the comma are millisecond portion of the time).
    """
    return self.add_field('asctime', fmt)

add_created(fmt=None)

Time when the LogRecord was created (as returned by time.time()).

Source code in src/loggext/formatting/builder.py 
58
59
60
def add_created(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Time when the LogRecord was created (as returned by time.time()). """
    return self.add_field('created', fmt)

add_field(name, fmt=None)

adds a custom field

Source code in src/loggext/formatting/builder.py 
37
38
39
40
41
42
43
def add_field(self, name: str, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" adds a custom field """
    if fmt is None:
        self._parts.append(f"{{{name}}}")
    else:
        self._parts.append(f"{{{name}:{fmt}}}")
    return self

add_filename(fmt=None)

Filename portion of pathname.

Source code in src/loggext/formatting/builder.py 
62
63
64
def add_filename(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Filename portion of pathname. """
    return self.add_field('filename', fmt)

add_funcname(fmt=None)

Name of function containing the logging call.

Source code in src/loggext/formatting/builder.py 
66
67
68
def add_funcname(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Name of function containing the logging call. """
    return self.add_field('funcName', fmt)

add_levelname(fmt=None)

Numeric logging level for the message (DEBUG, INFO, WARNING, ERROR, CRITICAL).

Source code in src/loggext/formatting/builder.py 
70
71
72
def add_levelname(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Numeric logging level for the message (DEBUG, INFO, WARNING, ERROR, CRITICAL). """
    return self.add_field('levelname', fmt)

add_levelno(fmt=None)

Numeric logging level for the message (DEBUG, INFO, WARNING, ERROR, CRITICAL).

Source code in src/loggext/formatting/builder.py 
74
75
76
def add_levelno(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Numeric logging level for the message (DEBUG, INFO, WARNING, ERROR, CRITICAL). """
    return self.add_field('levelno', fmt)

add_lineno(fmt=None)

Source line number where the logging call was issued (if available).

Source code in src/loggext/formatting/builder.py 
78
79
80
def add_lineno(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Source line number where the logging call was issued (if available). """
    return self.add_field('lineno', fmt)

add_literal(literal)

adds a literal string as given

Source code in src/loggext/formatting/builder.py 
45
46
47
48
def add_literal(self, literal: str) -> 'LoggingFormatBuilder':
    r""" adds a literal string as given """
    self._parts.append(literal)
    return self

add_message(fmt=None)

The logged message, computed as msg % args. This is set when Formatter.format() is invoked.

Source code in src/loggext/formatting/builder.py 
82
83
84
def add_message(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" The logged message, computed as msg % args. This is set when Formatter.format() is invoked. """
    return self.add_field('message', fmt)

add_module(fmt=None)

Module (name portion of filename).

Source code in src/loggext/formatting/builder.py 
86
87
88
def add_module(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Module (name portion of filename). """
    return self.add_field('module', fmt)

add_msecs(fmt=None)

Millisecond portion of the time when the LogRecord was created.

Source code in src/loggext/formatting/builder.py 
90
91
92
def add_msecs(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Millisecond portion of the time when the LogRecord was created. """
    return self.add_field('msecs', fmt)

add_name(fmt=None)

Name of the logger used to log the call.

Source code in src/loggext/formatting/builder.py 
94
95
96
def add_name(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Name of the logger used to log the call. """
    return self.add_field('name', fmt)

add_pathname(fmt=None)

Full pathname of the source file where the logging call was issued (if available).

Source code in src/loggext/formatting/builder.py 
 98
 99
100
def add_pathname(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Full pathname of the source file where the logging call was issued (if available). """
    return self.add_field('pathname', fmt)

add_process(fmt=None)

Process ID (if available)

Source code in src/loggext/formatting/builder.py 
102
103
104
def add_process(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Process ID (if available) """
    return self.add_field('process', fmt)

add_processname(fmt=None)

Process name (if available)

Source code in src/loggext/formatting/builder.py 
106
107
108
def add_processname(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Process name (if available) """
    return self.add_field('processName', fmt)

add_relativecreated(fmt=None)

Time in milliseconds when the LogRecord was created, relative to the time the logging module was loaded.

Source code in src/loggext/formatting/builder.py 
110
111
112
def add_relativecreated(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Time in milliseconds when the LogRecord was created, relative to the time the logging module was loaded."""
    return self.add_field('relativeCreated', fmt)

add_taskname(fmt=None)

asyncio.Task name (if available)

Source code in src/loggext/formatting/builder.py 
122
123
124
def add_taskname(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" asyncio.Task name (if available) """
    return self.add_field('taskName', fmt)

add_thread(fmt=None)

Thread ID (if available)

Source code in src/loggext/formatting/builder.py 
114
115
116
def add_thread(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Thread ID (if available) """
    return self.add_field('thread', fmt)

add_threadname(fmt=None)

Thread name (if available)

Source code in src/loggext/formatting/builder.py 
118
119
120
def add_threadname(self, fmt: str = None) -> 'LoggingFormatBuilder':
    r""" Thread name (if available) """
    return self.add_field('threadName', fmt)

build()

create the final logging-format

Source code in src/loggext/formatting/builder.py 
33
34
35
def build(self) -> str:
    r""" create the final logging-format """
    return self._separator.join(self._parts)