Skip to content

bpo-41857: Document timeout arguments in select module #22406

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

Merged
merged 2 commits into from
Jan 20, 2022
Merged

bpo-41857: Document timeout arguments in select module #22406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f86628
bpo-41857: Document timeout arguments in select module
zaneb Sep 25, 2020
adff1f0
Merge branch 'main' into select-poll-timeout-docstrings
taleinat Jan 20, 2022
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
10 changes: 9 additions & 1 deletion Modules/clinic/selectmodule.c.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions Modules/selectmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,6 +570,8 @@ select_poll_unregister_impl(pollObject *self, int fd)
select.poll.poll

timeout as timeout_obj: object = None
The maximum time to wait in milliseconds, or else None (or a negative
value) to wait indefinitely.
/

Polls the set of registered file descriptors.
Expand All @@ -580,7 +582,7 @@ report, as a list of (fd, event) 2-tuples.

static PyObject *
select_poll_poll_impl(pollObject *self, PyObject *timeout_obj)
/*[clinic end generated code: output=876e837d193ed7e4 input=7a446ed45189e894]*/
/*[clinic end generated code: output=876e837d193ed7e4 input=c2f6953ec45e5622]*/
{
PyObject *result_list = NULL;
int poll_result, i, j;
Expand Down Expand Up @@ -894,6 +896,8 @@ select_devpoll_unregister_impl(devpollObject *self, int fd)
/*[clinic input]
select.devpoll.poll
timeout as timeout_obj: object = None
The maximum time to wait in milliseconds, or else None (or a negative
value) to wait indefinitely.
/

Polls the set of registered file descriptors.
Expand All @@ -904,7 +908,7 @@ report, as a list of (fd, event) 2-tuples.

static PyObject *
select_devpoll_poll_impl(devpollObject *self, PyObject *timeout_obj)
/*[clinic end generated code: output=2654e5457cca0b3c input=fd0db698d84f0333]*/
/*[clinic end generated code: output=2654e5457cca0b3c input=3c3f0a355ec2bedb]*/
{
struct dvpoll dvp;
PyObject *result_list = NULL;
Expand Down