Skip to content

GH-100108: Add async generators best practices section - #141885

Merged
kumaraditya303 merged 14 commits into
python:mainfrom
sergey-miryanov:100108-async-gen-docs
Mar 21, 2026
Merged

GH-100108: Add async generators best practices section#141885
kumaraditya303 merged 14 commits into
python:mainfrom
sergey-miryanov:100108-async-gen-docs

Conversation

@sergey-miryanov

@sergey-miryanovsergey-miryanov commented Nov 23, 2025•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

Added section about best practices for async generators.

📚 Documentation preview 📚: https://cpython-previews--141885.org.readthedocs.build/

@bedevere-appbedevere-appBot added awaiting review docs Documentation in the Doc dir skip news labels Nov 23, 2025
@bedevere-appbedevere-appBot mentioned this pull request Nov 23, 2025
Closed
@sergey-miryanov

sergey-miryanov commented Nov 23, 2025

Copy link
Copy Markdown
ContributorAuthor

@kumaraditya303 Could you please take a look?

StanFromIreland
StanFromIreland reviewed Nov 23, 2025
View reviewed changes
Comment threadDoc/library/asyncio-dev.rst Outdated
StanFromIreland
StanFromIreland reviewed Nov 23, 2025
View reviewed changes
Comment threadDoc/library/asyncio-dev.rst
sergey-miryanovand others added 2 commits November 24, 2025 10:32
@sergey-miryanov@StanFromIreland
Update Doc/library/asyncio-dev.rst
ae50f3f
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@sergey-miryanov
Fix spacing between sections
99f148c
@kumaraditya303kumaraditya303 self-assigned this Nov 24, 2025
kumaraditya303
kumaraditya303 reviewed Nov 25, 2025
View reviewed changes
Comment threadDoc/library/asyncio-dev.rst Outdated
kumaraditya303
kumaraditya303 reviewed Nov 25, 2025
View reviewed changes
Comment threadDoc/library/asyncio-dev.rst Outdated
@kumaraditya303

kumaraditya303 commented Nov 25, 2025

Copy link
Copy Markdown
Contributor

I would appreciate a review from @willingc and @gvanrossum on this.

gvanrossum
gvanrossum requested changes Nov 26, 2025
View reviewed changes

@gvanrossumgvanrossum left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It's great to add these explicitly to the docs!

I hope you don't mind that I have tried to correct your English grammar somewhat (mostly adding or subtracting "the").

Comment threadDoc/library/asyncio-dev.rst Outdated
Comment threadDoc/library/asyncio-dev.rst Outdated
Comment threadDoc/library/asyncio-dev.rst
Comment threadDoc/library/asyncio-dev.rst Outdated
Comment threadDoc/library/asyncio-dev.rst Outdated
Comment threadDoc/library/asyncio-dev.rst Outdated
Comment threadDoc/library/asyncio-dev.rst Outdated
Comment threadDoc/library/asyncio-dev.rst Outdated
Comment threadDoc/library/asyncio-dev.rst Outdated
Comment threadDoc/library/asyncio-dev.rst Outdated
@bedevere-app

bedevere-appBot commented Nov 26, 2025

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@gvanrossum

gvanrossum commented Nov 26, 2025

Copy link
Copy Markdown
Member

I'd also love to get @willingc's view on how to make this section have the right tone so as not to scare beginners away.

@sergey-miryanov

sergey-miryanov commented Nov 26, 2025

Copy link
Copy Markdown
ContributorAuthor

I hope you don't mind that I have tried to correct your English grammar somewhat (mostly adding or subtracting "the").

Thank you! I really appreciate it!

@sergey-miryanov
sergey-miryanov marked this pull request as draft November 26, 2025 21:41
@kumaraditya303
kumaraditya303 enabled auto-merge (squash) March 21, 2026 11:57
@kumaraditya303
kumaraditya303 merged commit 897fa23 into python:mainMar 21, 2026
28 checks passed
@github-project-automationgithub-project-automationBot moved this from Todo to Done in Docs PRsMar 21, 2026
@miss-islington-app

miss-islington-appBot commented Mar 21, 2026

Copy link
Copy Markdown

Thanks @sergey-miryanov for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 21, 2026
@sergey-miryanov@StanFromIreland
@gvanrossum@kumaraditya303@miss-islington
pythonGH-100108: Add async generators best practices section (pythonG…
65a11e0
…H-141885)
(cherry picked from commit 897fa23)
Co-authored-by: Sergey Miryanov <sergey.miryanov@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 21, 2026
@sergey-miryanov@StanFromIreland
@gvanrossum@kumaraditya303@miss-islington
pythonGH-100108: Add async generators best practices section (pythonG…
3de80f0
…H-141885)
(cherry picked from commit 897fa23)
Co-authored-by: Sergey Miryanov <sergey.miryanov@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
@bedevere-app

