python / python/cpython

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

Abierto
#117,470 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

docs
Lenguaje dominante
Python
Estrellas
77.2k
Forks
36k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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?

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza por la documentación enlazada de Python 3.12 sobre threading.Condition.notify() y lee la descripción completa del parámetro n. Aclara la relación entre el límite indicado y la implementación actual, incluido si se pretende ofrecer alguna garantía; se considera terminado cuando la documentación ya no deja ambiguo el contrato.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.