`Matcher.highlight` highlights the wrong characters with markup or `İ`, and can raise `IndexError`

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

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

評価

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

調査の方向性

Start in src/textual/fuzzy.py, in Matcher.highlight, where the candidate is lowercased and offsets are used to index the original text, and where the markup is parsed but the query is matched against the raw string. Run the two reproductions from the issue to see the wrong span and the IndexError. Done when offsets map back to the displayed text for both the İ case and the markup case, and the palette shows both commands for 'ir'.

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

説明

Hi! I hit this while writing generated tests against Textual's widgets.

Matcher.highlight() styles offsets that don't index the text it displays, in two ways.

1. Characters that lowercase to two code points. "İ".lower() is "i̇" (i plus U+0307), so in a case-insensitive match the offsets index the lowered candidate, which is one longer than the original. The highlight lands one character late, and on the last character it raises IndexError:

from textual.fuzzy import Matcher

print(Matcher("z").highlight("İzmir").spans)
print(Matcher("r").highlight("İzmir"))

Output (the same on 8.2.7 and on main at 5e5b7ef):

[Span(2, 3, style=Style(reverse=True))]
Traceback (most recent call last):
  File "repro.py", line 4, in <module>
    print(Matcher("r").highlight("İzmir"))
  File ".../textual/fuzzy.py", line 217, in highlight
    if not candidate[offset].isspace():
IndexError: string index out of range

The first line highlights m rather than z.

In the command palette the IndexError is raised inside the provider's search task, so it isn't reported; the provider's remaining commands just disappear. With these two commands, typing ir shows neither:

import asyncio
from textual.app import App, SystemCommand
from textual.command import CommandList

class PaletteApp(App):
    def get_system_commands(self, screen):
        yield SystemCommand("Weather in İzmir", "Turkey", self.bell)
        yield SystemCommand("Weather in Izmir", "Turkey, ASCII spelling", self.bell)

async def main() -> None:
    app = PaletteApp()
    async with app.run_test() as pilot:
        await pilot.press("ctrl+p")
        await pilot.pause()
        await pilot.press("i", "r")
        await pilot.pause(0.5)
        command_list = app.screen.query_one(CommandList)
        print("commands shown for 'ir':", [str(option.prompt).splitlines()[0] for option in command_list.options])

asyncio.run(main())
commands shown for 'ir': []

With the fix below it prints ['Weather in İzmir', 'Weather in Izmir'].

2. Candidates containing markup. highlight() parses the candidate as markup, but matches the query against the raw string, so the offsets include the tags:

from textual.fuzzy import Matcher

content = Matcher("old").highlight("[b]Bold[/b] text")
print(repr(content.plain))
for span in content.spans:
    print(span, repr(content.plain[span.start:span.end]))

Output (the same on 8.2.7 and on main):

'Bold text'
Span(0, 4, style='b') 'Bold'
Span(4, 5, style=Style(reverse=True)) ' '
Span(5, 6, style=Style(reverse=True)) 't'
Span(6, 7, style=Style(reverse=True)) 'e'

I'd expect o, l and d of "Bold" to be highlighted.

Textual 8.2.7 and main (5e5b7ef), Python 3.13, macOS.

主要言語
Python
スター
37.7k
フォーク
1.5k
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

Textualize/textual のほかの issue

Textualize/textual の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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