io.rst 38.2 KB
Newer Older
1 2 3 4 5 6 7 8
:mod:`io` --- Core tools for working with streams
=================================================

.. module:: io
   :synopsis: Core tools for working with streams.
.. moduleauthor:: Guido van Rossum <guido@python.org>
.. moduleauthor:: Mike Verdone <mike.verdone@gmail.com>
.. moduleauthor:: Mark Russell <mark.russell@zen.co.uk>
9 10
.. moduleauthor:: Antoine Pitrou <solipsis@pitrou.net>
.. moduleauthor:: Amaury Forgeot d'Arc <amauryfa@gmail.com>
Benjamin Peterson's avatar
Benjamin Peterson committed
11
.. moduleauthor:: Benjamin Peterson <benjamin@python.org>
Benjamin Peterson's avatar
Benjamin Peterson committed
12
.. sectionauthor:: Benjamin Peterson <benjamin@python.org>
13

14 15
.. _io-overview:

16 17
Overview
--------
18

19 20 21 22 23 24 25 26 27
.. index::
   single: file object; io module

The :mod:`io` module provides Python's main facilities for dealing with various
types of I/O.  There are three main types of I/O: *text I/O*, *binary I/O*
and *raw I/O*.  These are generic categories, and various backing stores can
be used for each of them.  A concrete object belonging to any of these
categories is called a :term:`file object`.  Other common terms are *stream*
and *file-like object*.
28

29
Independently of its category, each concrete stream object will also have
30 31 32 33
various capabilities: it can be read-only, write-only, or read-write. It can
also allow arbitrary random access (seeking forwards or backwards to any
location), or only sequential access (for example in the case of a socket or
pipe).
34

35 36 37 38
All streams are careful about the type of data you give to them.  For example
giving a :class:`str` object to the ``write()`` method of a binary stream
will raise a ``TypeError``.  So will giving a :class:`bytes` object to the
``write()`` method of a text stream.
39

40
.. versionchanged:: 3.3
41 42
   Operations that used to raise :exc:`IOError` now raise :exc:`OSError`, since
   :exc:`IOError` is now an alias of :exc:`OSError`.
43

44

45 46
Text I/O
^^^^^^^^
47

48 49 50 51
Text I/O expects and produces :class:`str` objects.  This means that whenever
the backing store is natively made of bytes (such as in the case of a file),
encoding and decoding of data is made transparently as well as optional
translation of platform-specific newline characters.
52

53 54
The easiest way to create a text stream is with :meth:`open()`, optionally
specifying an encoding::
55 56 57 58 59 60 61

   f = open("myfile.txt", "r", encoding="utf-8")

In-memory text streams are also available as :class:`StringIO` objects::

   f = io.StringIO("some initial text data")

62
The text stream API is described in detail in the documentation of
63
:class:`TextIOBase`.
64 65 66 67 68


Binary I/O
^^^^^^^^^^

69 70 71 72
Binary I/O (also called *buffered I/O*) expects and produces :class:`bytes`
objects.  No encoding, decoding, or newline translation is performed.  This
category of streams can be used for all kinds of non-text data, and also when
manual control over the handling of text data is desired.
73

74 75
The easiest way to create a binary stream is with :meth:`open()` with ``'b'`` in
the mode string::
76 77 78 79 80 81 82

   f = open("myfile.jpg", "rb")

In-memory binary streams are also available as :class:`BytesIO` objects::

   f = io.BytesIO(b"some initial binary data: \x00\x01")

83 84
The binary stream API is described in detail in the docs of
:class:`BufferedIOBase`.
85 86

Other library modules may provide additional ways to create text or binary
87 88
streams.  See :meth:`socket.socket.makefile` for example.

89 90 91 92 93 94

Raw I/O
^^^^^^^

Raw I/O (also called *unbuffered I/O*) is generally used as a low-level
building-block for binary and text streams; it is rarely useful to directly
95 96
manipulate a raw stream from user code.  Nevertheless, you can create a raw
stream by opening a file in binary mode with buffering disabled::
97 98 99

   f = open("myfile.jpg", "rb", buffering=0)

100
The raw stream API is described in detail in the docs of :class:`RawIOBase`.
101

102

103 104
High-level Module Interface
---------------------------
105 106 107 108

.. data:: DEFAULT_BUFFER_SIZE

   An int containing the default buffer size used by the module's buffered I/O
109
   classes.  :func:`open` uses the file's blksize (as obtained by
110
   :func:`os.stat`) if possible.
111

112

113
.. function:: open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)
114

115
   This is an alias for the builtin :func:`open` function.
116 117 118 119


.. exception:: BlockingIOError

120 121
   This is a compatibility alias for the builtin :exc:`BlockingIOError`
   exception.
122 123 124 125


.. exception:: UnsupportedOperation

126
   An exception inheriting :exc:`OSError` and :exc:`ValueError` that is raised
127 128 129
   when an unsupported operation is called on a stream.


130 131 132 133
In-memory streams
^^^^^^^^^^^^^^^^^

