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

オープン
#4,263 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
半日
初心者へのやさしさ
68/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
cli

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
57.8k
フォーク
2.6k
平均マージ
20分
マージ済み PR(30日)
3

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Textualize/rich のほかの issue

Textualize/rich の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。