python / python/cpython

Confusing behavior of selectors with buffered file objects

Offen
#101,053 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs topic-socket
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der selectors-Dokumentation und dem im Issue referenzierten Verhalten von BufferedIOBase und vergleiche anschließend Beispiele mit sys.stdin und socket.makefile(). Bestimme, ob der Umfang eine Dokumentationswarnung oder Implementierungsunterstützung für gepufferte Daten ist. Als abgeschlossen gilt die klar dokumentierte gewählte Verhaltensweise, einschließlich der Empfehlung os.read(fileobj.fileno(), size), falls die Änderung auf die Dokumentation beschränkt bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.