Skip to content

gh-44883: improve the docs about select to explain what select can access #134293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

gh-44883: improve the docs about select to explain what select can access #134293

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a7d90f
improve the docs about select to explain what select can access
chrisgramberg678 May 19, 2025
38940a0
accept PR feedback
chrisgramberg678 May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Doc/library/select.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,14 @@ The module defines the following:
library, and does not handle file descriptors that don't originate from
WinSock.

.. note::

:c:func:`!select` may not work with file objects that
internally buffer data because select is only aware of data in the
file descriptor provided by the kernel. However, file-like-objects often
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
file descriptor provided by the kernel. However, file-like-objects often
file descriptor provided by the kernel. However, :term:`file-like objects <file object>` often

File-like object simply links to file object

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I've made this change

contain a reference to a file descriptor via a :meth:`!fileno` method
which will work with select.

.. versionchanged:: 3.5
The function is now retried with a recomputed timeout when interrupted by
a signal, except if the signal handler raises an exception (see
Expand Down
Loading