It is also possible to use a :class:`str` or :class:`bytes`-like object as a
134 135 136 137
file for both reading and writing.  For strings :class:`StringIO` can be used
like a file opened in text mode.  :class:`BytesIO` can be used like a file
opened in binary mode.  Both provide full read-write capabilities with random
access.
138 139 140


.. seealso::
141

142 143 144 145 146 147 148 149
   :mod:`sys`
       contains the standard IO streams: :data:`sys.stdin`, :data:`sys.stdout`,
       and :data:`sys.stderr`.


Class hierarchy
---------------

150 151 152 153
The implementation of I/O streams is organized as a hierarchy of classes.  First
:term:`abstract base classes <abstract base class>` (ABCs), which are used to
specify the various categories of streams, then concrete classes providing the
standard stream implementations.
154 155

   .. note::
156 157 158 159

      The abstract base classes also provide default implementations of some
      methods in order to help implementation of concrete stream classes.  For
      example, :class:`BufferedIOBase` provides unoptimized implementations of
160
      :meth:`~IOBase.readinto` and :meth:`~IOBase.readline`.
161 162 163 164

At the top of the I/O hierarchy is the abstract base class :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
165
to raise :exc:`UnsupportedOperation` if they do not support a given operation.
166

167 168 169
The :class:`RawIOBase` ABC extends :class:`IOBase`.  It deals with the reading
and writing of bytes to a stream.  :class:`FileIO` subclasses :class:`RawIOBase`
to provide an interface to files in the machine's file system.
170 171 172 173

The :class:`BufferedIOBase` ABC deals with buffering on a raw byte stream
(:class:`RawIOBase`).  Its subclasses, :class:`BufferedWriter`,
:class:`BufferedReader`, and :class:`BufferedRWPair` buffer streams that are
174 175
readable, writable, and both readable and writable.  :class:`BufferedRandom`
provides a buffered interface to random access streams.  Another
176
:class:`BufferedIOBase` subclass, :class:`BytesIO`, is a stream of in-memory
177
bytes.
178

179 180 181 182 183
The :class:`TextIOBase` ABC, another subclass of :class:`IOBase`, deals with
streams whose bytes represent text, and handles encoding and decoding to and
from strings. :class:`TextIOWrapper`, which extends it, is a buffered text
interface to a buffered raw stream (:class:`BufferedIOBase`). Finally,
:class:`StringIO` is an in-memory stream for text.
184 185

Argument names are not part of the specification, and only the arguments of
186
:func:`open` are intended to be used as keyword arguments.
187

188 189
The following table summarizes the ABCs provided by the :mod:`io` module:

190 191
.. tabularcolumns:: |l|l|L|L|

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
=========================  ==================  ========================  ==================================================
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``
=========================  ==================  ========================  ==================================================

209

210
I/O Base Classes
211
^^^^^^^^^^^^^^^^
212 213 214 215 216 217

.. class:: IOBase

   The abstract base class for all I/O classes, acting on streams of bytes.
   There is no public constructor.

218 219 220 221
   This class provides empty abstract implementations for many methods
   that derived classes can override selectively; the default
   implementations represent a file that cannot be read, written or
   seeked.
222 223

   Even though :class:`IOBase` does not declare :meth:`read`, :meth:`readinto`,
224 225
   or :meth:`write` because their signatures will vary, implementations and
   clients should consider those methods part of the interface.  Also,
226 227
   implementations may raise a :exc:`ValueError` (or :exc:`UnsupportedOperation`)
   when operations they do not support are called.
228 229 230

   The basic type used for binary data read from or written to a file is
   :class:`bytes`.  :class:`bytearray`\s are accepted too, and in some cases
231
   (such as :meth:`readinto`) required.  Text I/O classes work with
232
   :class:`str` data.
233

234
   Note that calling any method (even inquiries) on a closed stream is
235
   undefined.  Implementations may raise :exc:`ValueError` in this case.
236

237
   :class:`IOBase` (and its subclasses) supports the iterator protocol, meaning
238 239 240 241
   that an :class:`IOBase` object can be iterated over yielding the lines in a
   stream.  Lines are defined slightly differently depending on whether the
   stream is a binary stream (yielding bytes), or a text stream (yielding
   character strings).  See :meth:`~IOBase.readline` below.
242

243
   :class:`IOBase` is also a context manager and therefore supports the
244 245
   :keyword:`with` statement.  In this example, *file* is closed after the
   :keyword:`with` statement's suite is finished---even if an exception occurs::
246

247 248
      with open('spam.txt', 'w') as file:
          file.write('Spam and eggs!')
249

250
   :class:`IOBase` provides these data attributes and methods:
251 252 253

   .. method:: close()

Christian Heimes's avatar
Christian Heimes committed
254
      Flush and close this stream. This method has no effect if the file is
255
      already closed. Once the file is closed, any operation on the file
Georg Brandl's avatar
Georg Brandl committed
256
      (e.g. reading or writing) will raise a :exc:`ValueError`.
257 258 259

      As a convenience, it is allowed to call this method more than once;
      only the first call, however, will have an effect.
260 261 262

   .. attribute:: closed

