Skip to content

present.console

Console

Source code in /home/runner/work/arc/arc/arc/present/console.py 
 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
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
class Console:
    def __init__(
        self,
        default_print_stream: t.IO[str] | None = None,
        default_log_stream: t.IO[str] | None = None,
        show_icons: bool = True,
        color_output: bool = True,
        indent: str = "  ",
    ) -> None:
        self.default_print_stream = default_print_stream or sys.stdout
        self.default_log_stream = default_log_stream or sys.stderr
        self.show_icons = show_icons
        self.color_output = color_output
        self._indent = indent
        self._indent_count = 0
        self.icons: dict[str, str] = {
            "ok": "✓",
            "error": "✗",
            "act": "",
            "warn": "🚧",
            "subtle": "",
            "snake": "🐍",
        }

    def print(
        self,
        *values: object,
        sep: str | None = None,
        end: str | None = None,
        file: t.IO[str] | None = None,
        flush: bool = False,
    ) -> None:
        """A wrapper around `print()` that handles removing escape
        codes when the output is not a TTY"""
        file = file or self.default_print_stream

        if (file and not file.isatty()) or not self.color_output:
            values = tuple(Ansi.clean(str(v)) for v in values)

        if self._indent_count and values:
            first, *rest = values
            first = f"{self._indent * self._indent_count}{first}"
            values = (first, *rest)

        builtins.print(*values, sep=sep, end=end, file=file, flush=flush)

    def info(
        self,
        *values: object,
        sep: str | None = None,
        end: str | None = None,
        flush: bool = False,
    ) -> None:
        """Wrapper around `print()` that emits to the
        `Console.log` stream instead of the `Console.print` stream"""
        self.print(*values, sep=sep, end=end, file=self.default_log_stream, flush=flush)

    def log(
        self,
        /,
        first: object = None,
        *values: object,
        sep: str | None = None,
        end: str | None = None,
        file: t.IO[str] | None = None,
        flush: bool = False,
    ) -> None:
        """Useful for simple logging. Writes to stderr
        instead of stdout and includes a timestamps"""
        file = file or self.default_log_stream
        time = datetime.datetime.now().strftime("%H:%M:%S")
        first = first or ""
        first = colorize(f"[{time}] ", fg.GREY) + str(first)
        self.print(first, *values, sep=sep, end=end, file=file, flush=flush)

    @contextmanager
    def indent(self) -> t.Generator[None, None, None]:
        """Context manager that will indent
        any prints done within it's block"""
        try:
            self._indent_count += 1
            yield
        finally:
            self._indent_count -= 1

    def _decorate(
        self,
        *values: object,
        color: str = "",
        icon: str = "",
        **kwargs: t.Any,
    ) -> None:
        if len(values) == 0:
            self.print(**kwargs)
            return

        first = values[0]
        rest = values[1:-1]
        last = values[-1]

        if self.show_icons and icon:
            first = f"{icon} {first}"

        if self.color_output and color:
            if len(values) > 1:
                first = f"{color}{first}"
                last = f"{last}{fx.CLEAR}"
            else:
                first = f"{color}{first}{fx.CLEAR}"

        objects = [first, *rest]
        if len(values) > 1:
            objects.append(last)

        self.print(
            *objects,
            **kwargs,
        )

    def rule(self, string: str = "", width: int = 80, **kwargs: t.Any) -> None:
        """Display a horizontal rule to the user"""
        self.print(string.center(width, "─"), **kwargs)

    def ok(self, *values: object, **kwargs: t.Any) -> None:
        """Display a successful message to the user"""
        self._decorate(*values, color=fg.GREEN, icon=self.icons["ok"], **kwargs)

    def err(self, *values: object, **kwargs: t.Any) -> None:
        """Display an unsuccessful message to the user"""
        self._decorate(*values, color=fg.RED, icon=self.icons["error"], **kwargs)

    def act(self, *values: object, **kwargs: t.Any) -> None:
        """Display an action message to the user"""
        self._decorate(*values, color=fg.BLUE, icon=self.icons["act"], **kwargs)

    def warn(self, *values: object, **kwargs: t.Any) -> None:
        """Display a warning message to the user"""
        self._decorate(*values, color=fg.YELLOW, icon=self.icons["warn"], **kwargs)

    def subtle(self, *values: object, **kwargs: t.Any) -> None:
        """Display a subtle (light grey) message to the user"""
        self._decorate(*values, color=fg.GREY, icon=self.icons["subtle"], **kwargs)

    def snake(self, *values: object, **kwargs: t.Any) -> None:
        """Display a Pythonic message to the user"""
        self._decorate(*values, icon=self.icons["snake"], **kwargs)

    @classmethod
    def __depends__(cls, ctx: Context) -> Console:
        return cls()

act(*values, **kwargs)

Display an action message to the user

