Back to index

python3.2  3.2.2
Classes | Variables
io Namespace Reference

Classes

class  IOBase
class  RawIOBase
class  BufferedIOBase
class  TextIOBase

Variables

tuple __author__
list __all__
 OpenWrapper = _io.open
int SEEK_SET = 0
int SEEK_CUR = 1
int SEEK_END = 2

Detailed Description

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 throw an IOError 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 a 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.

Variable Documentation

list io.__all__
Initial value:
00001 ["BlockingIOError", "open", "IOBase", "RawIOBase", "FileIO",
00002            "BytesIO", "StringIO", "BufferedIOBase",
00003            "BufferedReader", "BufferedWriter", "BufferedRWPair",
00004            "BufferedRandom", "TextIOBase", "TextIOWrapper",
00005            "UnsupportedOperation", "SEEK_SET", "SEEK_CUR", "SEEK_END"]

Definition at line 53 of file io.py.

Initial value:
00001 ("Guido van Rossum <guido@python.org>, "
00002               "Mike Verdone <mike.verdone@gmail.com>, "
00003               "Mark Russell <mark.russell@zen.co.uk>, "
00004               "Antoine Pitrou <solipsis@pitrou.net>, "
00005               "Amaury Forgeot d'Arc <amauryfa@gmail.com>, "
00006               "Benjamin Peterson <benjamin@python.org>")

Definition at line 46 of file io.py.

io.OpenWrapper = _io.open

Definition at line 68 of file io.py.

Definition at line 72 of file io.py.

Definition at line 73 of file io.py.

Definition at line 71 of file io.py.