bpo-32568: make select.epoll() and its docs consistent #7840
Conversation
* 'flags' is indeed deprecated, but there was a validation on its value, contrary to the docs saying it is "completely ignored". This removes that check. * 'sizehint' is still used when 'epoll_create1()' is unavailable, so this adds mention of this in the docs. * Make 'sizehint' accept -1 again, which is replaced with FD_SETSIZE-1. This is needed to have a default value available at the Python level allowing to set this, since FD_SETSIZE is not exposed to Python. (see: bpo-31938)
| @@ -0,0 +1 @@ | |||
| make select.epoll() and its docs consistent re. *sizehint* and *flags* | |||
There was a problem hiding this comment.
Please avoid abbreviation, english is not my first language and I don't know what "re." means. Add also an uppercase to "Make".
|
When you're done making the requested changes, leave the comment: |
Other than that value check, the existing code completely ignores the |
|
I have made the requested changes; please review again. |
|
Thanks for making the requested changes! @vstinner: please review the changes made to this pull request. |
|
The argument passed to And I think it is better to keep the check for flags. This can help to backport Python programs to older versions (the same reason as keeping the check for the argument of In future we will get rid of both parameters. Maybe will start producing a deprecation warning in 3.8. |
Also update tests accordingly.
|
@serhiy-storchaka, this is ready for another review. |
|
@taleinat: Please replace |
|
Thanks @taleinat for the PR |
|
GH-8024 is a backport of this pull request to the 3.7 branch. |
* `flags` is indeed deprecated, but there is a validation on its value for backwards compatibility reasons. This adds mention of this in the docs. * The docs say that `sizehint` is deprecated and ignored, but it is still used when `epoll_create1()` is unavailable. This adds mention of this in the docs. * `sizehint=-1` is acceptable again, and is replaced with `FD_SETSIZE-1`. This is needed to have a default value available at the Python level, since `FD_SETSIZE` is not exposed to Python. (see: bpo-31938) * Reject `sizehint=0` since it is invalid to pass on to `epoll_create()`. The relevant tests have also been updated. (cherry picked from commit 0cdf5f4) Co-authored-by: Tal Einat <taleinat+github@gmail.com>
|
Sorry, @taleinat, I could not cleanly backport this to |
…H-7840) * `flags` is indeed deprecated, but there is a validation on its value for backwards compatibility reasons. This adds mention of this in the docs. * The docs say that `sizehint` is deprecated and ignored, but it is still used when `epoll_create1()` is unavailable. This adds mention of this in the docs. * `sizehint=-1` is acceptable again, and is replaced with `FD_SETSIZE-1`. This is needed to have a default value available at the Python level, since `FD_SETSIZE` is not exposed to Python. (see: bpo-31938) * Reject `sizehint=0` since it is invalid to pass on to `epoll_create()`. The relevant tests have also been updated.. (cherry picked from commit 0cdf5f4) Co-authored-by: Tal Einat <taleinat+github@gmail.com>
|
GH-8025 is a backport of this pull request to the 3.6 branch. |
…8024) * `flags` is indeed deprecated, but there is a validation on its value for backwards compatibility reasons. This adds mention of this in the docs. * The docs say that `sizehint` is deprecated and ignored, but it is still used when `epoll_create1()` is unavailable. This adds mention of this in the docs. * `sizehint=-1` is acceptable again, and is replaced with `FD_SETSIZE-1`. This is needed to have a default value available at the Python level, since `FD_SETSIZE` is not exposed to Python. (see: bpo-31938) * Reject `sizehint=0` since it is invalid to pass on to `epoll_create()`. The relevant tests have also been updated. (cherry picked from commit 0cdf5f4) Co-authored-by: Tal Einat <taleinat+github@gmail.com>
GH-8025) * `flags` is indeed deprecated, but there is a validation on its value for backwards compatibility reasons. This adds mention of this in the docs. * The docs say that `sizehint` is deprecated and ignored, but it is still used when `epoll_create1()` is unavailable. This adds mention of this in the docs. * `sizehint=-1` is acceptable again, and is replaced with `FD_SETSIZE-1`. This is needed to have a default value available at the Python level, since `FD_SETSIZE` is not exposed to Python. (see: bpo-31938) * Reject `sizehint=0` since it is invalid to pass on to `epoll_create()`. The relevant tests have also been updated. (cherry picked from commit 0cdf5f4)
* `flags` is indeed deprecated, but there is a validation on its value for backwards compatibility reasons. This adds mention of this in the docs. * The docs say that `sizehint` is deprecated and ignored, but it is still used when `epoll_create1()` is unavailable. This adds mention of this in the docs. * `sizehint=-1` is acceptable again, and is replaced with `FD_SETSIZE-1`. This is needed to have a default value available at the Python level, since `FD_SETSIZE` is not exposed to Python. (see: bpo-31938) * Reject `sizehint=0` since it is invalid to pass on to `epoll_create()`. The relevant tests have also been updated.
The docs for
select.epoll()are currently out of sync with the implementation with regard to thesizehintandflagsparameters.flagsis indeed deprecated, but there was a validation on its value, contrary to the docs saying it is "completely ignored". This removes that check.sizehintis still used whenepoll_create1()is unavailable, so this adds mention of this in the docs.sizehintaccept-1again, which is replaced withFD_SETSIZE-1. This is needed to have a default value available at the Python level allowing to set this, sinceFD_SETSIZEis not exposed to Python. (see: bpo-31938)https://bugs.python.org/issue32568