`Matcher.highlight` highlights the wrong characters with markup or `İ`, and can raise `IndexError`
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- Half a day
- Newbie friendliness
- 55/100
Research direction
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'.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Python
- Stars
- 37.7k
- Forks
- 1.5k
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Textualize/textual
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Textualize/textual#6790 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Textualize/textual#6789 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Textualize/textual#6787 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Textualize/textual#6782 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Textualize/textual#6778 · 1 comment ·
All issues in Textualize/textual
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
GoogleCloudPlatform/professional-services-data-validator#1899 ·
Maintainers usually reply within 4 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mohanraj00/entelos#200 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
sweep
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
bketelsen/truenas-mcp#77 ·
Maintainers usually reply within 1 day
-
Console writes URL credentials to the local log, though AGENTS.md says secrets never reach diskOpen
Difficulty 1/5 Under an hour Newbie friendliness 86/100
sandbox-quantum/switch#2163 ·
Maintainers usually reply within 1 day