Devguide recommends a very slow testing configuration
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 68/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia dalla sezione sull’esecuzione dei test all’indirizzo devguide.python.org/testing/run-write-tests/#running e confrontala con la guida rapida Getting Started e con la sua posizione nella landing page. Esamina la documentazione collegata sulla configurazione delle build di debug. Il lavoro è completo quando la guida raccomanda coerentemente i test in parallelo e la build predefinita, spiega quando --with-pydebug è utile e rende visibile la guida rapida sopra i link alle sezioni.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- Python
- Stelle
- 2.1k
- Fork
- 1k
- Merge medio
- 2g 12h
- PR unite (30g)
- 12
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di python/devguide
-
type-feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
type-feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
topic-building python type-feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
needs: decision topic-test type-bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
topic-dev process type-feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
Tutte le issue di python/devguide
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
qgis/QGIS-Documentation#11275 ·
-
bug priority:normal ready-for-dev
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
OpenHands/extensions#626 · 1 commento ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
CSCfi/sd-search-api#39 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
-
please add to porn list Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
StevenBlack/hosts#3255 ·