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.
#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
Describe the enhancement or feature you would like
At the PyCon AU sprints, I found that running the test suite in parallel with
make testunder--with-pydebugon my machine took ~3.5 minutes, while running with the default configuration took ~1 minute.Running the test suite sequentially with
python -m testtook ~18 minutes on a default build, while--with-pydebugtook ~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 withmake testrather thanpython -m test.#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:
One change I think would be worth making is to recommend an unqualified
makeas the default build configuration (especially when working pure Python changes without touching any of the C code), and mentionmake --with-pydebugas 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