python / python/cpython

socket documentation should mention AF_UNSPEC in the section on constants and getaddrinfo() docs

オープン
#100,898 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

docs topic-socket
主要言語
Python
スター
77.2k
フォーク
36k
PR マージ指標
PR 指標を取得中

説明

Documentation

In the socket module documentation

There should be a mention of AF_UNSPEC alongside AF_INET, AF_INET6 and AF_UNIX in the constants section.
Also e.g. in the getaddrinfo() entry, it should be mentioned you can pass socket.AF_UNSPEC instead of 0.
The difference matters if automated testing is checking type annotations (at least I had this issue submitting
a pull request for pythonosc).

The default family argument for getaddrinfo is 0.
This has type int, not type socket.AddressFamily, whereas socket.AF_UNSPEC,
has the type socket.AddressFamily, but corresponds to the integer 0.

This makes a difference when type annotations are being checked
and the argument to family is expected to be of type socket.AddressFamily.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

socket モジュールのドキュメントから始め、具体的には定数セクションと getaddrinfo() の項目を確認します。AF_INET、AF_INET6、AF_UNIX と並べて AF_UNSPEC に触れ、family 引数には 0 の代わりに渡せることを記載します。完了条件は、要求された両方の参照で、型に関係する違いが説明されていることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation, networking
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。