`Style() + style` can return a null or a non-null style depending on what was added earlier

Đang mở
#4,263 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
68/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
cli

Hướng nghiên cứu

Start in rich/style.py with Style.add and the lru_cache-wrapped Style._add, and check how Style.eq and the _null flag interact with the cache. Run the reproduction script from the issue in both argument orders and compare the truthiness of Style() + Style() and Style() + not_null. Done when both orders give the same result, with the null shortcuts handled before the cached call and a regression test added.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Hi! I hit this while writing generated tests against Rich. Adding two styles can give a different result depending on which other sums happened earlier in the process. It needs a style that compares equal to Style() but isn't null, which several methods return; for example update_link(None) on a style that only had a link (this is what Text.from_ansi does when an OSC 8 link ends):

import sys
from rich.style import Style

not_null = Style(link="http://x").update_link(None)
if sys.argv[1] == "null-first":
    print("Style() + Style():", bool(Style() + Style()))
    print("Style() + not_null:", bool(Style() + not_null))
else:
    print("Style() + not_null:", bool(Style() + not_null))
    print("Style() + Style():", bool(Style() + Style()))

On Rich 15.0.0 and on main (3a109cc):

$ python add.py null-first
Style() + Style(): False
Style() + not_null: False
$ python add.py other
Style() + not_null: True
Style() + Style(): True

So Style() + Style() is truthy if Style() + not_null was computed first, and Style() + not_null is falsy the other way round.

Style._add is wrapped in lru_cache, which finds entries by equality, and Style.__eq__ compares the hash of colors, attributes, link and meta, which leaves out _null. The null shortcuts at the top of _add (return self / return style) are inside the cached function, so whichever of two equal operands was seen first is returned for both.

I haven't found a difference in what Rich prints, since a non-null style with nothing set renders no codes. It does matter to code that tests a style's truthiness (if style:) to decide whether to apply or skip it, where the result then depends on what was rendered before.

A fix is to do the null shortcuts in __add__, before the cached call, so the cache only sees real combinations. I'm happy to open a PR.

Python 3.13, macOS.

Ngôn ngữ chính
Python
Star
57.8k
Fork
2.6k
Merge trung bình
20 phút
Pull request đã merge (30 ngày)
3

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Textualize/rich

Tất cả issue của Textualize/rich

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.