Skip to content

ezpz.log.console

src/ezpz/logging/console.py

Module that helps integrating with rich library.

Console

Bases: Console

Extends rich Console class.

Source code in src/ezpz/log/console.py 
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
class Console(rich_console.Console):
    """Extends rich Console class."""

    def __init__(self, *args: str, redirect: bool = True, **kwargs: Any) -> None:
        """
        enrich console does soft-wrapping by default and this diverge from
        original rich console which does not, creating hard-wraps instead.
        """
        self.redirect = redirect

        if "soft_wrap" not in kwargs:
            kwargs["soft_wrap"] = True

        if "theme" not in kwargs:
            kwargs["theme"] = get_theme()

        if "markup" not in kwargs:
            kwargs["markup"] = True

        if "width" not in kwargs:
            kwargs["width"] = 55510

        # Unless user already mentioning terminal preference, we use our
        # heuristic to make an informed decision.
        if "force_terminal" not in kwargs:
            kwargs["force_terminal"] = should_do_markup(
                stream=kwargs.get("file", sys.stdout)
            )
        if "force_jupyter" not in kwargs:
            kwargs["force_jupyter"] = is_interactive()

        super().__init__(*args, **kwargs)
        self.extended = True

        if self.redirect:
            if not hasattr(sys.stdout, "rich_proxied_file"):
                sys.stdout = FileProxy(self, sys.stdout)  # type: ignore
            if not hasattr(sys.stderr, "rich_proxied_file"):
                sys.stderr = FileProxy(self, sys.stderr)  # type: ignore

    # https://github.com/python/mypy/issues/4441
    def print(self, *args, **kwargs) -> None:  # type: ignore
        """Print override that respects user soft_wrap preference."""
        # Currently rich is unable to render ANSI escapes with print so if
        # we detect their presence, we decode them.
        # https://github.com/willmcgugan/rich/discussions/404
        if args and isinstance(args[0], str) and "\033" in args[0]:
            text = format(*args) + "\n"
            decoder = AnsiDecoder()
            args = list(decoder.decode(text))  # type: ignore
        super().print(*args, **kwargs)

__init__(*args, redirect=True, **kwargs)

enrich console does soft-wrapping by default and this diverge from original rich console which does not, creating hard-wraps instead.

Source code in src/ezpz/log/console.py 
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
def __init__(self, *args: str, redirect: bool = True, **kwargs: Any) -> None:
    """
    enrich console does soft-wrapping by default and this diverge from
    original rich console which does not, creating hard-wraps instead.
    """
    self.redirect = redirect

    if "soft_wrap" not in kwargs:
        kwargs["soft_wrap"] = True

    if "theme" not in kwargs:
        kwargs["theme"] = get_theme()

    if "markup" not in kwargs:
        kwargs["markup"] = True

    if "width" not in kwargs:
        kwargs["width"] = 55510

    # Unless user already mentioning terminal preference, we use our
    # heuristic to make an informed decision.
    if "force_terminal" not in kwargs:
        kwargs["force_terminal"] = should_do_markup(
            stream=kwargs.get("file", sys.stdout)
        )
    if "force_jupyter" not in kwargs:
        kwargs["force_jupyter"] = is_interactive()

    super().__init__(*args, **kwargs)
    self.extended = True

    if self.redirect:
        if not hasattr(sys.stdout, "rich_proxied_file"):
            sys.stdout = FileProxy(self, sys.stdout)  # type: ignore
        if not hasattr(sys.stderr, "rich_proxied_file"):
            sys.stderr = FileProxy(self, sys.stderr)  # type: ignore

print(*args, **kwargs)

Print override that respects user soft_wrap preference.

Source code in src/ezpz/log/console.py 
86
87
88
89
90
91
92
93
94
95
def print(self, *args, **kwargs) -> None:  # type: ignore
    """Print override that respects user soft_wrap preference."""
    # Currently rich is unable to render ANSI escapes with print so if
    # we detect their presence, we decode them.
    # https://github.com/willmcgugan/rich/discussions/404
    if args and isinstance(args[0], str) and "\033" in args[0]:
        text = format(*args) + "\n"
        decoder = AnsiDecoder()
        args = list(decoder.decode(text))  # type: ignore
    super().print(*args, **kwargs)

should_do_markup(stream=sys.stdout)

Decide about use of ANSI colors.

Source code in src/ezpz/log/console.py 
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
def should_do_markup(stream: TextIO = sys.stdout) -> bool:
    """Decide about use of ANSI colors."""
    py_colors = None

    # https://xkcd.com/927/
    for env_var in [
        "PY_COLORS",
        "CLICOLOR",
        "FORCE_COLOR",
        "ANSIBLE_FORCE_COLOR",
    ]:
        value = os.environ.get(env_var, None)
        if value is not None:
            py_colors = to_bool(value)
            break

    # If deliverately disabled colors
    if os.environ.get("NO_COLOR", None):
        return False

    # User configuration requested colors
    if py_colors is not None:
        return to_bool(py_colors)

    term = os.environ.get("TERM", "")
    if "xterm" in term:
        return True

    if term.lower() == "dumb":
        return False

    # Use tty detection logic as last resort.
    # Because there are numerous factors that can make isatty return a
    # misleading value, including:
    # - stdin.isatty() is the only one returning true, even on a real terminal
    # - stderr returning false if user uses an error stream coloring solution
    return stream.isatty()

to_bool(value)

Return a bool for the arg.

Source code in src/ezpz/log/console.py 
 99
100
101
102
103
104
105
106
107
def to_bool(value: Any) -> bool:
    """Return a bool for the arg."""
    if value is None or isinstance(value, bool):
        return bool(value)
    if isinstance(value, str):
        value = value.lower()
    if value in ("yes", "on", "1", "true", 1):
        return True
    return False