misc

default_record_fmt(record, asctime, after_time, after_msg)

Format a log record.

Parameters:

Name	Type	Description	Default
record	LogRecord	A log record.	required
asctime	str	The string representing the time of creation.	required
after_time	str	A string that will be placed after the time.	required
after_msg	str	A string to be placed after the main message.	required

Returns:

Type	Description
str	A formatted string.

Source code in m/log/misc.py

def default_record_fmt(
    record: logging.LogRecord,
    asctime: str,
    after_time: str,
    after_msg: str,
) -> str:
    """Format a log record.

    Args:
        record: A log record.
        asctime: The string representing the time of creation.
        after_time: A string that will be placed after the time.
        after_msg: A string to be placed after the main message.

    Returns:
        A formatted string.
    """
    level_color = {
        logging.DEBUG: 'green',
        logging.INFO: 'blue',
        logging.WARNING: 'yellow',
        PROMPT: 'bold_blue',
        logging.ERROR: 'red',
        logging.CRITICAL: 'bold_red',
    }.get(record.levelno, 'gray')
    fmt_time = color(f'{{gray}}[{asctime}]{{end}}') if asctime else ''
    fmt_level = color(f'{{{level_color}}}[{record.levelname}]{{end}}')
    prefix = f'{fmt_level} {fmt_time}{after_time}'.rstrip()
    record_msg = record.msg
    if level_color != 'blue':
        record_msg = color(f'{{{level_color}}}{record_msg}{{end}}')
    return f'{prefix}: {record_msg}{after_msg}'

format_context(record, indent, show_traceback)

Extract the context from a log record.

Parameters:

Name	Type	Description	Default
record	LogRecord	The log record instance.	required
indent	int	The level of indentation to apply to the string.	required
show_traceback	bool	Attempts to display the traceback if it exists.	required

Returns:

Type	Description
str	A string with leading new line of the context associated with a log
str	record.

Source code in m/log/misc.py

def format_context(
    record: logging.LogRecord,
    indent: int,
    show_traceback: bool,
) -> str:
    """Extract the context from a log record.

    Args:
        record: The log record instance.
        indent: The level of indentation to apply to the string.
        show_traceback: Attempts to display the traceback if it exists.

    Returns:
        A string with leading new line of the context associated with a log
        record.
    """
    context = record.__dict__.get('context')
    data_dict = None
    as_yaml = Issue.yaml_traceback
    if isinstance(context, Issue):
        data_dict = cast(dict, context.to_dict(show_traceback=show_traceback))
        if context.only_context():
            data_dict = data_dict['context']
    else:
        data_dict = context
    return (
        indent_payload(indent, data_dict, as_yaml=as_yaml)
        if data_dict
        else ''
    )

format_location(parts, default_color='aqua')

Join a list of possible defined strings.

Parameters:

Name	Type	Description	Default
parts	list[str | None]	A list of possibly defined strings.	required
default_color	str	The color to use for the string.	'aqua'

Returns:

Type	Description
str	A string with the location or an empty string.

Source code in m/log/misc.py

def format_location(
    parts: list[str | None],
    default_color: str = 'aqua',
) -> str:
    """Join a list of possible defined strings.

    Args:
        parts: A list of possibly defined strings.
        default_color: The color to use for the string.

    Returns:
        A string with the location or an empty string.
    """
    loc = ':'.join([x for x in parts if x])
    return color(f'{{{default_color}}}[{loc}]{{end}}') if loc else ''

indent_payload(indent, payload, prepend_new_line=True, as_yaml=True)

Stringify a dictionary as JSON and indent it.

Parameters:

Name	Type	Description	Default
indent	int	The number of spaces to indent.	required
payload	dict	The data to stringify and indent.	required
prepend_new_line	bool	Prepend a new line to the payload if True.	True
as_yaml	bool	Dump the payload in yaml.	True

Returns:

Type	Description
str	An indented payload.

Source code in m/log/misc.py

def indent_payload(
    indent: int,
    payload: dict,
    prepend_new_line: bool = True,
    as_yaml: bool = True,
) -> str:
    """Stringify a dictionary as JSON and indent it.

    Args:
        indent: The number of spaces to indent.
        payload: The data to stringify and indent.
        prepend_new_line: Prepend a new line to the payload if `True`.
        as_yaml: Dump the payload in yaml.

    Returns:
        An indented payload.
    """
    json_dict = (
        highlight_yaml(yaml.dumps(payload))
        if as_yaml
        else highlight_json(json.dumps(payload, indent=2))
    )
    indented_payload = textwrap.indent(json_dict, ' ' * indent)
    return f'\n{indented_payload}' if prepend_new_line else indented_payload