[Python-checkins] cpython (merge 3.3 -> default): Specify which I/O ABC methods have implementations in the docs.
andrew.svetlov
python-checkins at python.org
Thu Dec 6 11:21:35 CET 2012
http://hg.python.org/cpython/rev/a58204570a7c
changeset: 80736:a58204570a7c
parent: 80733:ece75a3b942c
parent: 80735:3cb85250a0a3
user: Andrew Svetlov <andrew.svetlov at gmail.com>
date: Thu Dec 06 12:21:22 2012 +0200
summary:
Specify which I/O ABC methods have implementations in the docs.
files:
Doc/library/io.rst | 19 +++++++++++++++++++
1 files changed, 19 insertions(+), 0 deletions(-)
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -185,6 +185,25 @@
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
^^^^^^^^^^^^^^^^
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list