[issue10589] I/O ABC docs should specify which methods have implementations

Daniel Stutzbach report at bugs.python.org
Tue Nov 30 20:05:53 CET 2010

New submission from Daniel Stutzbach <stutzbach at google.com>:

The I/O ABC documentation has a blanket disclaimer at the top:

    "The abstract base classes also provide default implementations of some methods in order to help implementation of concrete stream classes. For example, BufferedIOBase provides unoptimized implementations of readinto() and readline()."

Which effectively means that to subclass one of them requires digging into Lib/_pyio.py to figure out which methods provide useful implementations.

It would be handy to have a table, similar to the one for the collections ABCs [1], that spells out which methods are provided.

[1]: http://docs.python.org/py3k/library/collections.html#abcs-abstract-base-classes

I hope to have a patch ready sometime within the next week.

assignee: stutzbach
components: Documentation
messages: 122930
nosy: stutzbach
priority: normal
severity: normal
stage: needs patch
status: open
title: I/O ABC docs should specify which methods have implementations
type: feature request
versions: Python 3.2

Python tracker <report at bugs.python.org>

More information about the Python-bugs-list mailing list