263
      ``True`` if the stream is closed.
264 265 266

   .. method:: fileno()

Christian Heimes's avatar
Christian Heimes committed
267
      Return the underlying file descriptor (an integer) of the stream if it
268
      exists.  An :exc:`OSError` is raised if the IO object does not use a file
269 270 271 272
      descriptor.

   .. method:: flush()

Benjamin Peterson's avatar
Benjamin Peterson committed
273 274
      Flush the write buffers of the stream if applicable.  This does nothing
      for read-only and non-blocking streams.
275 276 277

   .. method:: isatty()

Christian Heimes's avatar
Christian Heimes committed
278
      Return ``True`` if the stream is interactive (i.e., connected to
279
      a terminal/tty device).
280 281 282

   .. method:: readable()

283
      Return ``True`` if the stream can be read from.  If ``False``, :meth:`read`
284
      will raise :exc:`OSError`.
285

286
   .. method:: readline(size=-1)
287

288 289
      Read and return one line from the stream.  If *size* is specified, at
      most *size* bytes will be read.
290

291
      The line terminator is always ``b'\n'`` for binary files; for text files,
292
      the *newline* argument to :func:`open` can be used to select the line
293 294
      terminator(s) recognized.

295
   .. method:: readlines(hint=-1)
296

Christian Heimes's avatar
Christian Heimes committed
297 298 299
      Read and 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 lines so far exceeds *hint*.
300

301 302 303
      Note that it's already possible to iterate on file objects using ``for
      line in file: ...`` without calling ``file.readlines()``.

304
   .. method:: seek(offset, whence=SEEK_SET)
305

306
      Change the stream position to the given byte *offset*.  *offset* is
307 308 309
      interpreted relative to the position indicated by *whence*.  Values for
      *whence* are:

310 311 312 313 314 315
      * :data:`SEEK_SET` or ``0`` -- start of the stream (the default);
        *offset* should be zero or positive
      * :data:`SEEK_CUR` or ``1`` -- current stream position; *offset* may
        be negative
      * :data:`SEEK_END` or ``2`` -- end of the stream; *offset* is usually
        negative
316

Christian Heimes's avatar
Christian Heimes committed
317
      Return the new absolute position.
318

319
      .. versionadded:: 3.1
320
         The ``SEEK_*`` constants.
321

322 323 324 325 326
      .. versionadded:: 3.3
         Some operating systems could support additional values, like
         :data:`os.SEEK_HOLE` or :data:`os.SEEK_DATA`. The valid values
         for a file could depend on it being open in text or binary mode.

327 328
   .. method:: seekable()

Christian Heimes's avatar
Christian Heimes committed
329
      Return ``True`` if the stream supports random access.  If ``False``,
330
      :meth:`seek`, :meth:`tell` and :meth:`truncate` will raise :exc:`OSError`.
331 332 333

   .. method:: tell()

Christian Heimes's avatar
Christian Heimes committed
334
      Return the current stream position.
335

336
   .. method:: truncate(size=None)
337

338 339 340 341
      Resize the stream to the given *size* in bytes (or the current position
      if *size* is not specified).  The current stream position isn't changed.
      This resizing can extend or reduce the current file size.  In case of
      extension, the contents of the new file area depend on the platform
342 343 344 345 346
      (on most systems, additional bytes are zero-filled).  The new file size
      is returned.

   .. versionchanged:: 3.5
      Windows will now zero-fill files when extending.
347

348 349
   .. method:: writable()

Christian Heimes's avatar
Christian Heimes committed
350
      Return ``True`` if the stream supports writing.  If ``False``,
351
      :meth:`write` and :meth:`truncate` will raise :exc:`OSError`.
352 353 354

   .. method:: writelines(lines)

Christian Heimes's avatar
Christian Heimes committed
355 356 357
      Write a list of lines to the stream.  Line separators are not added, so it
      is usual for each of the lines provided to have a line separator at the
      end.
358

359 360 361 362 363 364
   .. method:: __del__()

      Prepare for object destruction. :class:`IOBase` provides a default
      implementation of this method that calls the instance's
      :meth:`~IOBase.close` method.

365 366 367 368 369 370

.. class:: RawIOBase

   Base class for raw binary I/O.  It inherits :class:`IOBase`.  There is no
   public constructor.

371 372 373 374
   Raw binary I/O typically provides low-level access to an underlying OS
   device or API, and does not try to encapsulate it in high-level primitives
   (this is left to Buffered I/O and Text I/O, described later in this page).

375
   In addition to the attributes and methods from :class:`IOBase`,
376
   :class:`RawIOBase` provides the following methods:
377

378
   .. method:: read(size=-1)
379

380 381 382 383
      Read up to *size* bytes from the object and return them.  As a convenience,
      if *size* is unspecified or -1, :meth:`readall` is called.  Otherwise,
      only one system call is ever made.  Fewer than *size* bytes may be
      returned if the operating system call returns fewer than *size* bytes.
384

385
      If 0 bytes are returned, and *size* was not 0, this indicates end of file.
