# `io` --- 处理流的核心工具

源代码: Lib/io.py

## 總覽

`io` 模块提供了 Python 用于处理各种 I/O 类型的主要工具。三种主要的 I/O类型分别为: 文本 I/O, 二进制 I/O 和 原始 I/O。这些是泛型类型，有很多种后端存储可以用在他们上面。一个隶属于任何这些类型的具体对象被称作 file object。 其他同类的术语还有 流 和 类文件对象。

独立于其类别，每个具体流对象也将具有各种功能：它可以是只读，只写或读写。它还可以允许任意随机访问（向前或向后寻找任何位置），或仅允许顺序访问（例如在套接字或管道的情况下）。

所有流对提供给它们的数据类型都很敏感。例如将 `str` 对象给二进制流的 `write()` 方法会引发 `TypeError`。将 `bytes` 对象提供给文本流的 `write()` 方法也是如此。

3.3 版更變: 由于 `IOError` 现在是 `OSError` 的别名，因此用于引发 `IOError` 的操作现在会引发 `OSError` 。

### 文本 I/O

文本I/O预期并生成 `str` 对象。这意味着，无论何时后台存储是由字节组成的（例如在文件的情况下），数据的编码和解码都是透明的，并且可以选择转换特定于平台的换行符。

创建文本流的最简单方法是使用 `open()`，可以选择指定编码：

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

内存中文本流也可以作为 `StringIO` 对象使用：

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

`TextIOBase` 的文档中详细描述了文本流的API

### 二进制 I/O

二进制I/O（也称为缓冲I/O）预期 bytes-like objects 并生成 `bytes` 对象。不执行编码、解码或换行转换。这种类型的流可以用于所有类型的非文本数据，并且还可以在需要手动控制文本数据的处理时使用。

创建二进制流的最简单方法是使用 `open()`，并在模式字符串中指定 `'b'` ：

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

内存中二进制流也可以作为 `BytesIO` 对象使用：

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

`BufferedIOBase` 的文档中详细描述了二进制流的API

其他库模块可以提供额外的方式来创建文本或二进制流。参见 `socket.socket.makefile()` 的示例。

### 原始 I/O

原始 I/O（也称为 非缓冲 I/O）通常用作二进制和文本流的低级构建块。用户代码直接操作原始流的用法非常罕见。不过，可以通过在禁用缓冲的情况下以二进制模式打开文件来创建原始流：

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

`RawIOBase` 的文档中详细描述了原始流的API

## 高阶模块接口

`io.``DEFAULT_BUFFER_SIZE`

  包含模块缓冲I/O类使用的默认缓冲区大小的整数。（如果可能） `open()` 将使用文件的blksize（由 `os.stat()` 获得）。

