[BUG] Colors break if there's an `<` in the repr #3024

MicaelJarniac · 2023-07-05T18:40:49Z

I've checked docs and closed issues for possible solutions.
I can't find my issue in the FAQ.

Describe the bug

If there's a < (less than) char in the repr of an object, the colors of other components that use <> break after it.

from rich.pretty import pprint


class A:
    def __init__(self, a=None):
        self.a = a

    def __repr__(self):
        return f"A(a={self.a!r}, b=<B>)"


pprint(A())
pprint(A("<"))
pprint(A(">"))
pprint(A("x"))

For example, if I have a dataclass or an attrs class with more than one enum attribute, the color of subsequent ones break when pretty printing.

from dataclasses import dataclass
from enum import Enum, auto

import attrs
from rich.pretty import pprint


class MyEnum(Enum):
    ONE = auto()


@attrs.define  # or @dataclass
class MyClass:
    first: MyEnum | None = None
    second: MyEnum | None = None


pprint(MyClass())
pprint(MyClass(first=MyEnum.ONE))
pprint(MyClass(second=MyEnum.ONE))
pprint(MyClass(first=MyEnum.ONE, second=MyEnum.ONE))

On the terminal:

On Jupyter:

Platform

Click to expand

Operating System: Manjaro Linux
KDE Plasma Version: 5.27.5
KDE Frameworks Version: 5.106.0
Qt Version: 5.15.9
Kernel Version: 6.1.31-2-MANJARO (64-bit)
Graphics Platform: Wayland
Processors: 16 × AMD Ryzen 7 5800H with Radeon Graphics
Memory: 13.5 GiB of RAM
Graphics Processor: AMD Radeon Graphics
Manufacturer: LENOVO
Product Name: 82MJ
System Version: IdeaPad Gaming 3 15ACH6

Shell: Zsh with Zsh for Humans and Tmux
Terminal: VS Code's built-in terminal

If you're using Rich in a terminal:

python -m rich.diagnose
pip freeze | grep rich

`python -m rich.diagnose`

❯ python -m rich.diagnose
╭────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── <class 'rich.console.Console'> ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ A high level console interface.                                                                                                                                                                                                                                            │
│                                                                                                                                                                                                                                                                            │
│ ╭────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
│ │ <console width=271 ColorSystem.TRUECOLOR>                                                                                                                                                                                                                              │ │
│ ╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ │
│                                                                                                                                                                                                                                                                            │
│     color_system = 'truecolor'                                                                                                                                                                                                                                             │
│         encoding = 'utf-8'                                                                                                                                                                                                                                                 │
│             file = <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>                                                                                                                                                                                           │
│           height = 18                                                                                                                                                                                                                                                      │
│    is_alt_screen = False                                                                                                                                                                                                                                                   │
│ is_dumb_terminal = False                                                                                                                                                                                                                                                   │
│   is_interactive = True                                                                                                                                                                                                                                                    │
│       is_jupyter = False                                                                                                                                                                                                                                                   │
│      is_terminal = True                                                                                                                                                                                                                                                    │
│   legacy_windows = False                                                                                                                                                                                                                                                   │
│         no_color = False                                                                                                                                                                                                                                                   │
│          options = ConsoleOptions(size=ConsoleDimensions(width=271, height=18), legacy_windows=False, min_width=1, max_width=271, is_terminal=True, encoding='utf-8', max_height=18, justify=None, overflow=None, no_wrap=False, highlight=None, markup=None, height=None) │
│            quiet = False                                                                                                                                                                                                                                                   │
│           record = False                                                                                                                                                                                                                                                   │
│         safe_box = True                                                                                                                                                                                                                                                    │
│             size = ConsoleDimensions(width=271, height=18)                                                                                                                                                                                                                 │
│        soft_wrap = False                                                                                                                                                                                                                                                   │
│           stderr = False                                                                                                                                                                                                                                                   │
│            style = None                                                                                                                                                                                                                                                    │
│         tab_size = 8                                                                                                                                                                                                                                                       │
│            width = 271                                                                                                                                                                                                                                                     │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─── <class 'rich._windows.WindowsConsoleFeatures'> ────╮
│ Windows features available.                           │
│                                                       │
│ ╭───────────────────────────────────────────────────╮ │
│ │ WindowsConsoleFeatures(vt=False, truecolor=False) │ │
│ ╰───────────────────────────────────────────────────╯ │
│                                                       │
│ truecolor = False                                     │
│        vt = False                                     │
╰───────────────────────────────────────────────────────╯
╭───────────────────────────────────────────────────────────────────────────────────────────────────────────────── Environment Variables ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ {'TERM': 'tmux-256color', 'COLORTERM': 'truecolor', 'CLICOLOR': None, 'NO_COLOR': None, 'TERM_PROGRAM': 'tmux', 'COLUMNS': None, 'LINES': None, 'JUPYTER_COLUMNS': None, 'JUPYTER_LINES': None, 'JPY_PARENT_PID': None, 'VSCODE_VERBOSE_LOGGING': None} │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
platform="Linux"

❯ pip freeze | grep rich
rich==13.4.2
❯ pip freeze | grep attrs
attrs==23.1.0

If you're using Rich in a Jupyter Notebook, run the following snippet in a cell
and paste the output in your bug report.

from rich.diagnose import report
report()

Report

