python / python/cpython

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

Aberta
#117,470 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs
Linguagem predominante
Python
Estrelas
77.2k
Forks
35.9k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

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?

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pela documentação vinculada do Python 3.12 sobre threading.Condition.notify() e leia a descrição completa do parâmetro n. Esclareça a relação entre o limite declarado e a implementação atual, incluindo se há a intenção de oferecer alguma garantia; considera-se concluído quando a documentação não deixar mais o contrato ambíguo.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.