diff options
author | Steve Palmer <steve@srpalmer.me.uk> | 2019-04-09 04:35:27 (GMT) |
---|---|---|
committer | Benjamin Peterson <benjamin@python.org> | 2019-04-09 04:35:27 (GMT) |
commit | 7b97ab35b28b761ab1253df427ee674b1a90f465 (patch) | |
tree | a2413ecc43c5bd49be6f11ba8e85e7e0161e6a17 /Lib | |
parent | 8702b67dad62a9084f6c1823dce10653743667c8 (diff) | |
download | cpython-7b97ab35b28b761ab1253df427ee674b1a90f465.zip cpython-7b97ab35b28b761ab1253df427ee674b1a90f465.tar.gz cpython-7b97ab35b28b761ab1253df427ee674b1a90f465.tar.bz2 |
closes bpo-35848: Move all documentation regarding the readinto out of IOBase. (GH-11893)
Move all documentation regarding the readinto method into either io.RawIOBase or io.BufferedIOBase.
Corresponding changes to documentation in the _pyio.py module.
Diffstat (limited to 'Lib')
-rw-r--r-- | Lib/_pyio.py | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/Lib/_pyio.py b/Lib/_pyio.py index b0593c3..e868fdc 100644 --- a/Lib/_pyio.py +++ b/Lib/_pyio.py @@ -292,16 +292,15 @@ class IOBase(metaclass=abc.ABCMeta): derived classes can override selectively; the default implementations represent a file that cannot be read, written or seeked. - Even though IOBase does not declare read, readinto, or write because + Even though IOBase does not declare read or write because their signatures will vary, implementations and clients should consider those methods part of the interface. Also, implementations may raise UnsupportedOperation when operations they do not support are called. The basic type used for binary data read from or written to a file is - bytes. Other bytes-like objects are accepted as method arguments too. In - some cases (such as readinto), a writable object is required. Text I/O - classes work with str data. + bytes. Other bytes-like objects are accepted as method arguments too. + Text I/O classes work with str data. Note that calling any method (even inquiries) on a closed stream is undefined. Implementations may raise OSError in this case. @@ -1763,8 +1762,7 @@ class TextIOBase(IOBase): """Base class for text I/O. This class provides a character and line based interface to stream - I/O. There is no readinto method because Python's character strings - are immutable. There is no public constructor. + I/O. There is no public constructor. """ def read(self, size=-1): |