bedevere-appBot commented Mar 21, 2026

Copy link
Copy Markdown

GH-146252 is a backport of this pull request to the 3.14 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.14 bugs and security fixes label Mar 21, 2026
@bedevere-app

bedevere-appBot commented Mar 21, 2026

Copy link
Copy Markdown

GH-146253 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label Mar 21, 2026
kumaraditya303 added a commit that referenced this pull request Mar 21, 2026
@miss-islington@sergey-miryanov
@StanFromIreland@gvanrossum@kumaraditya303
[3.14]GH-100108: Add async generators best practices section (GH-141885
d6e0066
) (#146252)
GH-100108: Add async generators best practices section (GH-141885)
(cherry picked from commit 897fa23)
Co-authored-by: Sergey Miryanov <sergey.miryanov@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
kumaraditya303 added a commit that referenced this pull request Mar 21, 2026
@miss-islington@sergey-miryanov
@StanFromIreland@gvanrossum@kumaraditya303
[3.13]GH-100108: Add async generators best practices section (GH-141885
84c1fa3
) (#146253)
GH-100108: Add async generators best practices section (GH-141885)
(cherry picked from commit 897fa23)
Co-authored-by: Sergey Miryanov <sergey.miryanov@gmail.com>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
@sergey-miryanov

sergey-miryanov commented Mar 21, 2026

Copy link
Copy Markdown
ContributorAuthor

Thanks!

@sergey-miryanov
sergey-miryanov deleted the 100108-async-gen-docs branch March 21, 2026 20:31
CuriousLearner added a commit to CuriousLearner/cpython that referenced this pull request Mar 22, 2026
@CuriousLearner
Merge remote-tracking branch 'upstream/main' into fix-pythongh-138577
2691ad9
* upstream/main: (1475 commits)
Docs: replace all `datetime` imports with `import datetime as dt` (python#145640)
pythongh-146153: Use `frozendict` in pure python fallback for `curses.has_key` (python#146154)
pythongh-138234: clarify returncode behavior for subprocesses created with `shell=True` (python#138536)
pythongh-140947: fix contextvars handling for server tasks in asyncio (python#141158)
pythonGH-100108: Add async generators best practices section (python#141885)
pythonGH-145667: Merge `GET_ITER` and `GET_YIELD_FROM_ITER` (pythonGH-146120)
pythongh-146228: Better fork support in cached FastPath (python#146231)
pythongh-146227: Fix wrong type in _Py_atomic_load_uint16 in pyatomic_std.h (pythongh-146229)
pythongh-145980: Fix copy/paste mistake in binascii.c (python#146230)
pythongh-146092: Raise MemoryError on allocation failure in _zoneinfo (python#146165)
pythongh-91279: Note `SOURCE_DATE_EPOCH` support in `ZipFile.writestr()` doc (python#139396)
pythongh-146196: Fix Undefined Behavior in _PyUnicodeWriter_WriteASCIIString() (python#146201)
pythongh-143930: Reject leading dashes in webbrowser URLs
pythongh-145916: Soft-deprecate ctypes.util.find_library (pythonGH-145919)
pythongh-146205: Check the errno with != 0 in close impls in select module (python#146206)
pythongh-146171: Fix nested AttributeError suggestions (python#146188)
pythongh-146099: Optimize _GUARD_CODE_VERSION+IP via function version symbols (pythonGH-146101)
pythongh-145980: Add support for alternative alphabets in the binascii module (pythonGH-145981)
pythongh-145754: Update signature retrieval in unittest.mock to use forwardref annotation format (python#145756)
pythongh-145177: Add emscripten run --test, uses test args from config.toml (python#146160)
...
@pablogsalpablogsal mentioned this pull request Apr 4, 2026
Merged
ljfp pushed a commit to ljfp/cpython that referenced this pull request Apr 25, 2026
@sergey-miryanov@StanFromIreland
@gvanrossum@kumaraditya303@ljfp
pythonGH-100108: Add async generators best practices section (python#…
789e8b0
…141885)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIrelandStanFromIrelandStanFromIreland left review comments
@kumaraditya303kumaraditya303kumaraditya303 approved these changes
@1st11st1Awaiting requested review from 1st11st1 is a code owner
@asvetlovasvetlovAwaiting requested review from asvetlovasvetlov is a code owner
@willingcwillingcAwaiting requested review from willingcwillingc is a code owner
@gvanrossumgvanrossumAwaiting requested review from gvanrossum

Assignees

@kumaraditya303kumaraditya303

Labels

docsDocumentation in the Doc dirskip newstopic-asyncio

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@sergey-miryanov@kumaraditya303@gvanrossum@StanFromIreland@nazeerali4325-commits