Inefficient regex in `extract_full_summary_from_signature`

Đang mở
  • Có gì không ổn?
#281 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

@Shubham-Padkonde đang làm issue này rồi.

Từ ngày 21/9/2026.

  • #308 của @Shubham-Padkonde — đang mở

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
48/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
cli, performance

Hướng nghiên cứu

Bắt đầu trong knack/introspection.py, tại regex extract_full_summary_from_signature ở khoảng dòng 18. Tái hiện các input có khoảng trắng dài và các input không đúng định dạng được nêu trong issue, sau đó xác minh rằng tài liệu của tham số vẫn được trích xuất chính xác, trong khi input bất thường không còn gây ra backtracking quá mức. Regex được đề xuất và các ví dụ xác định hành vi mong đợi.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Python
Star
359
Fork
104
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/knack

Tất cả issue của microsoft/knack

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.