`io.``open`(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

  这是内置的 `open()` 函数的别名。

  `open` 附带参数 `path`、`mode`、`flags` 会引发 审计事件。

`io.``open_code`(path)

  以 `'rb'` 模式打开提供的文件。如果目的是将文件内容做为可执行代码，则应使用此函数。

  `path` 应当是绝对路径。

  此函数的行为可能会被先前对 `PyFile_SetOpenCodeHook()` 的调用所覆盖，但是，应该始终认为它与 `open(path, 'rb')` 可相互替换。重写行为是为了对文件进行额外的验证或预处理。

  3.8 版新加入.

exception `io.``BlockingIOError`

  这是内置的 `BlockingIOError` 异常的兼容性别名。

exception `io.``UnsupportedOperation`

  在流上调用不支持的操作时引发的继承 `OSError` 和 `ValueError` 的异常。

### 内存中的流

也可以使用 `str` 或 bytes-like object 作为文件进行读取和写入。对于字符串， `StringIO` 可以像在文本模式下打开的文件一样使用。 `BytesIO` 可以像以二进制模式打开的文件一样使用。两者都提供完整的随机读写功能。

也參考

`sys`

  包含标准IO流: `sys.stdin`, `sys.stdout` 和 `sys.stderr` 。

## 类的层次结构

I/O 流被安排为按类的层次结构实现。 首先是 抽象基类 (ABC)，用于指定流的各种类别，然后是提供标准流实现的具体类。

> 備註

> 抽象基类还提供某些方法的默认实现，以帮助实现具体的流类。例如 `BufferedIOBase` 提供了 `readinto()` 和 `readline()` 的未优化实现。

I/O层次结构的顶部是抽象基类 `IOBase` 。它定义了流的基本接口。但是请注意，对流的读取和写入之间没有分离。如果实现不支持指定的操作，则会引发 `UnsupportedOperation` 。

抽象基类 `RawIOBase` 是 `IOBase` 的子类。它负责将字节读取和写入流中。 `RawIOBase` 的子类 `FileIO` 提供计算机文件系统中文件的接口。

The `BufferedIOBase` ABC extends `IOBase`. It deals with buffering on a raw binary stream (`RawIOBase`). Its subclasses, `BufferedWriter`, `BufferedReader`, and `BufferedRWPair` buffer raw binary streams that are readable, writable, and both readable and writable, respectively. `BufferedRandom` provides a buffered interface to seekable streams. Another `BufferedIOBase` subclass, `BytesIO`, is a stream of in-memory bytes.

The `TextIOBase` ABC extends `IOBase`. It deals with streams whose bytes represent text, and handles encoding and decoding to and from strings. `TextIOWrapper`, which extends `TextIOBase`, is a buffered text interface to a buffered raw stream (`BufferedIOBase`). Finally, `StringIO` is an in-memory stream for text.

参数名不是规范的一部分，只有 `open()` 的参数才用作关键字参数。

下表总结了抽象基类提供的 `io` 模块：

抽象基类 | 继承 | 抽象方法 | Mixin方法和属性
--- | --- | --- | ---
`IOBase` |  | `fileno`, `seek`, 和 `truncate` | `close`, `closed`, `__enter__`, `__exit__`, `flush`, `isatty`, `__iter__`, `__next__`, `readable`, `readline`, `readlines`, `seekable`, `tell`, `writable` 和 `writelines`
`RawIOBase` | `IOBase` | `readinto` 和 `write` | 继承 `IOBase` 方法, `read`, 和 `readall`
`BufferedIOBase` | `IOBase` | `detach`, `read`, `read1`, 和 `write` | 继承 `IOBase` 方法, `readinto`, 和 `readinto1`
`TextIOBase` | `IOBase` | `detach`, `read`, `readline`, 和 `write` | 继承 `IOBase` 方法, `encoding`, `errors`, 和 `newlines`

### I/O 基类

class `io.``IOBase`

  所有 I/O 类的抽象基类，作用于字节流。没有公共构造函数。

  此类为许多方法提供了空的抽象实现，派生类可以有选择地重写。默认实现代表一个无法读取、写入或查找的文件。

  尽管 `IOBase` 没有声明 `read()` 或 `write()` ，因为它们的签名会有所不同，但是实现和客户端应该将这些方法视为接口的一部分。此外，当调用不支持的操作时可能会引发 `ValueError` （或 `UnsupportedOperation` ）。

  从文件读取或写入文件的二进制数据的基本类型为 `bytes` 。其他 bytes-like objects 也可以作为方法参数。文本I/O类使用 `str` 数据。

  请注意，在关闭的流上调用任何方法（甚至查询）都是未定义的（undefined）。在这种情况下，实现可能会引发 `ValueError` 。

  `IOBase` （及其子类）支持迭代器协议，这意味着可以迭代 `IOBase` 对象以产生流中的行。根据流是二进制流（产生字节）还是文本流（产生字符串），行的定义略有不同。请参见下面的 `readline()` 。

  `IOBase` 也是一个上下文管理器，因此支持 `with` 语句。 在这个示例中，file 将在 `with` 语句块执行完成之后被关闭 --- 即使是发生了异常:

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

  `IOBase` 提供以下数据属性和方法：

  `close`()

    刷新并关闭此流。如果文件已经关闭，则此方法无效。文件关闭后，对文件的任何操作（例如读取或写入）都会引发 `ValueError` 。

    为方便起见，允许多次调用此方法。但是，只有第一个调用才会生效。

  `closed`

    如果流已关闭，则返回 True。

  `fileno`()

    返回流的底层文件描述符（整数）---如果存在。如果 IO 对象不使用文件描述符，则会引发 `OSError` 。

  `flush`()

    刷新流的写入缓冲区（如果适用）。这对只读和非阻塞流不起作用。

  `isatty`()

    如果流是交互式的（即连接到终端/tty设备），则返回 `True` 。

  `readable`()

    如果可以读取流，则返回 `True` 。否则为 `False` ，且 `read()` 将引发 `OSError` 错误。

  `readline`(size=-1)

    从流中读取并返回一行。如果指定了 size，将至多读取 size 个字节。

    对于二进制文件行结束符总是 `b'\n'`；对于文本文件，可以用将 newline 参数传给 `open()` 的方式来选择要识别的行结束符。

  `readlines`(hint=-1)

    从流中读取并返回包含多行的列表。可以指定 hint 来控制要读取的行数：如果（以字节/字符数表示的）所有行的总大小超出了 hint 则将不会读取更多的行。

    请注意使用 `for line in file: ...` 就足够对文件对象进行迭代了，可以不必调用 `file.readlines()`。

  `seek`(offset, whence=SEEK_SET)

    将流位置修改到给定的字节 offset。 offset 将相对于由 whence 指定的位置进行解析。 whence 的默认值为 `SEEK_SET`。 whence 的可用值有：

    - `SEEK_SET` 或 `0` -- 流的开头（默认值）；offset 应为零或正值

    - `SEEK_CUR` or `1` -- 当前流位置；offset 可以为负值

    - `SEEK_END` or `2` -- 流的末尾；offset 通常为负值

    返回新的绝对位置。

    3.1 版新加入: `SEEK_*` 常量.

    3.3 版新加入: 某些操作系统还可支持其他的值，例如 `os.SEEK_HOLE` 或 `os.SEEK_DATA`。特定文件的可用值还会取决于它是以文本还是二进制模式打开。

  `seekable`()

    如果流支持随机访问则返回 `True`。 如为 `False`，则 `seek()`, `tell()` 和 `truncate()` 将引发 `OSError`。

  `tell`()

    返回当前流的位置。

  `truncate`(size=None)

    将流的大小调整为给定的 size 个字节（如果未指定 size 则调整至当前位置）。 当前的流位置不变。 这个调整操作可扩展或减小当前文件大小。 在扩展的情况下，新文件区域的内容取决于具体平台（在大多数系统上，额外的字节会填充为零）。 返回新的文件大小。

    3.5 版更變: 现在Windows在扩展时将文件填充为零。

  `writable`()

    如果流支持写入则返回 `True`。 如为 `False`，则 `write()` 和 `truncate()` 将引发 `OSError`。

  `writelines`(lines)

    将行列表写入到流。 不会添加行分隔符，因此通常所提供的每一行都带有末尾行分隔符。

  `__del__`()

    为对象销毁进行准备。 `IOBase` 提供了此方法的默认实现，该实现会调用实例的 `close()` 方法。

class `io.``RawIOBase`

  Base class for raw binary streams. It inherits `IOBase`. There is no public constructor.

  Raw binary streams typically provide low-level access to an underlying OS device or API, and do not try to encapsulate it in high-level primitives (this functionality is done at a higher-level in buffered binary streams and text streams, described later in this page).

  `RawIOBase` provides these methods in addition to those from `IOBase`:

  `read`(size=-1)

    从对象中读取 size 个字节并将其返回。 作为一个便捷选项，如果 size 未指定或为 -1，则返回所有字节直到 EOF。 在其他情况下，仅会执行一次系统调用。 如果操作系统调用返回字节数少于 size 则此方法也可能返回少于 size 个字节。

    如果返回 0 个字节而 size 不为零 0，这表明到达文件末尾。 如果处于非阻塞模式并且没有更多字节可用，则返回 `None`。

    默认实现会转至 `readall()` 和 `readinto()`。

  `readall`()

    从流中读取并返回所有字节直到 EOF，如有必要将对流执行多次调用。

  `readinto`(b)

    将字节数据读入预先分配的可写 bytes-like object b，并返回所读取的字节数。 例如，b 可以是一个 `bytearray`。 如果对象处理非阻塞模式并且没有更多字节可用，则返回 `None`。

  `write`(b)

    将给定的 bytes-like object b 写入到下层的原始流，并返回所写入的字节数。 这可以少于 b 的总字节数，具体取决于下层原始流的设定，特别是如果它处于非阻塞模式的话。 如果原始流设为非阻塞并且不能真正向其写入单个字节时则返回 `None`。 调用者可以在此方法返回后释放或改变 b，因此该实现应该仅在方法调用期间访问 b。

class `io.``BufferedIOBase`

  支持某种缓冲的二进制流的基类。 它继承自 `IOBase`。 没有公共构造器。

  与 `RawIOBase` 的主要差别在于 `read()`, `readinto()` 和 `write()` 等方法将（分别）尝试按照要求读取尽可能多的输入或是耗尽所有给定的输出，其代价是可能会执行一次以上的系统调用。

  除此之外，那些方法还可能引发 `BlockingIOError`，如果下层的原始数据流处于非阻塞模式并且无法接受或给出足够数据的话；不同于对应的 `RawIOBase` 方法，它们将永远不会返回 `None`。

  并且，`read()` 方法也没有转向 `readinto()` 的默认实现。

  典型的 `BufferedIOBase` 实现不应当继承自 `RawIOBase` 实现，而要包装一个该实现，正如 `BufferedWriter` 和 `BufferedReader` 所做的那样。

  `BufferedIOBase` provides or overrides these data attributes and methods in addition to those from `IOBase`:

  `raw`

    由 `BufferedIOBase` 处理的下层原始流 (`RawIOBase` 的实例)。 它不是 `BufferedIOBase` API 的组成部分并且不存在于某些实现中。

  `detach`()

    从缓冲区分离出下层原始流并将其返回。

    在原始流被分离之后，缓冲区将处于不可用的状态。

    某些缓冲区例如 `BytesIO` 并无可从此方法返回的单独原始流的概念。 它们将会引发 `UnsupportedOperation`。

    3.1 版新加入.

  `read`(size=-1)

    读取并返回最多 size 个字节。 如果省略此参数则返回 `None`，如果参数为负值则读取并返回所有数据直到 EOF。 如果流已经到达 EOF 则返回一个空的 `bytes` 对象。

    如果此参数为正值，并且下层原始流不可交互，则可能发起多个原始读取以满足字节计数（直至先遇到 EOF）。 但对于可交互原始流，则将至多发起一个原始读取，并且简短的结果并不意味着已到达 EOF。

    `BlockingIOError` 会在下层原始流不处于阻塞模式，并且当前没有可用数据时被引发。

  `read1`([size])

    通过至多一次对下层流的 `read()` (或 `readinto()`) 方法的调用读取并返回至多 size 个字节。 这适用于在 `BufferedIOBase` 对象之上实现你自己的缓冲区的情况。

    如果 size 为 `-1` (默认值)，则返回任意数量的字节（多于零字节，除非已到达 EOF）。

  `readinto`(b)

    将字节数据读入预先分配的可写 bytes-like object b 并返回所读取的字节数。 例如，b 可以是一个 `bytearray`。

    类似于 `read()`，可能对下层原始流发起多次读取，除非后者为交互式。

    `BlockingIOError` 会在下层原始流不处于阻塞模式，并且当前没有可用数据时被引发。

  `readinto1`(b)

    将字节数据读入预先分配的可写 bytes-like object b，其中至多使用一次对下层原始流 `read()` (或 `readinto()`) 方法的调用。 返回所读取的字节数。

    `BlockingIOError` 会在下层原始流不处于阻塞模式，并且当前没有可用数据时被引发。

    3.5 版新加入.

  `write`(b)

    写入给定的 bytes-like object b，并返回写入的字节数 (总是等于 b 的字节长度，因为如果写入失败则会引发 `OSError`)。 根据具体实现的不同，这些字节可能被实际写入下层流，或是出于运行效率和冗余等考虑而暂存于缓冲区。

    当处于非阻塞模式时，如果需要将数据写入原始流但它无法在不阻塞的情况下接受所有数据则将引发 `BlockingIOError`。

    调用者可能会在此方法返回后释放或改变 b，因此该实现应当仅在方法调用期间访问 b。

### 原始文件 I/O

class `io.``FileIO`(name, mode='r', closefd=True, opener=None)

  A raw binary stream representing an OS-level file containing bytes data. It inherits `RawIOBase`.

  name 可以是以下两项之一：

  - a character string or `bytes` object representing the path to the file which will be opened. In this case closefd must be `True` (the default) otherwise an error will be raised.

  - an integer representing the number of an existing OS-level file descriptor to which the resulting `FileIO` object will give access. When the FileIO object is closed this fd will be closed as well, unless closefd is set to `False`.

  The mode can be `'r'`, `'w'`, `'x'` or `'a'` for reading (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. `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.

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

  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 `os.open` as opener results in functionality similar to passing `None`).

  新创建的文件是 不可继承的。

  有关 opener 参数的示例，请参见内置函数 `open()` 。

  3.3 版更變: 增加了 opener 参数。增加了 `'x'` 模式。

  3.4 版更變: 文件现在禁止继承。

  `FileIO` provides these data attributes in addition to those from `RawIOBase` and `IOBase`:

  `mode`

    构造函数中给定的模式。

  `name`

    文件名。当构造函数中没有给定名称时，这是文件的文件描述符。

### 缓冲流

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

class `io.``BytesIO`([initial_bytes])

  A binary stream using an in-memory bytes buffer. It inherits `BufferedIOBase`. The buffer is discarded when the `close()` method is called.

  The optional argument initial_bytes is a bytes-like object that contains initial data.

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

  `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'

    備註

    As long as the view exists, the `BytesIO` object cannot be resized or closed.

    3.2 版新加入.

  `getvalue`()

    Return `bytes` containing the entire contents of the buffer.

  `read1`([size])

    在 `BytesIO` 中，这与 `read()` 相同。

    3.7 版更變: size 参数现在是可选的。

  `readinto1`(b)

    在 `BytesIO` 中，这与 `readinto()` 相同。

    3.5 版新加入.

class `io.``BufferedReader`(raw, buffer_size=DEFAULT_BUFFER_SIZE)

  A buffered binary stream providing higher-level access to a readable, non seekable `RawIOBase` raw binary stream. It inherits `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.

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

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

  `peek`([size])

    Return bytes from the stream without advancing the position. At most one single read on the raw stream is done to satisfy the call. The number of bytes returned may be less or more than requested.

  `read`([size])

    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.

  `read1`([size])

    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. Otherwise, one raw stream read call is made.

    3.7 版更變: size 参数现在是可选的。

class `io.``BufferedWriter`(raw, buffer_size=DEFAULT_BUFFER_SIZE)

  A buffered binary stream providing higher-level access to a writeable, non seekable `RawIOBase` raw binary stream. It inherits `BufferedIOBase`.

  When writing to this object, data is normally placed into an internal buffer. The buffer will be written out to the underlying `RawIOBase` object under various conditions, including:

  - 当缓冲区对于所有挂起数据而言太小时；

  - 当 `flush()` 被调用时

  - when a `seek()` is requested (for `BufferedRandom` objects);

  - when the `BufferedWriter` object is closed or destroyed.

  The constructor creates a `BufferedWriter` for the given writeable raw stream. If the buffer_size is not given, it defaults to `DEFAULT_BUFFER_SIZE`.

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

  `flush`()

    Force bytes held in the buffer into the raw stream. A `BlockingIOError` should be raised if the raw stream blocks.

  `write`(b)

    Write the bytes-like object, b, and return the number of bytes written. When in non-blocking mode, a `BlockingIOError` is raised if the buffer needs to be written out but the raw stream blocks.

class `io.``BufferedRandom`(raw, buffer_size=DEFAULT_BUFFER_SIZE)

  A buffered binary stream providing higher-level access to a seekable `RawIOBase` raw binary stream. It inherits `BufferedReader` and `BufferedWriter`.

  The constructor creates a reader and writer for a seekable raw stream, given in the first argument. If the buffer_size is omitted it defaults to `DEFAULT_BUFFER_SIZE`.

  `BufferedRandom` is capable of anything `BufferedReader` or `BufferedWriter` can do. In addition, `seek()` and `tell()` are guaranteed to be implemented.

class `io.``BufferedRWPair`(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE)

  A buffered binary stream providing higher-level access to two non seekable `RawIOBase` raw binary streams---one readable, the other writeable. It inherits `BufferedIOBase`.

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

  `BufferedRWPair` implements all of `BufferedIOBase`'s methods except for `detach()`, which raises `UnsupportedOperation`.

  警告

  `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 `BufferedRandom` instead.

### 文本 I/O

class `io.``TextIOBase`

  Base class for text streams. This class provides a character and line based interface to stream I/O. It inherits `IOBase`. There is no public constructor.

  `TextIOBase` provides or overrides these data attributes and methods in addition to those from `IOBase`:

  `encoding`

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

  `errors`

    解码器或编码器的错误设置。

  `newlines`

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

  `buffer`

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

  `detach`()

    Separate the underlying binary buffer from the `TextIOBase` and return it.

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

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

    3.1 版新加入.

  `read`(size=-1)

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

  `readline`(size=-1)

    Read until newline or EOF and return a single `str`. If the stream is already at EOF, an empty string is returned.

    如果指定了 size ，最多将读取 size 个字符。

  `seek`(offset, whence=SEEK_SET)

    Change the stream position to the given offset. Behaviour depends on the whence parameter. The default value for whence is `SEEK_SET`.

    - `SEEK_SET` or `0`: seek from the start of the stream (the default); offset must either be a number returned by `TextIOBase.tell()`, or zero. Any other offset value produces undefined behaviour.

    - `SEEK_CUR` or `1`: "seek" to the current position; offset must be zero, which is a no-operation (all other values are unsupported).

    - `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.

    3.1 版新加入: `SEEK_*` 常量.

  `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.

  `write`(s)

    Write the string s to the stream and return the number of characters written.

class `io.``TextIOWrapper`(buffer, encoding=None, errors=None, newline=None, line_buffering=False, write_through=False)

  A buffered text stream providing higher-level access to a `BufferedIOBase` buffered binary stream. It inherits `TextIOBase`.

  encoding gives the name of the encoding that the stream will be decoded or encoded with. It defaults to `locale.getpreferredencoding(False)`.

  errors is an optional string that specifies how encoding and decoding errors are to be handled. Pass `'strict'` to raise a `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 (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 `codecs.register_error()` is also valid.

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

  - When reading input from the stream, if newline is `None`, 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 newline is `''`, universal newlines mode is enabled, but line endings are returned to the caller untranslated. If newline 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.

  - 将输出写入流时，如果 newline 为 `None`，则写入的任何 `'\n'` 字符都将转换为系统默认行分隔符 `os.linesep`。如果 newline 是 `''` 或 `'\n'`，则不进行翻译。如果 newline 是任何其他合法值，则写入的任何 `'\n'` 字符将被转换为给定的字符串。

  If line_buffering is `True`, `flush()` is implied when a call to write contains a newline character or a carriage return.

  If write_through is `True`, calls to `write()` are guaranteed not to be buffered: any data written on the `TextIOWrapper` object is immediately handled to its underlying binary buffer.

  3.3 版更變: 已添加 write_through 参数

  3.3 版更變: The default encoding is now `locale.getpreferredencoding(False)` instead of `locale.getpreferredencoding()`. Don't change temporary the locale encoding using `locale.setlocale()`, use the current locale encoding instead of the user preferred encoding.

  `TextIOWrapper` provides these data attributes and methods in addition to those from `TextIOBase` and `IOBase`:

  `line_buffering`

    是否启用行缓冲。

  `write_through`

    Whether writes are passed immediately to the underlying binary buffer.

    3.7 版新加入.

  `reconfigure`(*[, encoding][, errors][, newline][, line_buffering][, write_through])

    Reconfigure this text stream using new settings for encoding, errors, newline, line_buffering and write_through.

    Parameters not specified keep current settings, except `errors='strict'` is used when encoding is specified but errors is not specified.

    It is not possible to change the encoding or newline if some data has already been read from the stream. On the other hand, changing encoding after write is possible.

    This method does an implicit stream flush before setting the new parameters.

    3.7 版新加入.

class `io.``StringIO`(initial_value='', newline='\n')

  A text stream using an in-memory text buffer. It inherits `TextIOBase`.

  The text buffer is discarded when the `close()` method is called.

  The initial value of the buffer can be set by providing initial_value. If newline translation is enabled, newlines will be encoded as if by `write()`. The stream is positioned at the start of the buffer.

  The newline argument works like that of `TextIOWrapper`, except that when writing output to the stream, if newline is `None`, newlines are written as `\n` on all platforms.

  `StringIO` provides this method in addition to those from `TextIOBase` and `IOBase`:

  `getvalue`()

    Return a `str` containing the entire contents of the buffer. Newlines are decoded as if by `read()`, although the stream position is not changed.

  用法示例：

      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()

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

class `io.``IncrementalNewlineDecoder`

  A helper codec that decodes newlines for universal newlines mode. It inherits `codecs.IncrementalDecoder`.

## 性能

本节讨论所提供的具体 I/O 实现的性能。

### 二进制 I/O

即使在用户请求单个字节时，也只读取和写入大块数据。通过该方法，缓冲 I/O 隐藏了操作系统调用和执行无缓冲 I/O 例程时的任何低效性。增益取决于操作系统和执行的 I/O 类型。例如，在某些现代操作系统上（例如 Linux），无缓冲磁盘 I/O 可以与缓冲 I/O 一样快。但最重要的是，无论平台和支持设备如何，缓冲 I/O 都能提供可预测的性能。因此，对于二进制数据，应首选使用缓冲的 I/O 而不是未缓冲的 I/O 。

### 文本 I/O

二进制存储（如文件）上的文本 I/O 比同一存储上的二进制 I/O 慢得多，因为它需要使用字符编解码器在Unicode和二进制数据之间进行转换。这在处理大量文本数据（如大型日志文件）时会变得非常明显。此外，由于使用的重构算法 `TextIOWrapper.tell()` 和 `TextIOWrapper.seek()` 都相当慢。

`StringIO` 是原生的内存 Unicode 容器，速度与 `BytesIO` 相似。

### 多线程

`FileIO` 对象是线程安全的，只要它们封装的操作系统调用（比如Unix下的 `read(2)` ）也是线程安全的。

二进制缓冲对象（例如 `BufferedReader`, `BufferedWriter`, `BufferedRandom` 和 `BufferedRWPair`）使用锁来保护其内部结构；因此，可以安全地一次从多个线程中调用它们。

`TextIOWrapper` 对象不再是线程安全的。

### 可重入性

二进制缓冲对象（ `BufferedReader` ， `BufferedWriter` ， `BufferedRandom` 和 `BufferedRWPair` 的实例）不是可重入的。虽然在正常情况下不会发生可重入调用，但仍可能会在 `signal` 处理程序执行 I/O 时产生。如果线程尝试重入已经访问的缓冲对象，则会引发 `RuntimeError` 。注意，这并不禁止其他线程进入缓冲对象。

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