Inefficient regex in `extract_full_summary_from_signature`

Abierto
  • ¿Algo no está bien?
#281 3 comentarios 0 reacciones 0 asignados Ver en GitHub

@Shubham-Padkonde ya está trabajando en esto.

Desde el 21/9/2026.

  • #308 de @Shubham-Padkonde — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
48/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
python
Área
cli, performance

Línea de trabajo

Comienza en knack/introspection.py, en la regex extract_full_summary_from_signature alrededor de la línea 18. Reproduce las entradas con espacios largos y malformadas mostradas en el issue, y después verifica que la documentación de los parámetros se siga extrayendo correctamente, mientras que la entrada patológica ya no provoque un backtracking excesivo. La regex propuesta y los ejemplos definen el comportamiento esperado.

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

Descripción

As pointed out by https://gist.github.com/prodigysml/d07cd482214c80bfb6d3240454d2f679, this regex (introduced by https://github.com/microsoft/knack/commit/430c39e657d8a424ef9b631782fe0e62a6bed203, #8) is inefficient:

https://github.com/microsoft/knack/blob/e0c14114aea5e4416c70a77623e403773aba73a8/knack/introspection.py#L18

It tries to match a string such as:

        :param command_loader: The command loader that commands will be registered into

As shown in https://regex101.com/, a simple :param r requires 1214 steps to fail.

image

:param r causes catastrophic backtracking:

Image

This is because \s+, .+? and \s* all match consecutive spaces, thus can trigger many backtrackings.

A better solution is to replace .+? with \w+ to match the parameter name so that backtrackings can be greatly reduced:

\s*(:param)\s+(\w+)\s*:(.*)

image

Lenguaje dominante
Python
Estrellas
359
Forks
104
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 microsoft/knack

Todos los issues de microsoft/knack

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.