summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Svetlov <andrew.svetlov@gmail.com>2012-12-06 10:21:22 (GMT)
committerAndrew Svetlov <andrew.svetlov@gmail.com>2012-12-06 10:21:22 (GMT)
commit4b237e3b1112304f834ac78fe05abdecbf3d87b4 (patch)
tree4aa372803c9d4a56e1a63ef486fe5a5dd522ee94
parent746d0434aed413a218e1516a9f84ad4642c9e27f (diff)
parentf04d1bb17053a4ba6194777b5f7e5a0bab0c5995 (diff)
downloadcpython-4b237e3b1112304f834ac78fe05abdecbf3d87b4.zip
cpython-4b237e3b1112304f834ac78fe05abdecbf3d87b4.tar.gz
cpython-4b237e3b1112304f834ac78fe05abdecbf3d87b4.tar.bz2
Specify which I/O ABC methods have implementations in the docs.
-rw-r--r--Doc/library/io.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 44e663d..810e56f 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -185,6 +185,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
^^^^^^^^^^^^^^^^