def open(file, mode="r", buffering=None, encoding=None, errors=None,
newline=None, closefd=True):
- r"""Open file and return a stream. If the file cannot be opened, an
- IOError is raised.
+
+ r"""Open file and return a stream. If the file cannot be opened, an IOError is
+ raised.
file is either a string giving the name (and the path if the file
isn't in the current working directory) of the file to be opened or an
### Positioning ###
def seek(self, pos: int, whence: int = 0) -> int:
- """seek(pos: int, whence: int = 0) -> int. Change stream position.
+ """Change stream position.
Change the stream position to byte offset offset. offset is
interpreted relative to the position indicated by whence. Values
self._unsupported("seek")
def tell(self) -> int:
- """tell() -> int. Return current stream position."""
+ """Return current stream position."""
return self.seek(0, 1)
def truncate(self, pos: int = None) -> int:
- """truncate(pos: int = None) -> int. Truncate file to pos bytes.
+ """Truncate file to size bytes.
- Pos defaults to the current IO position as reported by tell().
- Returns the new size.
+ Size defaults to the current IO position as reported by tell(). Return
+ the new size.
"""
self._unsupported("truncate")
### Flush and close ###
def flush(self) -> None:
- """flush() -> None. Flushes write buffers, if applicable.
+ """Flush write buffers, if applicable.
This is not implemented for read-only and non-blocking streams.
"""
__closed = False
def close(self) -> None:
- """close() -> None. Flushes and closes the IO object.
+ """Flush and close the IO object.
This method has no effect if the file is already closed.
"""
### Inquiries ###
def seekable(self) -> bool:
- """seekable() -> bool. Return whether object supports random access.
+ """Return whether object supports random access.
If False, seek(), tell() and truncate() will raise IOError.
This method may need to do a test seek().
def readable(self) -> bool:
- """readable() -> bool. Return whether object was opened for reading.
+ """Return whether object was opened for reading.
If False, read() will raise IOError.
"""
if msg is None else msg)
def writable(self) -> bool:
- """writable() -> bool. Return whether object was opened for writing.
+ """Return whether object was opened for writing.
If False, write() and truncate() will raise IOError.
"""
# XXX Should these be present even if unimplemented?
def fileno(self) -> int:
- """fileno() -> int. Returns underlying file descriptor if one exists.
+ """Returns underlying file descriptor if one exists.
- Raises IOError if the IO object does not use a file descriptor.
+ An IOError is raised if the IO object does not use a file descriptor.
"""
self._unsupported("fileno")
def isatty(self) -> bool:
- """isatty() -> int. Returns whether this is an 'interactive' stream.
+ """Return whether this is an 'interactive' stream.
+
+ Return False if it can't be determined.
"""
self._checkClosed()
return False
### Readline[s] and writelines ###
def readline(self, limit: int = -1) -> bytes:
- r"""readline(limit: int = -1) -> bytes Read and return a line from the
- stream.
+ r"""Read and return a line from the stream.
If limit is specified, at most limit bytes will be read.
return line
def readlines(self, hint=None):
- """readlines(hint=None) -> list Return a list of lines from the stream.
+ """Return a list of lines from the stream.
hint can be specified to control the number of lines read: no more
lines will be read if the total size (in bytes/characters) of all
# a subclass doesn't implement either.)
def read(self, n: int = -1) -> bytes:
- """read(n: int) -> bytes. Read and return up to n bytes.
+ """Read and return up to n bytes.
Returns an empty bytes object on EOF, or None if the object is
set not to block and has no data to read.
return bytes(b)
def readall(self):
- """readall() -> bytes. Read until EOF, using multiple read() calls."""
+ """Read until EOF, using multiple read() call."""
res = bytearray()
while True:
data = self.read(DEFAULT_BUFFER_SIZE)
return bytes(res)
def readinto(self, b: bytearray) -> int:
- """readinto(b: bytearray) -> int. Read up to len(b) bytes into b.
+ """Read up to len(b) bytes into b.
Returns number of bytes read (0 for EOF), or None if the object
is set not to block as has no data to read.
self._unsupported("readinto")
def write(self, b: bytes) -> int:
- """write(b: bytes) -> int. Write the given buffer to the IO stream.
+ """Write the given buffer to the IO stream.
Returns the number of bytes written, which may be less than len(b).
"""
"""
def read(self, n: int = None) -> bytes:
- """read(n: int = None) -> bytes. Read and return up to n bytes.
+ """Read and return up to n bytes.
If the argument is omitted, None, or negative, reads and
returns all data until EOF.
self._unsupported("read")
def readinto(self, b: bytearray) -> int:
- """readinto(b: bytearray) -> int. Read up to len(b) bytes into b.
+ """Read up to len(b) bytes into b.
Like read(), this may issue multiple reads to the underlying raw
stream, unless the latter is 'interactive'.
return n
def write(self, b: bytes) -> int:
- """write(b: bytes) -> int. Write the given buffer to the IO stream.
+ """Write the given buffer to the IO stream.
- Returns the number of bytes written, which is never less than
+ Return the number of bytes written, which is never less than
len(b).
Raises BlockingIOError if the buffer is full and the
self._pos = 0
def getvalue(self):
- """getvalue() -> bytes Return the bytes value (contents) of the buffer
+ """Return the bytes value (contents) of the buffer
"""
return bytes(self._buffer)
class BufferedWriter(_BufferedIOMixin):
- """BufferedWriter(raw[, buffer_size[, max_buffer_size]])
-
- A buffer for a writeable sequential RawIO object.
+ """A buffer for a writeable sequential RawIO object.
The constructor creates a BufferedWriter for the given writeable raw
stream. If the buffer_size is not given, it defaults to
class BufferedRandom(BufferedWriter, BufferedReader):
- """BufferedRandom(raw[, buffer_size[, max_buffer_size]])
-
- A buffered interface to random access streams.
+ """A buffered interface to random access streams.
The constructor creates a reader and writer for a seekable stream,
raw, given in the first argument. If the buffer_size is omitted it
"""
def read(self, n: int = -1) -> str:
- """read(n: int = -1) -> str. Read at most n characters from stream.
+ """Read at most n characters from stream.
Read from underlying buffer until we have n characters or we hit EOF.
If n is negative or omitted, read until EOF.
self._unsupported("read")
def write(self, s: str) -> int:
- """write(s: str) -> int. Write string s to stream."""
+ """Write string s to stream."""
self._unsupported("write")
def truncate(self, pos: int = None) -> int:
- """truncate(pos: int = None) -> int. Truncate size to pos."""
+ """Truncate size to pos."""
self.flush()
if pos is None:
pos = self.tell()
return self.buffer.truncate()
def readline(self) -> str:
- """readline() -> str. Read until newline or EOF.
+ """Read until newline or EOF.
Returns an empty string if EOF is hit immediately.
"""
@property
def newlines(self):
- """newlines -> None | str | tuple of str. Line endings translated
- so far.
+ """Line endings translated so far.
Only line endings translated during reading are considered.
class TextIOWrapper(TextIOBase):
- r"""TextIOWrapper(buffer[, encoding[, errors[, newline[, line_buffering]]]])
-
- Character and line based layer over a BufferedIOBase object, buffer.
+ r"""Character and line based layer over a BufferedIOBase object, buffer.
encoding gives the name of the encoding that the stream will be
decoded or encoded with. It defaults to locale.getpreferredencoding.
return self._decoder.newlines if self._decoder else None
class StringIO(TextIOWrapper):
- """StringIO([initial_value[, encoding, [errors, [newline]]]])
-
- An in-memory stream for text. The initial_value argument sets the
+ """An in-memory stream for text. The initial_value argument sets the
value of object. The other arguments are like those of TextIOWrapper's
constructor.
"""
projects / python / commitdiff