[issue26019] collections.abc documentation incomplete

[Raymond Hettinger]

Raymond Hettinger  added the comment:

This was fixed in commit 62fa613f6a6e872723505ee9d56242c31a654a9d

--
nosy: +rhettinger
resolution:  -> out of date
stage:  -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26019] collections.abc documentation incomplete

[Irit Katriel]

Irit Katriel  added the comment:

The patch needs to be converted to a GitHub PR and reviewed.

--
components: +Library (Lib)
keywords: +easy
nosy: +iritkatriel
versions: +Python 3.11 -Python 3.6

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26019] collections.abc documentation incomplete

[Guido van Rossum]

Guido van Rossum added the comment:

LGTM. Do you want me to commit it now or wait until you've redone it after 
#25958 has gone through?

--
nosy: +gvanrossum

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26019] collections.abc documentation incomplete

[Andrew Barnert]

Andrew Barnert added the comment:

The attached patch is, I think, the smallest change that includes all the 
necessary information.

Of course it will need to be redone if #25958 goes through, with a 
version-changed note explaining that prior to 3.6 some of the implicit ABCs 
(maybe with a list) treated None as an abstract method implementation while 
others didn't. So, this patch is basically a throwaway. But any review comments 
would still be useful, of course.

--
keywords: +patch
Added file: http://bugs.python.org/file41513/patch26019.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue26019] collections.abc documentation incomplete

[Andrew Barnert]

New submission from Andrew Barnert:

Some of the modules in collections.abc have a subclass hook that implicitly 
registers any type that declares the right methods, like Iterator. Others do 
not, like Sequence. For those that do have the hook, it's not always obvious 
what methods are tested. And some of them test the methods for truthiness, 
others only for existence (although #25958 will fix that last bit).

The documentation doesn't even mention this, much less describe which ABCs are 
of which kind.

For someone who just wants to know how to write isinstance(arg, Iterable), 
that's fine. But anyone who wants to create new classes, or integrate 
third-party classes that weren't ABC-friendly, has to read the collections.abc 
module source to figure out what they want to do.

--
assignee: docs@python
components: Documentation
messages: 257577
nosy: abarnert, docs@python
priority: normal
severity: normal
status: open
title: collections.abc documentation incomplete
type: enhancement
versions: Python 3.6

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com