← 返回首页
bpo-31938: Fix default-value signatures of several functions in the select module by asottile · Pull Request #21066 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

bpo-31938: Fix default-value signatures of several functions in the select module#21066

Merged
vstinner merged 1 commit into
python:masterfrom
asottile:pydoc_select_31938
Jun 23, 2020
Merged

bpo-31938: Fix default-value signatures of several functions in the select module#21066
vstinner merged 1 commit into
python:masterfrom
asottile:pydoc_select_31938

Conversation

asottile commented Jun 23, 2020 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

this appears to have regressed in 6dc57e2

https://bugs.python.org/issue31938

taleinat commented Jun 23, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

If this is the proper way to do it, this PR should also fix the default values for poll.register and devpoll.register similarly.

vstinner mentioned this pull request Jun 23, 2020
Closed

vstinner commented Jun 23, 2020

Copy link
Copy Markdown
Member

Oops, I didn't notice that you proposed a PR and so I wrote PR #21067 which is the same fix :-) Copy of my comment there.

inspect.signature() doesn't see the event_mask. Is it a bug in signature which doesn't support a signature written on two lines?

cc @serhiy-storchaka @1st1 @ambv

11:47:01 vstinner@apu$ ./python Python 3.10.0a0 (heads/pydoc_select:486e11db95, Jun 23 2020, 11:45:39) >>> import select >>> select.epoll.register.__text_signature__ '($self, /, fd,\n eventmask=select.EPOLLIN | select.EPOLLPRI | select.EPOLLOUT)' >>> import inspect >>> inspect.signature(select.epoll.register) <Signature (self, /, fd)>

So pydoc doesn't show the whole signature:

./python -m pydoc select (...) | register(self, /, fd) | Registers a new fd or raises an OSError if the fd is already registered. | | fd | the target file descriptor of the operation | eventmask | a bit set composed of the various EPOLL constants | | The epoll interface supports all file descriptors that support poll.

vstinner commented Jun 23, 2020

Copy link
Copy Markdown
Member

If this is the proper way to do it, this PR should also fix the default values for poll.register and devpoll.register similarly.

IMO the fix is correct, so I concur thta the two other functions signature should also be fixed.

By the way, I suggest to rephase the NEWS entry to explain that the change fix the "signature" rather than fixing "pydoc".

asottile force-pushed the pydoc_select_31938 branch from 8f69adc to ea850df Compare June 23, 2020 20:20
asottile changed the title bpo-31938: Fix pydoc of select module bpo-31938: Fix default-value signatures of several functions in the select module Jun 23, 2020

asottile commented Jun 23, 2020

Copy link
Copy Markdown
Contributor Author

I fixed a few others as well -- good catch

vstinner merged commit d051801 into python:master Jun 23, 2020

miss-islington commented Jun 23, 2020

Copy link
Copy Markdown
Contributor

Thanks @asottile for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

miss-islington commented Jun 23, 2020

Copy link
Copy Markdown
Contributor

Sorry, @asottile and @vstinner, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker d051801052211b533c46a593b1c1bccf649a171c 3.9

miss-islington commented Jun 23, 2020

Copy link
Copy Markdown
Contributor

Sorry @asottile and @vstinner, I had trouble checking out the 3.8 backport branch.
Please backport using cherry_picker on command line.
cherry_picker d051801052211b533c46a593b1c1bccf649a171c 3.8

vstinner commented Jun 23, 2020

Copy link
Copy Markdown
Member

@asottile: Automated backport failed. Can you try to backport it manually (use cherry_picker or git cherry-pick -x)?

asottile deleted the pydoc_select_31938 branch June 23, 2020 21:57
asottile added a commit to asottile/cpython that referenced this pull request Jun 23, 2020
bpo-31938: Fix default-value signatures of several functions in the s… …
7f7548e
…elect module (pythonGH-21066) (cherry picked from commit d051801)

bedevere-bot commented Jun 23, 2020

Copy link
Copy Markdown

GH-21097 is a backport of this pull request to the 3.9 branch.

bedevere-bot commented Jun 23, 2020

Copy link
Copy Markdown

GH-21098 is a backport of this pull request to the 3.8 branch.

asottile added a commit to asottile/cpython that referenced this pull request Jun 23, 2020
bpo-31938: Fix default-value signatures of several functions in the s… …
501e18d
…elect module (pythonGH-21066) (cherry picked from commit d051801)
asottile mentioned this pull request Jun 23, 2020
Closed
miss-islington pushed a commit that referenced this pull request Jun 23, 2020
[3.8] bpo-31938: Fix default-value signatures of several functions in… …
60cbdc8
… the select module (GH-21066) (GH-21098) (cherry picked from commit d051801) Automerge-Triggered-By: @vstinner
miss-islington pushed a commit that referenced this pull request Jun 23, 2020
[3.9] bpo-31938: Fix default-value signatures of several functions in… …
48fc35a
… the select module (GH-21066) (GH-21097) (cherry picked from commit d051801) Automerge-Triggered-By: @vstinner

vstinner commented Jun 23, 2020 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

pydoc doesn't show the eventmask parameter whereas it is in select.epoll.register.text_signature. I created bpo-41095: "inspect.signature() doesn't parse text_signature containing a newline character".

fasih pushed a commit to fasih/cpython that referenced this pull request Jun 29, 2020
bpo-31938: Fix default-value signatures of several functions in the s… …
db530d1
…elect module (pythonGH-21066)
vstinner mentioned this pull request Nov 3, 2022
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

vstinner

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

Footer

© 2026 GitHub, Inc.