diff options
| author | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-12-06 12:21:12 +0200 |
|---|---|---|
| committer | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-12-06 12:21:12 +0200 |
| commit | f04d1bb17053a4ba6194777b5f7e5a0bab0c5995 (patch) | |
| tree | 7ca0b46c0a6a5f0ca46478362e3a89b9c97ae67e | |
| parent | c37cfd67097f78617213693a3be918aaf10cc3d6 (diff) | |
| parent | ed636a84b90f7ac5e9e396e3a026188ed53f9307 (diff) | |
| download | cpython-git-f04d1bb17053a4ba6194777b5f7e5a0bab0c5995.tar.gz | |
Specify which I/O ABC methods have implementations in the docs.
| -rw-r--r-- | Doc/library/io.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst index 44e663dd28..810e56f236 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 ^^^^^^^^^^^^^^^^ |