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 摘要。