python / python/cpython

Confusing behavior of selectors with buffered file objects

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

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

docs topic-socket
主要言語
Python
スター
77.2k
フォーク
36k
平均マージ
1日 9時間
マージ済み PR(30日)
558

説明

Using selectors with buffered file objects is confusing because the selector will only report whether there is something to read in the underlying file descriptor and ignore the internal buffer. This is especially relevant because buffered file objects are used in many places in the standard library, e.g. sys.stdin or socket.makefile().

I propose to add a corresponding warning to the docs, e.g. like this:

Selectors only look at the underlying file descriptors, so they do not know about data that is buffered in python code. Buffered file objects are used in many places in the standard library, e.g. sys.stdin or socket.makefile(). In those cases, it is recommended to bypass the buffering by using os.read(fileobj.fileno(), size) instead of fileobj.read(size).

Even better would be add code to handle buffered file objects. Unfortunately, I think that BufferedIOBase does not expose whether it has data in its buffer.

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

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

はじめの一歩

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

調査の方向性

selectors のドキュメントと、issue で参照されている BufferedIOBase の動作から始め、次に sys.stdin と socket.makefile() を使用する例を比較します。対象範囲がドキュメント上の警告なのか、バッファーされたデータに対する実装サポートなのかを判断します。変更がドキュメントのみのままである場合は os.read(fileobj.fileno(), size) の推奨事項も含め、選択した動作が明確にドキュメント化されていれば完了です。

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

評価

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

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

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