Source code in /home/runner/work/arc/arc/arc/present/console.py 
148
149
150
def act(self, *values: object, **kwargs: t.Any) -> None:
    """Display an action message to the user"""
    self._decorate(*values, color=fg.BLUE, icon=self.icons["act"], **kwargs)

err(*values, **kwargs)

Display an unsuccessful message to the user

Source code in /home/runner/work/arc/arc/arc/present/console.py 
144
145
146
def err(self, *values: object, **kwargs: t.Any) -> None:
    """Display an unsuccessful message to the user"""
    self._decorate(*values, color=fg.RED, icon=self.icons["error"], **kwargs)

indent()

Context manager that will indent any prints done within it's block

Source code in /home/runner/work/arc/arc/arc/present/console.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
@contextmanager
def indent(self) -> t.Generator[None, None, None]:
    """Context manager that will indent
    any prints done within it's block"""
    try:
        self._indent_count += 1
        yield
    finally:
        self._indent_count -= 1

info(*values, sep=None, end=None, flush=False)

Wrapper around print() that emits to the Console.log stream instead of the Console.print stream

Source code in /home/runner/work/arc/arc/arc/present/console.py 
63
64
65
66
67
68
69
70
71
72
def info(
    self,
    *values: object,
    sep: str | None = None,
    end: str | None = None,
    flush: bool = False,
) -> None:
    """Wrapper around `print()` that emits to the
    `Console.log` stream instead of the `Console.print` stream"""
    self.print(*values, sep=sep, end=end, file=self.default_log_stream, flush=flush)

log(first=None, *values, sep=None, end=None, file=None, flush=False)

Useful for simple logging. Writes to stderr instead of stdout and includes a timestamps

Source code in /home/runner/work/arc/arc/arc/present/console.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def log(
    self,
    /,
    first: object = None,
    *values: object,
    sep: str | None = None,
    end: str | None = None,
    file: t.IO[str] | None = None,
    flush: bool = False,
) -> None:
    """Useful for simple logging. Writes to stderr
    instead of stdout and includes a timestamps"""
    file = file or self.default_log_stream
    time = datetime.datetime.now().strftime("%H:%M:%S")
    first = first or ""
    first = colorize(f"[{time}] ", fg.GREY) + str(first)
    self.print(first, *values, sep=sep, end=end, file=file, flush=flush)

ok(*values, **kwargs)

Display a successful message to the user

Source code in /home/runner/work/arc/arc/arc/present/console.py 
140
141
142
def ok(self, *values: object, **kwargs: t.Any) -> None:
    """Display a successful message to the user"""
    self._decorate(*values, color=fg.GREEN, icon=self.icons["ok"], **kwargs)

print(*values, sep=None, end=None, file=None, flush=False)

A wrapper around print() that handles removing escape codes when the output is not a TTY

Source code in /home/runner/work/arc/arc/arc/present/console.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def print(
    self,
    *values: object,
    sep: str | None = None,
    end: str | None = None,
    file: t.IO[str] | None = None,
    flush: bool = False,
) -> None:
    """A wrapper around `print()` that handles removing escape
    codes when the output is not a TTY"""
    file = file or self.default_print_stream

    if (file and not file.isatty()) or not self.color_output:
        values = tuple(Ansi.clean(str(v)) for v in values)

    if self._indent_count and values:
        first, *rest = values
        first = f"{self._indent * self._indent_count}{first}"
        values = (first, *rest)

    builtins.print(*values, sep=sep, end=end, file=file, flush=flush)

rule(string='', width=80, **kwargs)

Display a horizontal rule to the user

Source code in /home/runner/work/arc/arc/arc/present/console.py 
136
137
138
def rule(self, string: str = "", width: int = 80, **kwargs: t.Any) -> None:
    """Display a horizontal rule to the user"""
    self.print(string.center(width, "─"), **kwargs)

snake(*values, **kwargs)

Display a Pythonic message to the user

Source code in /home/runner/work/arc/arc/arc/present/console.py 
160
161
162
def snake(self, *values: object, **kwargs: t.Any) -> None:
    """Display a Pythonic message to the user"""
    self._decorate(*values, icon=self.icons["snake"], **kwargs)

subtle(*values, **kwargs)

Display a subtle (light grey) message to the user

Source code in /home/runner/work/arc/arc/arc/present/console.py 
156
157
158
def subtle(self, *values: object, **kwargs: t.Any) -> None:
    """Display a subtle (light grey) message to the user"""
    self._decorate(*values, color=fg.GREY, icon=self.icons["subtle"], **kwargs)

warn(*values, **kwargs)

Display a warning message to the user

Source code in /home/runner/work/arc/arc/arc/present/console.py 
152
153
154
def warn(self, *values: object, **kwargs: t.Any) -> None:
    """Display a warning message to the user"""
    self._decorate(*values, color=fg.YELLOW, icon=self.icons["warn"], **kwargs)