python / python/cpython

Some server class attributes are missing in socketserver docs

未关闭
#128,319 0 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

docs topic-socket
主要语言
Python
星标
77.2k
派生
36k
PR 合并指标
PR 指标待抓取

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 socketserver 文档开始,将其中的类属性描述与 Lib/socketserver.py 第 185-198 行附近的内容进行比较。完成标准是记录 allow_reuse_port,正确归类 address_family,明确 request_queue_size 适用于 TCP,并记录仅适用于 UDP 的最大数据包大小属性;issue 中已链接 gh-128320。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。