Skip to content

local

env_vars()

Obtain basic environment variables in a local environment.

Returns:

Type Description
OneOf[Issue, EnvVars]

An EnvVars instance if successful.
Source code in m/log/ci_tools/providers/local.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
def env_vars() -> OneOf[Issue, EnvVars]:
    """Obtain basic environment variables in a local environment.

    Returns:
        An `EnvVars` instance if successful.
    """
    return one_of(
        lambda: [
            EnvVars(
                git_branch=git_branch,
                git_sha=git_sha,
            )
            for git_branch in git.get_branch()
            for git_sha in git.get_current_commit_sha()
        ],
    )

log_format(formatter, record, show_traceback, debug_python)

Format a log record using the functions provided in this module.

This function is meant to be used by a log formatter. See more info

Parameters:

Name Type Description Default
formatter Formatter

A log formatter instance.

 required
record LogRecord

A log record.

 required
show_traceback bool

If true, display the python stack trace.

 required
debug_python bool

If true, display the location of the record's origin.

 required

Returns:

Type Description
str

A formatted string.
Source code in m/log/ci_tools/providers/local.py 
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
def log_format(
    formatter: logging.Formatter,
    record: logging.LogRecord,
    show_traceback: bool,
    debug_python: bool,
) -> str:
    """Format a log record using the functions provided in this module.

    This function is meant to be used by a log formatter. See more info


    Args:
        formatter: A log formatter instance.
        record: A log record.
        show_traceback: If true, display the python stack trace.
        debug_python: If true, display the location of the record's origin.

    Returns:
        A formatted string.
    """
    record_dict = record.__dict__

    open_b = record_dict.get('open_block')
    if open_b:
        name, desc = open_b
        return f'>>> [{name}]: {desc}'.rstrip()

    if record_dict.get('close_block'):
        return ''

    indent = len(record.levelname) + 3
    context = format_context(record, indent, show_traceback=show_traceback)
    if not record.msg:
        return context[1:]

    ci_info = record_dict.get('ci_info', Message(msg=record.msg))
    msg_info = format_location([ci_info.file, ci_info.line, ci_info.col])
    loc = (
        format_location([record.pathname, f'{record.lineno}'], 'bold_aqua')
        if debug_python
        else ''
    )

    return default_record_fmt(
        record,
        formatter.formatTime(record, formatter.datefmt),
        f'{msg_info}{loc}',
        context,
    )