formatters

CiFormatter

Bases: Formatter

A formatter that takes into account a CI environment.

We can still use

Source code in m/log/formatters.py

class CiFormatter(logging.Formatter):
    """A formatter that takes into account a CI environment.

    We can still use
    """

    def __init__(
        self,
        datefmt: str = '%I:%M:%S %p - %b %d, %Y',  # noqa: WPS323
    ):
        """Initialize by optionally providing a date formatter.

        See https://docs.python.org/3/library/time.html#time.strftime
        for more info on how to format the date.

        Args:
            datefmt: The date format to use.
        """
        super().__init__(datefmt=datefmt)
        self.opened_blocks: list[str] = []
        self.ci_tool = get_ci_tool()
        self.show_traceback = mio.is_traceback_enabled()
        self.debug_python = mio.is_python_info_enabled()

    def format(self, record: logging.LogRecord) -> str:
        """Format a record as based on the CI environment.

        Args:
            record: The logRecord to format.

        Returns:
            A formatted string.
        """
        msg = self.ci_tool.formatter(
            self,
            record,
            self.show_traceback,
            self.debug_python,
        )
        if self.ci_tool.ci:
            return msg

        record_dict = record.__dict__
        open_b = record_dict.get('open_block')
        close_b = record_dict.get('close_block')

        if open_b:
            name, _ = open_b
            self.opened_blocks.append(name)
        if close_b:
            while self.opened_blocks and self.opened_blocks[-1] != close_b:
                self.opened_blocks.pop()
            if self.opened_blocks:
                self.opened_blocks.pop()

        if not self.opened_blocks:
            return msg
        return textwrap.indent(msg, '  ' * len(self.opened_blocks))

__init__(datefmt='%I:%M:%S %p - %b %d, %Y')

Initialize by optionally providing a date formatter.

See https://docs.python.org/3/library/time.html#time.strftime for more info on how to format the date.

Parameters:

Name	Type	Description	Default
datefmt	str	The date format to use.	'%I:%M:%S %p - %b %d, %Y'

Source code in m/log/formatters.py

def __init__(
    self,
    datefmt: str = '%I:%M:%S %p - %b %d, %Y',  # noqa: WPS323
):
    """Initialize by optionally providing a date formatter.

    See https://docs.python.org/3/library/time.html#time.strftime
    for more info on how to format the date.

    Args:
        datefmt: The date format to use.
    """
    super().__init__(datefmt=datefmt)
    self.opened_blocks: list[str] = []
    self.ci_tool = get_ci_tool()
    self.show_traceback = mio.is_traceback_enabled()
    self.debug_python = mio.is_python_info_enabled()

format(record)

Format a record as based on the CI environment.

Parameters:

Name	Type	Description	Default
record	LogRecord	The logRecord to format.	required

Returns:

Type	Description
str	A formatted string.

Source code in m/log/formatters.py

def format(self, record: logging.LogRecord) -> str:
    """Format a record as based on the CI environment.

    Args:
        record: The logRecord to format.

    Returns:
        A formatted string.
    """
    msg = self.ci_tool.formatter(
        self,
        record,
        self.show_traceback,
        self.debug_python,
    )
    if self.ci_tool.ci:
        return msg

    record_dict = record.__dict__
    open_b = record_dict.get('open_block')
    close_b = record_dict.get('close_block')

    if open_b:
        name, _ = open_b
        self.opened_blocks.append(name)
    if close_b:
        while self.opened_blocks and self.opened_blocks[-1] != close_b:
            self.opened_blocks.pop()
        if self.opened_blocks:
            self.opened_blocks.pop()

    if not self.opened_blocks:
        return msg
    return textwrap.indent(msg, '  ' * len(self.opened_blocks))

JsonFormatter

Bases: Formatter

Format each record as JSON data in one single line.

Source code in m/log/formatters.py

class JsonFormatter(logging.Formatter):
    """Format each record as JSON data in one single line."""

    def format(self, record: logging.LogRecord) -> str:
        """Format a record as json.

        Args:
            record: The logRecord to format.

        Returns:
            A formatted string.
        """
        record_dict = record.__dict__
        context = record_dict.get('context')
        ci_info = record_dict.get('ci_info', Message(msg=record.msg))
        replacements = {
            **record_dict,
            **ci_info.model_dump(),
            'asctime': self.formatTime(record, self.datefmt),
            'context': context,
        }
        replacements.pop('ci_info', '')
        sanitized = {
            key: non_empty
            for key, non_empty in replacements.items()
            if non_empty
        }
        return json.dumps(sanitized)

format(record)

Format a record as json.

Parameters:

Name	Type	Description	Default
record	LogRecord	The logRecord to format.	required

Returns:

Type	Description
str	A formatted string.

Source code in m/log/formatters.py

def format(self, record: logging.LogRecord) -> str:
    """Format a record as json.

    Args:
        record: The logRecord to format.

    Returns:
        A formatted string.
    """
    record_dict = record.__dict__
    context = record_dict.get('context')
    ci_info = record_dict.get('ci_info', Message(msg=record.msg))
    replacements = {
        **record_dict,
        **ci_info.model_dump(),
        'asctime': self.formatTime(record, self.datefmt),
        'context': context,
    }
    replacements.pop('ci_info', '')
    sanitized = {
        key: non_empty
        for key, non_empty in replacements.items()
        if non_empty
    }
    return json.dumps(sanitized)