386 387
      If the object is in non-blocking mode and no bytes are available,
      ``None`` is returned.
388

389
   .. method:: readall()
390

Christian Heimes's avatar
Christian Heimes committed
391 392
      Read and return all the bytes from the stream until EOF, using multiple
      calls to the stream if necessary.
393 394 395

   .. method:: readinto(b)

396
      Read up to ``len(b)`` bytes into :class:`bytearray` *b* and return the
Benjamin Peterson's avatar
Benjamin Peterson committed
397 398
      number of bytes read.  If the object is in non-blocking mode and no bytes
      are available, ``None`` is returned.
399 400 401

   .. method:: write(b)

402 403 404 405 406 407
      Write the given :class:`bytes` or :class:`bytearray` object, *b*, to the
      underlying raw stream and return the number of bytes written.  This can
      be less than ``len(b)``, depending on specifics of the underlying raw
      stream, and especially if it is in non-blocking mode.  ``None`` is
      returned if the raw stream is set not to block and no single byte could
      be readily written to it.
408 409 410 411


.. class:: BufferedIOBase

412 413
   Base class for binary streams that support some kind of buffering.
   It inherits :class:`IOBase`. There is no public constructor.
414

415 416 417 418
   The main difference with :class:`RawIOBase` is that methods :meth:`read`,
   :meth:`readinto` and :meth:`write` will try (respectively) to read as much
   input as requested or to consume all given output, at the expense of
   making perhaps more than one system call.
419

420 421 422 423
   In addition, those methods can raise :exc:`BlockingIOError` if the
   underlying raw stream is in non-blocking mode and cannot take or give
   enough data; unlike their :class:`RawIOBase` counterparts, they will
   never return ``None``.
424

425 426 427 428 429 430
   Besides, the :meth:`read` method does not have a default
   implementation that defers to :meth:`readinto`.

   A typical :class:`BufferedIOBase` implementation should not inherit from a
   :class:`RawIOBase` implementation, but wrap one, like
   :class:`BufferedWriter` and :class:`BufferedReader` do.
431

432 433
   :class:`BufferedIOBase` provides or overrides these methods and attribute in
   addition to those from :class:`IOBase`:
434

435 436 437 438 439 440
   .. attribute:: raw

      The underlying raw stream (a :class:`RawIOBase` instance) that
      :class:`BufferedIOBase` deals with.  This is not part of the
      :class:`BufferedIOBase` API and may not exist on some implementations.

441 442 443 444 445 446 447 448 449 450 451
   .. method:: detach()

      Separate the underlying raw stream from the buffer and return it.

      After the raw stream has been detached, the buffer is in an unusable
      state.

      Some buffers, like :class:`BytesIO`, do not have the concept of a single
      raw stream to return from this method.  They raise
      :exc:`UnsupportedOperation`.

Benjamin Peterson's avatar
Benjamin Peterson committed
452 453
      .. versionadded:: 3.1

454
   .. method:: read(size=-1)
455

456 457
      Read and return up to *size* bytes.  If the argument is omitted, ``None``,
      or negative, data is read and returned until EOF is reached.  An empty
458
      :class:`bytes` object is returned if the stream is already at EOF.
459 460 461 462 463 464 465

      If the argument is positive, and the underlying raw stream is not
      interactive, multiple raw reads may be issued to satisfy the byte count
      (unless EOF is reached first).  But for interactive raw streams, at most
      one raw read will be issued, and a short result does not imply that EOF is
      imminent.

466 467
      A :exc:`BlockingIOError` is raised if the underlying raw stream is in
      non blocking-mode, and has no data available at the moment.
468

469
   .. method:: read1(size=-1)
470

471 472
      Read and return up to *size* bytes, with at most one call to the
      underlying raw stream's :meth:`~RawIOBase.read` (or
Benjamin Peterson's avatar
Benjamin Peterson committed
473 474 475
      :meth:`~RawIOBase.readinto`) method.  This can be useful if you are
      implementing your own buffering on top of a :class:`BufferedIOBase`
      object.
476

477 478
   .. method:: readinto(b)

479 480
      Read up to ``len(b)`` bytes into bytearray *b* and return the number of
      bytes read.
481 482

      Like :meth:`read`, multiple reads may be issued to the underlying raw
483
      stream, unless the latter is interactive.
484

Benjamin Peterson's avatar
Benjamin Peterson committed
485 486
      A :exc:`BlockingIOError` is raised if the underlying raw stream is in non
      blocking-mode, and has no data available at the moment.
487

488 489
   .. method:: readinto1(b)

Benjamin Peterson's avatar
Benjamin Peterson committed
490 491 492
      Read up to ``len(b)`` bytes into bytearray *b*, ,using at most one call to
      the underlying raw stream's :meth:`~RawIOBase.read` (or
      :meth:`~RawIOBase.readinto`) method. Return the number of bytes read.
493

Benjamin Peterson's avatar
Benjamin Peterson committed
494 495
      A :exc:`BlockingIOError` is raised if the underlying raw stream is in non
      blocking-mode, and has no data available at the moment.
496 497 498

      .. versionadded:: 3.5

