Skip to content

short_name

ShortNameField

Bases: DataProvider

Shortens the name of the current logger and adds it to the LogRecord as shortName. This can heavily decrease the size of your log-files in exchange for losing some clarity.

Example

project.custom.module -> p.c.module

Example

>>> import logging
>>> ShortNameField().install()
Source code in src/loggext/extradata/short_name.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class ShortNameField(DataProvider):
    r"""
    Shortens the name of the current logger and adds it to the LogRecord as `shortName`.
    This can heavily decrease the size of your log-files in exchange for losing some clarity.

    !!! example
        `project.custom.module` -> `p.c.module`

    !!! example
        ```pycon
        >>> import logging
        >>> ShortNameField().install()
        ```
    """

    @cache
    def _short_name(self, name: str) -> str:
        *head, tail = name.split('.')
        return '.'.join(tuple(p[0] for p in head) + (tail,))

    def add_data(self, record):
        print(f"Adding ShortNameField for {record.name}")
        record.shortName = self._short_name(record.name)