Skip to content

log

The log engine.

CatLogEngine

The log engine.

Engine to filter the logs in the terminal according to the level of severity.

Attributes:

Name Type Description
LOG_LEVEL str

Level of logging set in the .env file.
Notes

The logging level set in the .env file will print all the logs from that level to above. Available levels are:

- `DEBUG`
- `INFO`
- `WARNING`
- `ERROR`
- `CRITICAL`

Default to CCAT_LOG_LEVEL env variable (INFO).

Source code in cat/log.py 
 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
class CatLogEngine:
    """The log engine.

    Engine to filter the logs in the terminal according to the level of severity.

    Attributes
    ----------
    LOG_LEVEL : str
        Level of logging set in the `.env` file.

    Notes
    -----
    The logging level set in the `.env` file will print all the logs from that level to above.
    Available levels are:

        - `DEBUG`
        - `INFO`
        - `WARNING`
        - `ERROR`
        - `CRITICAL`

    Default to `CCAT_LOG_LEVEL` env variable (`INFO`).
    """

    def __init__(self):
        self.LOG_LEVEL = get_log_level()
        self.default_log()

        # workaround for pdfminer logging
        # https://github.com/pdfminer/pdfminer.six/issues/347
        logging.getLogger("pdfminer").setLevel(logging.WARNING)

    def show_log_level(self, record):
        """Allows to show stuff in the log based on the global setting.

        Parameters
        ----------
        record : dict

        Returns
        -------
        bool

        """
        return record["level"].no >= logger.level(self.LOG_LEVEL).no

    def default_log(self):
        """Set the same debug level to all the project dependencies.

        Returns
        -------
        """

        level = "<level>{level}:</level>"
        # time = "<green>[{time:YYYY-MM-DD HH:mm:ss.SSS}]</green>"
        # origin = "<level>{extra[original_name]}.{extra[original_class]}.{extra[original_caller]}::{extra[original_line]}</level>"
        message = "<level>{message}</level>"
        log_format = f"{level}\t{message}"

        logger.remove()
        logger.add(
            sys.stdout,
            level=self.LOG_LEVEL,
            colorize=True,
            format=log_format,
            # backtrace=True,
            # diagnose=True,
            filter=self.show_log_level,
        )

    def __call__(self, msg, level="DEBUG"):
        """Alias of self.log()"""
        self.log(msg, level)

    def debug(self, msg):
        """Logs a DEBUG message"""
        self.log(msg, level="DEBUG")

    def info(self, msg):
        """Logs an INFO message"""
        self.log(msg, level="INFO")

    def warning(self, msg):
        """Logs a WARNING message"""
        self.log(msg, level="WARNING")

    def error(self, msg):
        """Logs an ERROR message"""
        self.log(msg, level="ERROR")

        # Only print the traceback if an exception handler is being executed
        if sys.exc_info()[0] is not None:
            traceback.print_exc()

    def critical(self, msg):
        """Logs a CRITICAL message"""
        self.log(msg, level="CRITICAL")

        # Only print the traceback if an exception handler is being executed
        if sys.exc_info()[0] is not None:
            traceback.print_exc()

    def log(self, msg, level="DEBUG"):
        """Log a message

        Parameters
        ----------
        msg :
            Message to be logged.
        level : str
            Logging level."""

        # prettify
        if isinstance(msg, str):
            pass
        elif type(msg) in [dict, list]:  # TODO: should be recursive
            try:
                msg = json.dumps(msg, indent=4)
            except Exception:
                pass
        else:
            msg = pformat(msg)

        # actual log
        lines = msg.split("\n")
        for line in lines:
            logger.log(level, line)

    def welcome(self):
        """Welcome message in the terminal."""
        secure = "s" if get_env("CCAT_CORE_USE_SECURE_PROTOCOLS") in ("true", "1") else ""

        cat_host = get_env("CCAT_CORE_HOST")
        cat_port = get_env("CCAT_CORE_PORT")
        cat_address = f"http{secure}://{cat_host}:{cat_port}"

        print("\n\n")
        with open("cat/welcome.txt", "r") as f:
            print(f.read())

        left_margin = " " * 15
        print(f"\n\n{left_margin} Cat REST API:   {cat_address}/docs")
        print(f"{left_margin} Cat ADMIN:      {cat_address}/admin\n\n")

        # self.log_examples()


    def log_examples(self):
        """Log examples for the log engine."""

        for c in [self, "Hello there!", {"ready", "set", "go"}, [1, 4, "sdfsf"], {"a": 1, "b": {"c": 2}}]:
            self.debug(c)
            self.info(c)
            self.warning(c)
            self.error(c)
            self.critical(c)

        def intentional_error():
            print(42/0)

        try:
            intentional_error()
        except Exception:
            self.error("This error is just for demonstration purposes.")

