PyDocs

Generic Operating System Services

io

The io module provides the Python interfaces to stream handling. The
builtin open function is defined in this module.

At the top of the I/O hierarchy is the abstract base class IOBase. It
defines the basic interface to a stream. Note, however, that there is no
separation between reading and writing to streams; implementations are
allowed to raise an OSError if they do not support a given operation.

Extending IOBase is RawIOBase which deals simply with the reading and
writing of raw bytes to a stream. FileIO subclasses RawIOBase to provide
an interface to OS files.

BufferedIOBase deals with buffering on a raw byte stream (RawIOBase). Its
subclasses, BufferedWriter, BufferedReader, and BufferedRWPair buffer
streams that are readable, writable, and both respectively.
BufferedRandom provides a buffered interface to random access
streams. BytesIO is a simple stream of in-memory bytes.

Another IOBase subclass, TextIOBase, deals with the encoding and decoding
of streams into text. TextIOWrapper, which extends it, is a buffered text
interface to a buffered raw stream (`BufferedIOBase`). Finally, StringIO
is an in-memory stream for text.

Argument names are not part of the specification, and only the arguments
of open() are intended to be used as keyword arguments.

data:

DEFAULT_BUFFER_SIZE

   An int containing the default buffer size used by the module's buffered
   I/O classes. open() uses the file's blksize (as obtained by os.stat) if
   possible.
Symbols in io

b

BlockingIOError
I/O operation would block.
BufferedIOBase
Base class for buffered IO objects.
BufferedRandom
A buffered interface to random access streams.
BufferedReader
Create a new buffered reader using the given readable raw IO object.
BufferedRWPair
A buffered reader and writer object together.
BufferedWriter
A buffer for a writeable sequential RawIO object.
BytesIO
Buffered I/O implementation using an in-memory bytes buffer.

d

DEFAULT_BUFFER_SIZE
An int containing the default buffer size used by the module’s buffered I/O classes.

f

FileIO
Open a file.

i

IncrementalNewlineDecoder
Codec used when reading a file in universal newlines mode.
IOBase
The abstract base class for all I/O classes.

o

open
Open file and return a stream.
open_code
Opens the provided file with the intent to import the contents.

r

RawIOBase
Base class for raw binary I/O.
Reader
Protocol for simple I/O reader instances.

s

StringIO
Text I/O implementation using an in-memory buffer.

t

text_encoding
A helper function to choose the text encoding.
TextIOBase
Base class for text I/O.
TextIOWrapper
Character and line based layer over a BufferedIOBase object, buffer.

u

UnsupportedOperation
An exception inheriting OSError and ValueError that is raised when an unsupported operation is called on a stream.

w

Writer
Protocol for simple I/O writer instances.