Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Specify which I/O ABC methods have implementations in the docs.

This commit is contained in:
Andrew Svetlov 2012-12-06 12:20:56 +02:00
parent 96bc04369a
commit ed636a84b9
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Doc/library/io.rst
View File

@ -189,6 +189,25 @@ interface to a buffered raw stream (:class:`BufferedIOBase`). Finally,
Argument names are not part of the specification, and only the arguments of
:func:`open` are intended to be used as keyword arguments.
The following table summarizes the ABCs provided by the :mod:`io` module:
========================= ================== ======================== ==================================================
ABC Inherits Stub Methods Mixin Methods and Properties
========================= ================== ======================== ==================================================
:class:`IOBase` ``fileno``, ``seek``, ``close``, ``closed``, ``__enter__``,
and ``truncate`` ``__exit__``, ``flush``, ``isatty``, ``__iter__``,
``__next__``, ``readable``, ``readline``,
``readlines``, ``seekable``, ``tell``,
``writable``, and ``writelines``
:class:`RawIOBase` :class:`IOBase` ``readinto`` and Inherited :class:`IOBase` methods, ``read``,
``write`` and ``readall``
:class:`BufferedIOBase` :class:`IOBase` ``detach``, ``read``, Inherited :class:`IOBase` methods, ``readinto``
``read1``, and ``write``
:class:`TextIOBase` :class:`IOBase` ``detach``, ``read``, Inherited :class:`IOBase` methods, ``encoding``,
``readline``, and ``errors``, and ``newlines``
``write``
========================= ================== ======================== ==================================================
I/O Base Classes
^^^^^^^^^^^^^^^^