499 500
   .. method:: write(b)

501 502 503 504 505 506
      Write the given :class:`bytes` or :class:`bytearray` object, *b* and
      return the number of bytes written (never less than ``len(b)``, since if
      the write fails an :exc:`OSError` will be raised).  Depending on the
      actual implementation, these bytes may be readily written to the
      underlying stream, or held in a buffer for performance and latency
      reasons.
507

508 509 510
      When in non-blocking mode, a :exc:`BlockingIOError` is raised if the
      data needed to be written to the raw stream but it couldn't accept
      all the data without blocking.
511 512


513
Raw File I/O
514
^^^^^^^^^^^^
515

516
.. class:: FileIO(name, mode='r', closefd=True, opener=None)
517

518 519 520 521 522 523
   :class:`FileIO` represents an OS-level file containing bytes data.
   It implements the :class:`RawIOBase` interface (and therefore the
   :class:`IOBase` interface, too).

   The *name* can be one of two things:

524
   * a character string or :class:`bytes` object representing the path to the
525 526
     file which will be opened. In this case closefd must be True (the default)
     otherwise an error will be raised.
527
   * an integer representing the number of an existing OS-level file descriptor
528 529 530
     to which the resulting :class:`FileIO` object will give access. When the
     FileIO object is closed this fd will be closed as well, unless *closefd*
     is set to ``False``.
531

532
   The *mode* can be ``'r'``, ``'w'``, ``'x'`` or ``'a'`` for reading
533 534 535 536 537 538
   (default), writing, exclusive creation or appending. The file will be
   created if it doesn't exist when opened for writing or appending; it will be
   truncated when opened for writing. :exc:`FileExistsError` will be raised if
   it already exists when opened for creating. Opening a file for creating
   implies writing, so this mode behaves in a similar way to ``'w'``. Add a
   ``'+'`` to the mode to allow simultaneous reading and writing.
539

540 541 542
   The :meth:`read` (when called with a positive argument), :meth:`readinto`
   and :meth:`write` methods on this class will only make one system call.

543 544 545 546 547 548
   A custom opener can be used by passing a callable as *opener*. The underlying
   file descriptor for the file object is then obtained by calling *opener* with
   (*name*, *flags*). *opener* must return an open file descriptor (passing
   :mod:`os.open` as *opener* results in functionality similar to passing
   ``None``).

549 550
   The newly created file is :ref:`non-inheritable <fd_inheritance>`.

551 552 553
   See the :func:`open` built-in function for examples on using the *opener*
   parameter.

554 555
   .. versionchanged:: 3.3
      The *opener* parameter was added.
556
      The ``'x'`` mode was added.
557

558 559 560
   .. versionchanged:: 3.4
      The file is now non-inheritable.

561 562
   In addition to the attributes and methods from :class:`IOBase` and
   :class:`RawIOBase`, :class:`FileIO` provides the following data
563
   attributes:
564 565 566 567 568 569 570 571 572 573 574 575

   .. attribute:: mode

      The mode as given in the constructor.

   .. attribute:: name

      The file name.  This is the file descriptor of the file when no name is
      given in the constructor.


Buffered Streams
576
^^^^^^^^^^^^^^^^
577

578 579
Buffered I/O streams provide a higher-level interface to an I/O device
than raw I/O does.
580

581 582 583
.. class:: BytesIO([initial_bytes])

   A stream implementation using an in-memory bytes buffer.  It inherits
584 585
   :class:`BufferedIOBase`.  The buffer is discarded when the
   :meth:`~IOBase.close` method is called.
586

587
   The argument *initial_bytes* contains optional initial :class:`bytes` data.
588 589 590 591

   :class:`BytesIO` provides or overrides these methods in addition to those
   from :class:`BufferedIOBase` and :class:`IOBase`:

592 593 594 595 596 597 598 599 600 601 602 603 604 605
   .. method:: getbuffer()

      Return a readable and writable view over the contents of the buffer
      without copying them.  Also, mutating the view will transparently
      update the contents of the buffer::

         >>> b = io.BytesIO(b"abcdef")
         >>> view = b.getbuffer()
         >>> view[2:4] = b"56"
         >>> b.getvalue()
         b'ab56ef'

      .. note::
         As long as the view exists, the :class:`BytesIO` object cannot be
606
         resized or closed.
607 608 609

      .. versionadded:: 3.2

610 611
   .. method:: getvalue()

612
      Return :class:`bytes` containing the entire contents of the buffer.
613

614

615 616
   .. method:: read1()

617
      In :class:`BytesIO`, this is the same as :meth:`read`.
618

619 620 621 622 623
   .. method:: readinto1()

      In :class:`BytesIO`, this is the same as :meth:`readinto`.

      .. versionadded:: 3.5
624

625
.. class:: BufferedReader(raw, buffer_size=DEFAULT_BUFFER_SIZE)
626

627 628 629 630 631
   A buffer providing higher-level access to a readable, sequential
   :class:`RawIOBase` object.  It inherits :class:`BufferedIOBase`.
   When reading data from this object, a larger amount of data may be
   requested from the underlying raw stream, and kept in an internal buffer.
   The buffered data can then be returned directly on subsequent reads.
