Skip to content

console

Console class for printing messages to the console.

Configure the console to print error and debug messages.

Usage

Create a Console object and call the appropriate method to print messages.

Console

Source code in src/ephys_link/utils/console.py 
 16
 17
 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
@final
class Console:
    def __init__(self, *, enable_debug: bool) -> None:
        """Initialize console properties.

        Args:
            enable_debug: Enable debug mode.
        """
        # Repeat message fields.
        self._last_message = (0, "", "")
        self._repeat_counter = 0

        # Config logger.
        basicConfig(
            format="%(message)s",
            datefmt="[%I:%M:%S %p]",
            handlers=[RichHandler(rich_tracebacks=True, markup=True)],
        )
        self._log = getLogger("rich")
        self._log.setLevel(DEBUG if enable_debug else INFO)

        # Install Rich traceback.
        _ = install()

    def debug_print(self, label: str, msg: str) -> None:
        """Print a debug message to the console.

        Args:
            label: Label for the debug message.
            msg: Debug message to print.
        """
        self._repeatable_log(DEBUG, f"[b green]{label}", f"[green]{msg}")

    def info_print(self, label: str, msg: str) -> None:
        """Print info to console.

        Args:
            label: Label for the message.
            msg: Message to print.
        """
        self._repeatable_log(INFO, f"[b blue]{label}", msg)

    def error_print(self, label: str, msg: str) -> None:
        """Print an error message to the console.

        Args:
            label: Label for the error message.
            msg: Error message to print.
        """
        self._repeatable_log(ERROR, f"[b red]{label}", f"[red]{msg}")

    def critical_print(self, msg: str) -> None:
        """Print a critical message to the console.

        Args:
            msg: Critical message to print.
        """
        self._log.critical(f"[b i red]{msg}")

    @staticmethod
    def pretty_exception(exception: Exception) -> str:
        """Pretty print an exception.

        Args:
            exception: Exception to pretty print.

        Returns:
            Pretty printed exception.
        """
        return f"{type(exception).__name__}: {exception}"

    def exception_error_print(self, label: str, exception: Exception) -> None:
        """Print an error message with exception details to the console.

        Args:
            label: Label for the error message.
            exception: Exception to print.
        """
        self._log.exception(f"[b magenta]{label}:[/] [magenta]{Console.pretty_exception(exception)}")

    # Helper methods.
    def _repeatable_log(self, log_type: int, label: str, message: str) -> None:
        """Add a row to the output table.

        Args:
            log_type: Type of log.
            label: Label for the message.
            message: Message.
        """

        # Compute if this is a repeated message.
        message_set = (log_type, label, message)
        if message_set == self._last_message:
            # Handle repeat.
            self._repeat_counter += 1

            # Add an ellipsis row for first repeat.
            if self._repeat_counter == 1:
                self._log.log(log_type, "...")
        else:
            # Handle novel message.
            if self._repeat_counter > 0:
                # Complete previous repeat.
                self._log.log(
                    self._last_message[0],
                    f"{self._last_message[1]}:[/] {self._last_message[2]}[/] x {self._repeat_counter}",
                )
                self._repeat_counter = 0

            # Log new message.
            self._log.log(log_type, f"{label}:[/] {message}")
            self._last_message = message_set

__init__(*, enable_debug)

Initialize console properties.

Parameters:

Name Type Description Default
enable_debug bool

Enable debug mode.

 required
Source code in src/ephys_link/utils/console.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def __init__(self, *, enable_debug: bool) -> None:
    """Initialize console properties.

    Args:
        enable_debug: Enable debug mode.
    """
    # Repeat message fields.
    self._last_message = (0, "", "")
    self._repeat_counter = 0

    # Config logger.
    basicConfig(
        format="%(message)s",
        datefmt="[%I:%M:%S %p]",
        handlers=[RichHandler(rich_tracebacks=True, markup=True)],
    )
    self._log = getLogger("rich")
    self._log.setLevel(DEBUG if enable_debug else INFO)

    # Install Rich traceback.
    _ = install()

critical_print(msg)

Print a critical message to the console.

Parameters:

Name Type Description Default
msg str

Critical message to print.

 required
Source code in src/ephys_link/utils/console.py 
67
68
69
70
71
72
73
def critical_print(self, msg: str) -> None:
    """Print a critical message to the console.

    Args:
        msg: Critical message to print.
    """
    self._log.critical(f"[b i red]{msg}")

debug_print(label, msg)

Print a debug message to the console.

Parameters:

Name Type Description Default
label str

Label for the debug message.

 required
msg str

Debug message to print.

 required
Source code in src/ephys_link/utils/console.py 
40
41
42
43
44
45
46
47
def debug_print(self, label: str, msg: str) -> None:
    """Print a debug message to the console.

    Args:
        label: Label for the debug message.
        msg: Debug message to print.
    """
    self._repeatable_log(DEBUG, f"[b green]{label}", f"[green]{msg}")

error_print(label, msg)

Print an error message to the console.

Parameters:

Name Type Description Default
label str

Label for the error message.

 required
msg str

Error message to print.

 required
Source code in src/ephys_link/utils/console.py 
58
59
60
61
62
63
64
65
def error_print(self, label: str, msg: str) -> None:
    """Print an error message to the console.

    Args:
        label: Label for the error message.
        msg: Error message to print.
    """
    self._repeatable_log(ERROR, f"[b red]{label}", f"[red]{msg}")

exception_error_print(label, exception)

Print an error message with exception details to the console.

Parameters:

Name Type Description Default
label str

Label for the error message.

 required
exception Exception

Exception to print.

 required
Source code in src/ephys_link/utils/console.py 
87
88
89
90
91
92
93
94
def exception_error_print(self, label: str, exception: Exception) -> None:
    """Print an error message with exception details to the console.

    Args:
        label: Label for the error message.
        exception: Exception to print.
    """
    self._log.exception(f"[b magenta]{label}:[/] [magenta]{Console.pretty_exception(exception)}")

info_print(label, msg)

Print info to console.

Parameters:

Name Type Description Default
label str

Label for the message.

 required
msg str

Message to print.

 required
Source code in src/ephys_link/utils/console.py 
49
50
51
52
53
54
55
56
def info_print(self, label: str, msg: str) -> None:
    """Print info to console.

    Args:
        label: Label for the message.
        msg: Message to print.
    """
    self._repeatable_log(INFO, f"[b blue]{label}", msg)

pretty_exception(exception) staticmethod

Pretty print an exception.

Parameters:

Name Type Description Default
exception Exception

Exception to pretty print.

 required

Returns:

Type Description
str

Pretty printed exception.
Source code in src/ephys_link/utils/console.py 
75
76
77
78
79
80
81
82
83
84
85
@staticmethod
def pretty_exception(exception: Exception) -> str:
    """Pretty print an exception.

    Args:
        exception: Exception to pretty print.

    Returns:
        Pretty printed exception.
    """
    return f"{type(exception).__name__}: {exception}"