Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Make timeout duration unit self-documenting

Aperta
#80 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
testing

Direzione di ricerca

Inizia esaminando l’API attuale di @mark.timeout e la documentazione che definisce le relative unità di durata. Confronta le interfacce proposte con argomenti nominati e timedelta, inclusi la compatibilità e le unità supportate. Il lavoro è completato quando viene selezionata e specificata un’API autoesplicativa, con il relativo comportamento e le implicazioni della migrazione documentati chiaramente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

In a statement like @mark.timeout(50) there is nothing to say the duration is defined in seconds. This has a few disadvantages:

  • Many other timing mechanisms use milliseconds or minutes as their units, so we can't simply assume that it's seconds. A new or returning user has to read the documentation (or code) to ascertain this, wasting time and producing cognitive overhead.
  • Extreme timeouts like 1200 or 0.00005 have more cognitive overhead, since converting to the "natural" unit of minutes/microseconds etc isn't always trivial.

It would be nice if it instead were self-documenting. Some alternatives:

  • @mark.timeout(seconds=50) would make it pretty obvious, and would make it easy to support several units.
  • @mark.timeout(timedelta(minutes=5)) would make it more explicit, while supporting the widest possible range of units at no extra cost.
  • @mark.timeout(seconds=timedelta(minutes=5).total_seconds()) is a clunky workaround.
Lingua principale
Python
Stelle
258
Fork
69
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pytest-dev/pytest-timeout

Tutte le issue di pytest-dev/pytest-timeout

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.