632 633 634 635 636 637 638 639

   The constructor creates a :class:`BufferedReader` for the given readable
   *raw* stream and *buffer_size*.  If *buffer_size* is omitted,
   :data:`DEFAULT_BUFFER_SIZE` is used.

   :class:`BufferedReader` provides or overrides these methods in addition to
   those from :class:`BufferedIOBase` and :class:`IOBase`:

640
   .. method:: peek([size])
641

Benjamin Peterson's avatar
Benjamin Peterson committed
642
      Return bytes from the stream without advancing the position.  At most one
643 644
      single read on the raw stream is done to satisfy the call. The number of
      bytes returned may be less or more than requested.
645

646
   .. method:: read([size])
647

648 649
      Read and return *size* bytes, or if *size* is not given or negative, until
      EOF or if the read call would block in non-blocking mode.
650

651
   .. method:: read1(size)
652

653 654
      Read and return up to *size* bytes with only one call on the raw stream.
      If at least one byte is buffered, only buffered bytes are returned.
655 656 657
      Otherwise, one raw stream read call is made.


658
.. class:: BufferedWriter(raw, buffer_size=DEFAULT_BUFFER_SIZE)
659

660 661
   A buffer providing higher-level access to a writeable, sequential
   :class:`RawIOBase` object.  It inherits :class:`BufferedIOBase`.
662
   When writing to this object, data is normally placed into an internal
663 664 665 666 667 668 669
   buffer.  The buffer will be written out to the underlying :class:`RawIOBase`
   object under various conditions, including:

   * when the buffer gets too small for all pending data;
   * when :meth:`flush()` is called;
   * when a :meth:`seek()` is requested (for :class:`BufferedRandom` objects);
   * when the :class:`BufferedWriter` object is closed or destroyed.
670 671 672

   The constructor creates a :class:`BufferedWriter` for the given writeable
   *raw* stream.  If the *buffer_size* is not given, it defaults to
673 674
   :data:`DEFAULT_BUFFER_SIZE`.

675 676 677 678 679 680
   :class:`BufferedWriter` provides or overrides these methods in addition to
   those from :class:`BufferedIOBase` and :class:`IOBase`:

   .. method:: flush()

      Force bytes held in the buffer into the raw stream.  A
681
      :exc:`BlockingIOError` should be raised if the raw stream blocks.
682 683 684

   .. method:: write(b)

685 686 687 688
      Write the :class:`bytes` or :class:`bytearray` object, *b* and return the
      number of bytes written.  When in non-blocking mode, a
      :exc:`BlockingIOError` is raised if the buffer needs to be written out but
      the raw stream blocks.
689 690


691
.. class:: BufferedRandom(raw, buffer_size=DEFAULT_BUFFER_SIZE)
692 693

   A buffered interface to random access streams.  It inherits
694 695
   :class:`BufferedReader` and :class:`BufferedWriter`, and further supports
   :meth:`seek` and :meth:`tell` functionality.
696

697
   The constructor creates a reader and writer for a seekable raw stream, given
698
   in the first argument.  If the *buffer_size* is omitted it defaults to
699 700
   :data:`DEFAULT_BUFFER_SIZE`.

701 702 703 704
   :class:`BufferedRandom` is capable of anything :class:`BufferedReader` or
   :class:`BufferedWriter` can do.


705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
.. class:: BufferedRWPair(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE)

   A buffered I/O object combining two unidirectional :class:`RawIOBase`
   objects -- one readable, the other writeable -- into a single bidirectional
   endpoint.  It inherits :class:`BufferedIOBase`.

   *reader* and *writer* are :class:`RawIOBase` objects that are readable and
   writeable respectively.  If the *buffer_size* is omitted it defaults to
   :data:`DEFAULT_BUFFER_SIZE`.

   :class:`BufferedRWPair` implements all of :class:`BufferedIOBase`\'s methods
   except for :meth:`~BufferedIOBase.detach`, which raises
   :exc:`UnsupportedOperation`.

   .. warning::
720

721 722 723 724 725
      :class:`BufferedRWPair` does not attempt to synchronize accesses to
      its underlying raw streams.  You should not pass it the same object
      as reader and writer; use :class:`BufferedRandom` instead.


726
Text I/O
727
^^^^^^^^
728 729 730 731 732 733 734 735

.. class:: TextIOBase

   Base class for text streams.  This class provides a character and line based
   interface to stream I/O.  There is no :meth:`readinto` method because
   Python's character strings are immutable.  It inherits :class:`IOBase`.
   There is no public constructor.

736 737
   :class:`TextIOBase` provides or overrides these data attributes and
   methods in addition to those from :class:`IOBase`:
738 739 740

   .. attribute:: encoding

741
      The name of the encoding used to decode the stream's bytes into
742 743
      strings, and to encode strings into bytes.

744 745 746 747
   .. attribute:: errors

      The error setting of the decoder or encoder.

748 749
   .. attribute:: newlines