__call__(msg, level='DEBUG')

Alias of self.log()

Source code in cat/log.py 
88
89
90
def __call__(self, msg, level="DEBUG"):
    """Alias of self.log()"""
    self.log(msg, level)

critical(msg)

Logs a CRITICAL message

Source code in cat/log.py 
112
113
114
115
116
117
118
def critical(self, msg):
    """Logs a CRITICAL message"""
    self.log(msg, level="CRITICAL")

    # Only print the traceback if an exception handler is being executed
    if sys.exc_info()[0] is not None:
        traceback.print_exc()

debug(msg)

Logs a DEBUG message

Source code in cat/log.py 
92
93
94
def debug(self, msg):
    """Logs a DEBUG message"""
    self.log(msg, level="DEBUG")

default_log()

Set the same debug level to all the project dependencies.

Source code in cat/log.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def default_log(self):
    """Set the same debug level to all the project dependencies.

    Returns
    -------
    """

    level = "<level>{level}:</level>"
    # time = "<green>[{time:YYYY-MM-DD HH:mm:ss.SSS}]</green>"
    # origin = "<level>{extra[original_name]}.{extra[original_class]}.{extra[original_caller]}::{extra[original_line]}</level>"
    message = "<level>{message}</level>"
    log_format = f"{level}\t{message}"

    logger.remove()
    logger.add(
        sys.stdout,
        level=self.LOG_LEVEL,
        colorize=True,
        format=log_format,
        # backtrace=True,
        # diagnose=True,
        filter=self.show_log_level,
    )

error(msg)

Logs an ERROR message

Source code in cat/log.py 
104
105
106
107
108
109
110
def error(self, msg):
    """Logs an ERROR message"""
    self.log(msg, level="ERROR")

    # Only print the traceback if an exception handler is being executed
    if sys.exc_info()[0] is not None:
        traceback.print_exc()

info(msg)

Logs an INFO message

Source code in cat/log.py 
96
97
98
def info(self, msg):
    """Logs an INFO message"""
    self.log(msg, level="INFO")

log(msg, level='DEBUG')

Log a message

Parameters:

Name Type Description Default
msg

Message to be logged.

 required
level str

Logging level.

 'DEBUG'
Source code in cat/log.py 
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def log(self, msg, level="DEBUG"):
    """Log a message

    Parameters
    ----------
    msg :
        Message to be logged.
    level : str
        Logging level."""

    # prettify
    if isinstance(msg, str):
        pass
    elif type(msg) in [dict, list]:  # TODO: should be recursive
        try:
            msg = json.dumps(msg, indent=4)
        except Exception:
            pass
    else:
        msg = pformat(msg)

    # actual log
    lines = msg.split("\n")
    for line in lines:
        logger.log(level, line)

log_examples()

Log examples for the log engine.

Source code in cat/log.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
def log_examples(self):
    """Log examples for the log engine."""

    for c in [self, "Hello there!", {"ready", "set", "go"}, [1, 4, "sdfsf"], {"a": 1, "b": {"c": 2}}]:
        self.debug(c)
        self.info(c)
        self.warning(c)
        self.error(c)
        self.critical(c)

    def intentional_error():
        print(42/0)

    try:
        intentional_error()
    except Exception:
        self.error("This error is just for demonstration purposes.")

show_log_level(record)

Allows to show stuff in the log based on the global setting.

Parameters:

Name Type Description Default
record dict
required

Returns:

Type Description
bool
Source code in cat/log.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
def show_log_level(self, record):
    """Allows to show stuff in the log based on the global setting.

    Parameters
    ----------
    record : dict

    Returns
    -------
    bool

    """
    return record["level"].no >= logger.level(self.LOG_LEVEL).no

warning(msg)

Logs a WARNING message

Source code in cat/log.py 
100
101
102
def warning(self, msg):
    """Logs a WARNING message"""
    self.log(msg, level="WARNING")

welcome()

Welcome message in the terminal.

Source code in cat/log.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def welcome(self):
    """Welcome message in the terminal."""
    secure = "s" if get_env("CCAT_CORE_USE_SECURE_PROTOCOLS") in ("true", "1") else ""

    cat_host = get_env("CCAT_CORE_HOST")
    cat_port = get_env("CCAT_CORE_PORT")
    cat_address = f"http{secure}://{cat_host}:{cat_port}"

    print("\n\n")
    with open("cat/welcome.txt", "r") as f:
        print(f.read())

    left_margin = " " * 15
    print(f"\n\n{left_margin} Cat REST API:   {cat_address}/docs")
    print(f"{left_margin} Cat ADMIN:      {cat_address}/admin\n\n")

get_log_level()

Return the global LOG level.

Source code in cat/log.py 
13
14
15
def get_log_level():
    """Return the global LOG level."""
    return get_env("CCAT_LOG_LEVEL")