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

Abierto
#6,774 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
Medio día
Aptitud para principiantes
55/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
cli

Línea de trabajo

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'.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
37.7k
Forks
1.5k
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Textualize/textual

Todos los issues de Textualize/textual

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.