Devguide recommends a very slow testing configuration
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 68/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- python
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với phần chạy các bài kiểm thử tại devguide.python.org/testing/run-write-tests/#running và so sánh phần này với tài liệu tham khảo nhanh Getting Started cũng như vị trí của tài liệu đó trên trang đích. Xem lại tài liệu được liên kết về cách cấu hình các bản build debug. Hoàn thành khi hướng dẫn nhất quán khuyến nghị kiểm thử song song và bản build mặc định, giải thích khi nào --with-pydebug hữu ích, đồng thời đưa tài liệu tham khảo nhanh lên phía trên các liên kết đến các phần.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Describe the enhancement or feature you would like
At the PyCon AU sprints, I found that running the test suite in parallel with make test under --with-pydebug on my machine took ~3.5 minutes, while running with the default configuration took ~1 minute.
Running the test suite sequentially with python -m test took ~18 minutes on a default build, while --with-pydebug took ~27 minutes.
One of the sprint attendees (with a much slower system in general) had their sequential test run take ~45 minutes under --with-pydebug, dropping to around ~25 minutes when using the default build configuration, and then down to ~5 minutes by running with make test rather than python -m test.
https://github.com/python/devguide/issues/1171 covered updating https://devguide.python.org/getting-started/quick-reference/#quick-reference to recommend parallel test execution, but https://devguide.python.org/testing/run-write-tests/#running buries the parallel execution command well down the page.
There are multiple intersecting issues here:
- between the intro, the table of section references, and the video embed, the "Quick reference" link has dropped "below the fold" on the landing page (at least on my laptop screen)
- some of the instructions were originally written for C-focused development and then never revisited for pure Python contributors
- we're inconsistent in our recommendations for how to run the test suite (and we don't emphasise how slow it is to run them sequentially, so you almost never want to actually do that if you can avoid it)
One change I think would be worth making is to recommend an unqualified make as the default build configuration (especially when working pure Python changes without touching any of the C code), and mention make --with-pydebug as an option that is slower in execution, but provides a much better debugging experience when working on C level changes (with reference to https://docs.python.org/3/using/configure.html#python-debug-build)
Another would be to move the quick reference section heading and linking paragraph up above the section link table.
Describe alternatives you have considered
No response
Additional context
No response
- Ngôn ngữ chính
- Python
- Star
- 2.1k
- Fork
- 1k
- Merge trung bình
- 2 ngày 12 giờ
- Pull request đã merge (30 ngày)
- 12
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của python/devguide
-
type-feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
type-feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
topic-building python type-feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
needs: decision topic-test type-bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
topic-dev process type-feature
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Tất cả issue của python/devguide
Issue tương tự
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
zostera/django-bootstrap4#894 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
use-agent-os/agent-os#3276 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
NousResearch/hermes-agent#117848 ·