╭────────────────────── <class 'rich.console.Console'> ──────────────────────╮
│ A high level console interface.                                            │
│                                                                            │
│ ╭────────────────────────────────────────────────────────────────────────╮ │
│ │ <console width=115 ColorSystem.TRUECOLOR>                              │ │
│ ╰────────────────────────────────────────────────────────────────────────╯ │
│                                                                            │
│     color_system = 'truecolor'                                             │
│         encoding = 'utf-8'                                                 │
│             file = <ipykernel.iostream.OutStream object at 0x7f5abf9fc3d0> │
│           height = 100                                                     │
│    is_alt_screen = False                                                   │
│ is_dumb_terminal = False                                                   │
│   is_interactive = False                                                   │
│       is_jupyter = True                                                    │
│      is_terminal = False                                                   │
│   legacy_windows = False                                                   │
│         no_color = False                                                   │
│          options = ConsoleOptions(                                         │
│                        size=ConsoleDimensions(width=115, height=100),      │
│                        legacy_windows=False,                               │
│                        min_width=1,                                        │
│                        max_width=115,                                      │
│                        is_terminal=False,                                  │
│                        encoding='utf-8',                                   │
│                        max_height=100,                                     │
│                        justify=None,                                       │
│                        overflow=None,                                      │
│                        no_wrap=False,                                      │
│                        highlight=None,                                     │
│                        markup=None,                                        │
│                        height=None                                         │
│                    )                                                       │
│            quiet = False                                                   │
│           record = False                                                   │
│         safe_box = True                                                    │
│             size = ConsoleDimensions(width=115, height=100)                │
│        soft_wrap = False                                                   │
│           stderr = False                                                   │
│            style = None                                                    │
│         tab_size = 8                                                       │
│            width = 115                                                     │
╰────────────────────────────────────────────────────────────────────────────╯
╭─── <class 'rich._windows.WindowsConsoleFeatures'> ────╮
│ Windows features available.                           │
│                                                       │
│ ╭───────────────────────────────────────────────────╮ │
│ │ WindowsConsoleFeatures(vt=False, truecolor=False) │ │
│ ╰───────────────────────────────────────────────────╯ │
│                                                       │
│ truecolor = False                                     │
│        vt = False                                     │
╰───────────────────────────────────────────────────────╯
╭────── Environment Variables ───────╮
│ {                                  │
│     'TERM': 'xterm-color',         │
│     'COLORTERM': 'truecolor',      │
│     'CLICOLOR': '1',               │
│     'NO_COLOR': None,              │
│     'TERM_PROGRAM': 'tmux',        │
│     'COLUMNS': None,               │
│     'LINES': None,                 │
│     'JUPYTER_COLUMNS': None,       │
│     'JUPYTER_LINES': None,         │
│     'JPY_PARENT_PID': None,        │
│     'VSCODE_VERBOSE_LOGGING': None │
│ }                                  │
╰────────────────────────────────────╯
platform="Linux"

The text was updated successfully, but these errors were encountered:

github-actions · 2023-07-05T18:41:07Z

Thank you for your issue. Give us a little time to review it.

PS. You might want to check the FAQ if you haven't done so already.

This is an automated reply, generated by FAQtory

trag1c · 2023-07-05T20:29:38Z

Same thing happens on macOS Ventura 13.4.1 with iTerm2. Doesn't seem like it's platform-dependent but @MicaelJarniac asked me to check :D

MicaelJarniac · 2023-07-05T23:04:39Z

I've simplified the example a lot, and came to this:

from rich.pretty import pprint


class A:
    def __init__(self, a=None):
        self.a = a

    def __repr__(self) -> str:
        return f"A(a={repr(self.a)}, b=<B>)"


pprint(A())
pprint(A("<"))
pprint(A(">"))
pprint(A("x"))

MicaelJarniac · 2023-07-05T23:15:48Z

I suspect the bug is in this line:

rich/rich/highlighter.py

Line 85 in aca9467

    
           r"(?P<tag_start><)(?P<tag_name>[-\w.:|]*)(?P<tag_contents>[\w\W]*)(?P<tag_end>>)",

Closes Textualize#3024 Updated regex pattern to improve color formatting. The `tag_contents` group was updated to exclude `<` character (`[^<]`), preventing the matching of tags that contain other tags inside. Additionally, a `*?` was used for a non-greedy match, making the group match as little as possible, thus avoiding overreaching matches.

MicaelJarniac · 2023-07-11T14:20:11Z

from rich.pretty import pprint

class A:
    def __init__(self, a=None):
        self.a = a

    def __repr__(self) -> str:
        return f"A(a={self.a!r}, b=1.23, c=None, d=(1, 2))"

pprint([A("<"), A(">")])

MicaelJarniac added the Needs triage label Jul 5, 2023

MicaelJarniac changed the title ~~[BUG] Colors break with attrs class with more than one enum~~ [BUG] Colors break with dataclass or attrs class with more than one enum Jul 5, 2023

MicaelJarniac changed the title ~~[BUG] Colors break with dataclass or attrs class with more than one enum~~ [BUG] Colors break if there's an < in the repr Jul 5, 2023

MicaelJarniac mentioned this issue Jul 5, 2023

Fix tag RegEx #3025

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUG] Colors break if there's an `<` in the repr #3024

[BUG] Colors break if there's an `<` in the repr #3024

[BUG] Colors break if there's an < in the repr #3024

[BUG] Colors break if there's an < in the repr #3024

Comments

[BUG] Colors break if there's an `<` in the repr #3024

[BUG] Colors break if there's an `<` in the repr #3024