python / python/cpython

Confusing documentation for the `n` parameter of `Threading.Condition.notify(n)`

Aperta
#117,470 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Documentation

I'm confused by this documentation of Threading.Condition.notify(), specifically the n parameter.

[...]

This method wakes up at most n of the threads waiting for the condition variable; it is a no-op if no threads are waiting.

The current implementation wakes up exactly n threads, if at least n threads are waiting. However, it’s not safe to rely on this behavior. A future, optimized implementation may occasionally wake up more than n threads.

[...]

(Boldface added by me.)

So is the contract that it will wake up ≤n threads, or ≥n threads? Is there any guarantee at all?

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia dalla documentazione collegata di Python 3.12 su threading.Condition.notify() e leggi la descrizione completa del parametro n. Chiarisci il rapporto tra il limite indicato e l’implementazione attuale, compreso se sia prevista qualche garanzia; il lavoro è completato quando la documentazione non lascia più ambiguo il contratto.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.