750
      A string, a tuple of strings, or ``None``, indicating the newlines
751 752
      translated so far.  Depending on the implementation and the initial
      constructor flags, this may not be available.
753

754 755 756 757
   .. attribute:: buffer

      The underlying binary buffer (a :class:`BufferedIOBase` instance) that
      :class:`TextIOBase` deals with.  This is not part of the
758
      :class:`TextIOBase` API and may not exist in some implementations.
759

760 761
   .. method:: detach()

762 763
      Separate the underlying binary buffer from the :class:`TextIOBase` and
      return it.
764 765 766 767 768 769 770 771

      After the underlying buffer has been detached, the :class:`TextIOBase` is
      in an unusable state.

      Some :class:`TextIOBase` implementations, like :class:`StringIO`, may not
      have the concept of an underlying buffer and calling this method will
      raise :exc:`UnsupportedOperation`.

Benjamin Peterson's avatar
Benjamin Peterson committed
772 773
      .. versionadded:: 3.1

774
   .. method:: read(size)
775

776 777
      Read and return at most *size* characters from the stream as a single
      :class:`str`.  If *size* is negative or ``None``, reads until EOF.
778

779
   .. method:: readline(size=-1)
780

Christian Heimes's avatar
Christian Heimes committed
781 782
      Read until newline or EOF and return a single ``str``.  If the stream is
      already at EOF, an empty string is returned.
783

784
      If *size* is specified, at most *size* characters will be read.
785

786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
   .. method:: seek(offset, whence=SEEK_SET)

      Change the stream position to the given *offset*.  Behaviour depends
      on the *whence* parameter:

      * :data:`SEEK_SET` or ``0``: seek from the start of the stream
        (the default); *offset* must either be a number returned by
        :meth:`TextIOBase.tell`, or zero.  Any other *offset* value
        produces undefined behaviour.
      * :data:`SEEK_CUR` or ``1``: "seek" to the current position;
        *offset* must be zero, which is a no-operation (all other values
        are unsupported).
      * :data:`SEEK_END` or ``2``: seek to the end of the stream;
        *offset* must be zero (all other values are unsupported).

      Return the new absolute position as an opaque number.

      .. versionadded:: 3.1
         The ``SEEK_*`` constants.

   .. method:: tell()

      Return the current stream position as an opaque number.  The number
      does not usually represent a number of bytes in the underlying
      binary storage.

812 813
   .. method:: write(s)

Christian Heimes's avatar
Christian Heimes committed
814 815
      Write the string *s* to the stream and return the number of characters
      written.
816 817


818 819
.. class:: TextIOWrapper(buffer, encoding=None, errors=None, newline=None, \
                         line_buffering=False, write_through=False)
820

821
   A buffered text stream over a :class:`BufferedIOBase` binary stream.
822 823 824
   It inherits :class:`TextIOBase`.

   *encoding* gives the name of the encoding that the stream will be decoded or
825 826
   encoded with.  It defaults to
   :func:`locale.getpreferredencoding(False) <locale.getpreferredencoding>`.
827

Benjamin Peterson's avatar
Benjamin Peterson committed
828 829 830 831 832
   *errors* is an optional string that specifies how encoding and decoding
   errors are to be handled.  Pass ``'strict'`` to raise a :exc:`ValueError`
   exception if there is an encoding error (the default of ``None`` has the same
   effect), or pass ``'ignore'`` to ignore errors.  (Note that ignoring encoding
   errors can lead to data loss.)  ``'replace'`` causes a replacement marker
833 834 835 836 837 838
   (such as ``'?'``) to be inserted where there is malformed data.
   ``'backslashreplace'`` causes malformed data to be replaced by a
   backslashed escape sequence.  When writing, ``'xmlcharrefreplace'``
   (replace with the appropriate XML character reference)  or ``'namereplace'``
   (replace with ``\N{...}`` escape sequences) can be used.  Any other error
   handling name that has been registered with
839
   :func:`codecs.register_error` is also valid.
840

841 842 843
   .. index::
      single: universal newlines; io.TextIOWrapper class

844 845 846
   *newline* controls how line endings are handled.  It can be ``None``,
   ``''``, ``'\n'``, ``'\r'``, and ``'\r\n'``.  It works as follows:

847
   * When reading input from the stream, if *newline* is ``None``,
848 849 850 851 852 853 854
     :term:`universal newlines` mode is enabled.  Lines in the input can end in
     ``'\n'``, ``'\r'``, or ``'\r\n'``, and these are translated into ``'\n'``
     before being returned to the caller.  If it is ``''``, universal newlines
     mode is enabled, but line endings are returned to the caller untranslated.
     If it has any of the other legal values, input lines are only terminated
     by the given string, and the line ending is returned to the caller
     untranslated.
855 856 857 858 859 860

   * When writing output to the stream, if *newline* is ``None``, any ``'\n'``
     characters written are translated to the system default line separator,
     :data:`os.linesep`.  If *newline* is ``''`` or ``'\n'``, no translation
     takes place.  If *newline* is any of the other legal values, any ``'\n'``
     characters written are translated to the given string.
