[Bayel1602]

Summary

Update the collections.abc documentation table to consistently list all required abstract methods, including inherited ones.

• Add __iter__() to Reversible (inherited from Iterable).
• Add __await__() to Coroutine (inherited from Awaitable).

The existing table structure remains unchanged.

Closes #161311

• Issue: Inconsistent listing of inherited abstract methods in collections.abc documentation #161311

[python-cla-bot]

All commit authors signed the Contributor License Agreement.

[read-the-docs-community]

Documentation build overview

📚 cpython-previews | 🛠️ Build #35647403 | 📁 Comparing 55b4dd7 against main (44579b0)

  🔍 Preview build  

2 files changed

± library/collections.abc.html
± whatsnew/changelog.html

[picnixz]

I had troubles indeed knowing what was marked as abstract and what was not, but I think this is correct here. Can you check that all classes in the table that do not have a column in abstract methods are really concrete classes that can be instantiated?

[Bayel1602]

I checked the four classes with empty "Abstract Methods" cells: MappingView, ItemsView, KeysView, and ValuesView.

All four have empty __abstractmethods__ sets and can be instantiated directly with a mapping.

So the empty cells appear to be correct.

[picnixz]

For backports, can you check that all the methods you added were already abstract since 3.14? I just don't want to backport a wrong doc change

[Bayel1602]

I checked the source code for the Python 3.14.0 release (Lib/_collections_abc.py).

Both methods were already abstract:

• Reversible inherits the abstract __iter__() from Iterable.
• Coroutine inherits the abstract __await__() from Awaitable.

Neither class provides a concrete implementation of the inherited method, so both additions are valid for the 3.14 documentation backport.

[miss-islington-app]

Thanks @Bayel1602 for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14, 3.15.
🐍🍒⛏🤖

[bedevere-app]

GH-161330 is a backport of this pull request to the 3.15 branch.

[bedevere-app]

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

[picnixz]

Arf, I missed a typo, but I fixed the backport. Could you.. open another PR for fixing the typo please?

The collections module offers the following :term:`ABCs <abstract base class>`:

The "Abstract Methods" column lists all required abstract methods,
including those inherited from parent classes.

should be

The collections module offers the following :term:`ABCs <abstract base class>`,
where the "Abstract Methods" column lists all required abstract methods,
including those inherited from parent classes:

(otherwise the : introduces the caption sentence)

[Bayel1602]

I've opened a follow-up PR to fix the introductory text: #161333