python / python/cpython

Some server class attributes are missing in socketserver docs

Aberta
#128,319 0 comentários 2 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

docs topic-socket
Linguagem predominante
Python
Estrelas
77.2k
Forks
36k
Métricas de merge de PRs
Métricas de PR pendentes

Descrição

Documentation

While working with socketserver recently I noticed that the allow_reuse_port class attribute is not documented but the allow_reuse_address attribute is.

https://github.com/python/cpython/blob/f9a5a3a3ef34e63dc197156e9a5f57842859ca04/Lib/socketserver.py#L185-L198

In addition there's a couple of places we could clean up right now, for instance address_family is still grouped with the per-instance attributes rather than the class attributes, request_queue_size is only applicable to TCP, and there's another missing undocumented class attribute for specifying max packet size that is only applicable to UDP.

Linked PRs
  • gh-128320

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 de socketserver e compare as descrições de seus atributos de classe com Lib/socketserver.py nas proximidades das linhas 185-198. O trabalho estará concluído quando allow_reuse_port estiver documentado, address_family estiver agrupado corretamente, ficar esclarecido que request_queue_size se aplica a TCP e o atributo de tamanho máximo de pacote exclusivo de UDP estiver documentado; gh-128320 está vinculado na issue.

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
Razoavelmente clara
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.