861 862 863 864

   If *line_buffering* is ``True``, :meth:`flush` is implied when a call to
   write contains a newline character.

865 866 867 868 869 870 871
   If *write_through* is ``True``, calls to :meth:`write` are guaranteed
   not to be buffered: any data written on the :class:`TextIOWrapper`
   object is immediately handled to its underlying binary *buffer*.

   .. versionchanged:: 3.3
      The *write_through* argument has been added.

872 873 874 875 876 877
   .. versionchanged:: 3.3
      The default *encoding* is now ``locale.getpreferredencoding(False)``
      instead of ``locale.getpreferredencoding()``. Don't change temporary the
      locale encoding using :func:`locale.setlocale`, use the current locale
      encoding instead of the user preferred encoding.

878
   :class:`TextIOWrapper` provides one attribute in addition to those of
879 880 881 882 883
   :class:`TextIOBase` and its parents:

   .. attribute:: line_buffering

      Whether line buffering is enabled.
884

885

886
.. class:: StringIO(initial_value='', newline='\\n')
887

888 889
   An in-memory stream for text I/O.  The text buffer is discarded when the
   :meth:`~IOBase.close` method is called.
890

891 892
   The initial value of the buffer (an empty string by default) can be set by
   providing *initial_value*.  The *newline* argument works like that of
893 894
   :class:`TextIOWrapper`.  The default is to consider only ``\n`` characters
   as end of lines and to do no newline translation.
895

896
   :class:`StringIO` provides this method in addition to those from
897
   :class:`TextIOBase` and its parents:
898 899 900

   .. method:: getvalue()

901
      Return a ``str`` containing the entire contents of the buffer.
902

903 904 905 906 907 908 909 910 911 912 913 914
   Example usage::

      import io

      output = io.StringIO()
      output.write('First line.\n')
      print('Second line.', file=output)

      # Retrieve file contents -- this will be
      # 'First line.\nSecond line.\n'
      contents = output.getvalue()

915
      # Close object and discard memory buffer --
916 917
      # .getvalue() will now raise an exception.
      output.close()
918

919

920 921 922
.. index::
   single: universal newlines; io.IncrementalNewlineDecoder class

923 924
.. class:: IncrementalNewlineDecoder

925 926
   A helper codec that decodes newlines for :term:`universal newlines` mode.
   It inherits :class:`codecs.IncrementalDecoder`.
927

928 929

Performance
930 931 932 933
-----------

This section discusses the performance of the provided concrete I/O
implementations.
934 935

Binary I/O
936 937 938 939 940 941 942 943
^^^^^^^^^^

By reading and writing only large chunks of data even when the user asks for a
single byte, buffered I/O hides any inefficiency in calling and executing the
operating system's unbuffered I/O routines.  The gain depends on the OS and the
kind of I/O which is performed.  For example, on some modern OSes such as Linux,
unbuffered disk I/O can be as fast as buffered I/O.  The bottom line, however,
is that buffered I/O offers predictable performance regardless of the platform
944 945
and the backing device.  Therefore, it is almost always preferable to use
buffered I/O rather than unbuffered I/O for binary data.
946 947

Text I/O
948
^^^^^^^^
949 950

Text I/O over a binary storage (such as a file) is significantly slower than
951 952 953 954 955
binary I/O over the same storage, because it requires conversions between
unicode and binary data using a character codec.  This can become noticeable
handling huge amounts of text data like large log files.  Also,
:meth:`TextIOWrapper.tell` and :meth:`TextIOWrapper.seek` are both quite slow
due to the reconstruction algorithm used.
956 957 958 959 960 961 962

:class:`StringIO`, however, is a native in-memory unicode container and will
exhibit similar speed to :class:`BytesIO`.

Multi-threading
^^^^^^^^^^^^^^^

963 964
:class:`FileIO` objects are thread-safe to the extent that the operating system
calls (such as ``read(2)`` under Unix) they wrap are thread-safe too.
965 966 967 968 969 970 971 972 973 974 975 976 977 978

Binary buffered objects (instances of :class:`BufferedReader`,
:class:`BufferedWriter`, :class:`BufferedRandom` and :class:`BufferedRWPair`)
protect their internal structures using a lock; it is therefore safe to call
them from multiple threads at once.

:class:`TextIOWrapper` objects are not thread-safe.

Reentrancy
^^^^^^^^^^

Binary buffered objects (instances of :class:`BufferedReader`,
:class:`BufferedWriter`, :class:`BufferedRandom` and :class:`BufferedRWPair`)
are not reentrant.  While reentrant calls will not happen in normal situations,
979
they can arise from doing I/O in a :mod:`signal` handler.  If a thread tries to
980 981
re-enter a buffered object which it is already accessing, a :exc:`RuntimeError`
is raised.  Note this doesn't prohibit a different thread from entering the
982 983 984 985 986 987
buffered object.

The above implicitly extends to text files, since the :func:`open()` function
will wrap a buffered object inside a :class:`TextIOWrapper`.  This includes
standard streams and therefore affects the built-in function :func:`print()` as
well.
988