Skip to content
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

Jump to bottom

Add typing example for async functions. #20386

Merged
merged 2 commits into from
May 1, 2022
Merged

Add typing example for async functions. #20386

merged 2 commits into from
May 1, 2022

Conversation

Dreamsorcerer
Copy link
Contributor

@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@Dreamsorcerer

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels May 25, 2020
@Dreamsorcerer Dreamsorcerer changed the title Add example for async functions. Add typing example for async functions. May 25, 2020
@JelleZijlstra
Copy link
Member

This example makes sense but we're trying to move away from using typing.rst for detailed user documentation.

@cpython-cla-bot
Copy link

cpython-cla-bot bot commented Apr 30, 2022 •
edited
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

AlexWaygood
AlexWaygood approved these changes Apr 30, 2022
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

This looks good to me. I think the material on Callable in typing.rst should be moved to typing.readthedocs.io either all at once, or not at all, so this seems like a nice enhancement in the meantime.

@JelleZijlstra JelleZijlstra added needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels May 1, 2022
@JelleZijlstra JelleZijlstra merged commit 9588f88 into python:main May 1, 2022
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

GH-92103 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed needs backport to 3.10 only security fixes needs backport to 3.9 only security fixes labels May 1, 2022
@bedevere-bot
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 1, 2022
@Dreamsorcerer @miss-islington
typing docs: Add example for async functions (pythonGH-20386)
266e960 
Fixes python/typingGH-424
(cherry picked from commit 9588f88)

Co-authored-by: Sam Bull <[email protected]>
miss-islington added a commit that referenced this pull request May 1, 2022
@miss-islington @Dreamsorcerer
typing docs: Add example for async functions (GH-20386)
e7de543 
Fixes python/typingGH-424
(cherry picked from commit 9588f88)

Co-authored-by: Sam Bull <[email protected]>
miss-islington added a commit that referenced this pull request May 1, 2022
@miss-islington @Dreamsorcerer
typing docs: Add example for async functions (GH-20386)
fcbff77 
Fixes python/typingGH-424
(cherry picked from commit 9588f88)

Co-authored-by: Sam Bull <[email protected]>
hello-adam pushed a commit to hello-adam/cpython that referenced this pull request Jun 2, 2022
@miss-islington @Dreamsorcerer @hello-adam
typing docs: Add example for async functions (pythonGH-20386)
c69fa62 
Fixes python/typingGH-424
(cherry picked from commit 9588f88)

Co-authored-by: Sam Bull <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

@ilevkivskyi ilevkivskyi Awaiting requested review from ilevkivskyi

@Fidget-Spinner Fidget-Spinner Awaiting requested review from Fidget-Spinner

@JelleZijlstra JelleZijlstra Awaiting requested review from JelleZijlstra JelleZijlstra is a code owner

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news topic-typing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document how to type hint for an async function used as a callback
7 participants
@Dreamsorcerer @the-knights-who-say-ni @JelleZijlstra @miss-islington @bedevere-bot @AlexWaygood @csabella