GH-100108: Add async generators best practices section by sergey-miryanov · Pull Request #141885 · python/cpython · GitHub

Added section about best practices for async generators.

Issue: Add a section about async generators in asyncio docs #100108

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

@kumaraditya303 Could you please take a look?

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

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

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").

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.

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.

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!

Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>

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

…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>

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

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

) (#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>

) (#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>

Thanks!

* 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) ...

…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>

Add async generators best practices section

8fb10ee

sergey-miryanov requested review from 1st1, asvetlov, kumaraditya303 and willingc as code owners November 23, 2025 21:16

bedevere-app Bot added awaiting review docs Documentation in the Doc dir skip news labels Nov 23, 2025

github-project-automation Bot added this to Docs PRs Nov 23, 2025

github-project-automation Bot moved this to Todo in Docs PRs Nov 23, 2025

bedevere-app Bot mentioned this pull request Nov 23, 2025

Add a section about async generators in asyncio docs #100108

Closed

StanFromIreland reviewed Nov 23, 2025

View reviewed changes

Comment thread Doc/library/asyncio-dev.rst Outdated

StanFromIreland reviewed Nov 23, 2025

View reviewed changes

Comment thread Doc/library/asyncio-dev.rst

sergey-miryanov and others added 2 commits November 24, 2025 10:32

Update Doc/library/asyncio-dev.rst

ae50f3f

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>

Fix spacing between sections

99f148c

kumaraditya303 self-assigned this Nov 24, 2025

kumaraditya303 reviewed Nov 25, 2025

View reviewed changes

Comment thread Doc/library/asyncio-dev.rst Outdated

kumaraditya303 reviewed Nov 25, 2025

View reviewed changes

Comment thread Doc/library/asyncio-dev.rst Outdated

gvanrossum requested changes Nov 26, 2025

View reviewed changes

bedevere-app Bot removed the awaiting review label Nov 26, 2025

bedevere-app Bot added the awaiting changes label Nov 26, 2025

sergey-miryanov and others added 3 commits November 27, 2025 00:46

Apply suggestions from code review

11242b4

Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>

Fix copy-paste typo

3556aef

Update section about iterating agen after running event loop

a70038a

sergey-miryanov marked this pull request as draft November 26, 2025 21:41

bedevere-app Bot requested a review from gvanrossum February 25, 2026 20:46

sergey-miryanov requested a review from kumaraditya303 February 25, 2026 20:46

sergey-miryanov added 3 commits February 26, 2026 01:50

Fix anext

100d9ac

Add example

d910ee7

Fix wording

b5c3ddc

kumaraditya303 approved these changes Mar 21, 2026

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting change review labels Mar 21, 2026

kumaraditya303 added topic-asyncio needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Mar 21, 2026

Merge branch 'main' into 100108-async-gen-docs

c1daefb

kumaraditya303 enabled auto-merge (squash) March 21, 2026 11:57

kumaraditya303 merged commit 897fa23 into python:main Mar 21, 2026
28 checks passed

bedevere-app Bot removed the awaiting merge label Mar 21, 2026

github-project-automation Bot moved this from Todo to Done in Docs PRs Mar 21, 2026

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

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Mar 21, 2026

sergey-miryanov deleted the 100108-async-gen-docs branch March 21, 2026 20:31

pablogsal mentioned this pull request Apr 4, 2026

gh-130273: Fix traceback color output with unicode characters #142529

Merged

GH-100108: Add async generators best practices section by sergey-miryanov · Pull Request #141885 · python/cpython · GitHub

Uh oh!

Uh oh!

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

GH-100108: Add async generators best practices section#141885kumaraditya303 merged 14 commits intopython:mainpython/cpython:mainfrom sergey-miryanov:100108-async-gen-docssergey-miryanov/cpython:100108-async-gen-docsCopy head branch name to clipboard

Conversation

sergey-miryanov commented Nov 23, 2025 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sergey-miryanov commented Nov 23, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kumaraditya303 commented Nov 25, 2025

Uh oh!

gvanrossum left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-app Bot commented Nov 26, 2025

Uh oh!

gvanrossum commented Nov 26, 2025

Uh oh!

sergey-miryanov commented Nov 26, 2025

Uh oh!

Uh oh!

miss-islington-app Bot commented Mar 21, 2026

Uh oh!

bedevere-app Bot commented Mar 21, 2026

Uh oh!

bedevere-app Bot commented Mar 21, 2026

Uh oh!

sergey-miryanov commented Mar 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

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

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