`io.md`

589 строк · 65.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.2/library/io.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 15.2. [`io`](https://python-all.ru/3.2/library/io.html#module-io) – Основные инструменты для работы с потоками89## 15.2.1. Обзор1011Модуль [`io`](https://python-all.ru/3.2/library/io.html#module-io) предоставляет основные средства Python для работы с различными типами ввода-вывода. Существует три основных типа ввода-вывода: *текстовый ввод-вывод*, *двоичный ввод-вывод* и *сырой ввод-вывод*. Это общие категории, и для каждой из них могут использоваться различные хранилища данных. Конкретный объект, принадлежащий к любой из этих категорий, называется [*файловым объектом*](https://python-all.ru/3.2/glossary.html#term-file-object). Другие распространённые термины – *поток* и *объект, подобный файлу*.1213Независимо от категории, каждый конкретный объект потока также может обладать различными возможностями: он может быть только для чтения, только для записи или для чтения и записи. Он также может поддерживать произвольный доступ (переход вперёд или назад к любому месту) или только последовательный доступ (например, в случае сокета или канала).1415Все потоки внимательны к типу данных, которые им передаются. Например, передача объекта [`str`](https://python-all.ru/3.2/library/functions.html#str) методу `write()` двоичного потока вызовет исключение `TypeError`. То же самое произойдёт при передаче объекта [`bytes`](https://python-all.ru/3.2/library/functions.html#bytes) методу `write()` текстового потока.1617### 15.2.1.1. Текстовый ввод-вывод1819Текстовый ввод-вывод ожидает и создаёт объекты [`str`](https://python-all.ru/3.2/library/functions.html#str). Это означает, что когда хранилище данных изначально состоит из байтов (как в случае с файлом), кодирование и декодирование данных выполняется прозрачно, а также выполняется опциональное преобразование символов новой строки, специфичных для платформы.2021Самый простой способ создать текстовый поток – использовать [`open()`](https://python-all.ru/3.2/library/functions.html#open), опционально указав кодировку:2223```python24f = open("myfile.txt", "r", encoding="utf-8")25```2627Текстовые потоки в памяти также доступны как объекты [`StringIO`](https://python-all.ru/3.2/library/io.html#io.StringIO):2829```python30f = io.StringIO("some initial text data")31```3233API текстового потока подробно описан в документации к [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase).3435### 15.2.1.2. Двоичный ввод-вывод3637Двоичный ввод-вывод (также называемый *буферизованным вводом-выводом*) ожидает и создаёт объекты [`bytes`](https://python-all.ru/3.2/library/functions.html#bytes). Никакого кодирования, декодирования или преобразования новых строк не выполняется. Эта категория потоков может использоваться для всех видов нетекстовых данных, а также когда требуется ручное управление обработкой текстовых данных.3839Самый простой способ создать двоичный поток – использовать [`open()`](https://python-all.ru/3.2/library/functions.html#open) с `'b'` в строке режима:4041```python42f = open("myfile.jpg", "rb")43```4445Двоичные потоки в памяти также доступны как объекты [`BytesIO`](https://python-all.ru/3.2/library/io.html#io.BytesIO):4647```python48f = io.BytesIO(b"some initial binary data: \x00\x01")49```5051API двоичных потоков подробно описан в документации [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase).5253Другие модули библиотеки могут предоставлять дополнительные способы создания текстовых или двоичных потоков. Смотрите, например, [`socket.socket.makefile()`](https://python-all.ru/3.2/library/socket.html#socket.socket.makefile).5455### 15.2.1.3. Необработанный ввод-вывод5657Необработанный ввод-вывод (также называемый *небуферизованным вводом-выводом*) обычно используется как низкоуровневый строительный блок для двоичных и текстовых потоков; редко бывает полезно напрямую манипулировать необработанным потоком из пользовательского кода. Тем не менее, можно создать необработанный поток, открыв файл в двоичном режиме с отключённой буферизацией:5859```python60f = open("myfile.jpg", "rb", buffering=0)61```6263API сырых потоков подробно описан в документации [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase).6465## 15.2.2. Интерфейс модуля высокого уровня6667#### `io.DEFAULT_BUFFER_SIZE`6869Целое число, содержащее размер буфера по умолчанию, используемый буферизованными классами ввода-вывода модуля. [`open()`](https://python-all.ru/3.2/library/functions.html#open) использует blksize файла (получаемый с помощью [`os.stat()`](https://python-all.ru/3.2/library/os.html#os.stat)), если это возможно.7071#### `io.open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True)`7273Это псевдоним для встроенной функции [`open()`](https://python-all.ru/3.2/library/functions.html#open).7475#### `exception io.BlockingIOError`7677Исключение, возникающее при блокировке неблокирующего потока. Наследует [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError).7879В дополнение к атрибутам [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError), [`BlockingIOError`](https://python-all.ru/3.2/library/io.html#io.BlockingIOError) имеет один атрибут:8081#### `characters_written`8283Целое число, содержащее количество символов, записанных в поток до его блокировки.8485#### `exception io.UnsupportedOperation`8687Исключение, наследующее [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError) и [`ValueError`](https://python-all.ru/3.2/library/exceptions.html#ValueError), которое возбуждается при вызове неподдерживаемой операции над потоком.8889### 15.2.2.1. Потоки в памяти9091Также можно использовать объект, подобный [`str`](https://python-all.ru/3.2/library/functions.html#str) или [`bytes`](https://python-all.ru/3.2/library/functions.html#bytes), в качестве файла как для чтения, так и для записи. Для строк [`StringIO`](https://python-all.ru/3.2/library/io.html#io.StringIO) можно использовать как файл, открытый в текстовом режиме. [`BytesIO`](https://python-all.ru/3.2/library/io.html#io.BytesIO) можно использовать как файл, открытый в двоичном режиме. Оба предоставляют полные возможности чтения и записи с произвольным доступом.9293> **См. также**94>95> **[`sys`](https://python-all.ru/3.2/library/sys.html#module-sys)**96>97> содержит стандартные потоки ввода-вывода:98>99> [`sys.stdin`](https://python-all.ru/3.2/library/sys.html#sys.stdin)100>101> ,102>103> [`sys.stdout`](https://python-all.ru/3.2/library/sys.html#sys.stdout)104>105> и106>107> [`sys.stderr`](https://python-all.ru/3.2/library/sys.html#sys.stderr)108>109> .110111## 15.2.3. Иерархия классов112113Реализация потоков ввода-вывода организована в виде иерархии классов. Сначала [*абстрактные базовые классы*](https://python-all.ru/3.2/glossary.html#term-abstract-base-class) (ABC), которые используются для определения различных категорий потоков, затем конкретные классы, предоставляющие стандартные реализации потоков.114115> > **Примечание**116> >117> > Абстрактные базовые классы также предоставляют реализации некоторых методов по умолчанию, чтобы упростить реализацию конкретных классов потоков. Например, [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase) предоставляет неоптимизированные реализации `readinto()` и `readline()`.118119На вершине иерархии ввода-вывода находится абстрактный базовый класс [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase). Он определяет базовый интерфейс для потока. Однако обратите внимание, что нет разделения между чтением и записью в потоках; реализациям разрешено вызывать [`UnsupportedOperation`](https://python-all.ru/3.2/library/io.html#io.UnsupportedOperation), если они не поддерживают данную операцию.120121Абстрактный базовый класс [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase) расширяет [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase). Он занимается чтением и записью байтов в поток. [`FileIO`](https://python-all.ru/3.2/library/io.html#io.FileIO) является подклассом [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase) и предоставляет интерфейс для файлов в файловой системе машины.122123Абстрактный базовый класс [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase) занимается буферизацией на сыром байтовом потоке ([`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase)). Его подклассы [`BufferedWriter`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter), [`BufferedReader`](https://python-all.ru/3.2/library/io.html#io.BufferedReader) и [`BufferedRWPair`](https://python-all.ru/3.2/library/io.html#io.BufferedRWPair) буферизуют потоки, которые доступны для чтения, записи или для чтения и записи одновременно. [`BufferedRandom`](https://python-all.ru/3.2/library/io.html#io.BufferedRandom) предоставляет буферизованный интерфейс для потоков с произвольным доступом. Ещё один подкласс [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase), [`BytesIO`](https://python-all.ru/3.2/library/io.html#io.BytesIO), представляет собой поток байтов в памяти.124125Абстрактный базовый класс [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase), ещё один подкласс [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase), занимается потоками, байты которых представляют текст, и обрабатывает кодирование и декодирование в строки и из строк. [`TextIOWrapper`](https://python-all.ru/3.2/library/io.html#io.TextIOWrapper), который расширяет его, представляет собой буферизованный текстовый интерфейс к буферизованному сырому потоку ([`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase)). Наконец, [`StringIO`](https://python-all.ru/3.2/library/io.html#io.StringIO) – это поток текста в памяти.126127Имена аргументов не являются частью спецификации, и только аргументы [`open()`](https://python-all.ru/3.2/library/functions.html#open) предназначены для использования в качестве именованных аргументов.128129В следующей таблице приведены ABC, предоставляемые модулем [`io`](https://python-all.ru/3.2/library/io.html#module-io):130131| ABC | Наследует | Методы-заглушки | Методы-примеси и свойства |132| --- | --- | --- | --- |133| [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase) |  | `fileno`, `seek`, и `truncate` | `close`, `closed`, `__enter__`, `__exit__`, `flush`, `isatty`, `__iter__`, `__next__`, `readable`, `readline`, `readlines`, `seekable`, `tell`, `writable` и `writelines` |134| [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase) | [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase) | `readinto` и `write` | Унаследованные методы [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase), `read`, и `readall` |135| [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase) | [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase) | `detach`, `read`, `read1` и `write` | Унаследованные методы [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase), `readinto` |136| [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase) | [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase) | `detach`, `read`, `readline` и `write` | Унаследованные методы [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase), `encoding`, `errors` и `newlines` |137138### 15.2.3.1. Базовые классы ввода-вывода139140#### `class io.IOBase`141142Абстрактный базовый класс для всех классов ввода-вывода, работающий с потоками байтов. Отсутствует открытый конструктор.143144Этот класс предоставляет пустые абстрактные реализации для многих методов, которые производные классы могут выборочно переопределять; реализации по умолчанию представляют файл, который нельзя читать, записывать или позиционировать.145146Хотя [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase) не объявляет `read()`, `readinto()`, или `write()`, поскольку их сигнатуры различаются, реализации и клиенты должны считать эти методы частью интерфейса. Кроме того, реализации могут возбуждать [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError) при вызове неподдерживаемых операций.147148Базовым типом для двоичных данных, читаемых из файла или записываемых в файл, является [`bytes`](https://python-all.ru/3.2/library/functions.html#bytes). Типы [`bytearray`](https://python-all.ru/3.2/library/functions.html#bytearray) также принимаются, а в некоторых случаях (например, `readinto`) требуются. Классы текстового ввода-вывода работают с данными типа [`str`](https://python-all.ru/3.2/library/functions.html#str).149150Обратите внимание, что вызов любого метода (даже запросов) на закрытом потоке является неопределённым поведением. Реализации могут возбуждать [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError) в этом случае.151152IOBase (и его подклассы) поддерживает протокол итератора, то есть объект [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase) можно итерировать, получая строки из потока. Определение строки немного отличается в зависимости от того, является ли поток двоичным (возвращает байты) или текстовым (возвращает строки символов). См. [`readline()`](https://python-all.ru/3.2/library/io.html#io.IOBase.readline) ниже.153154IOBase также является контекстным менеджером и поэтому поддерживает оператор [`with`](https://python-all.ru/3.2/reference/compound_stmts.html#with). В этом примере *file* закрывается после завершения блока оператора [`with`](https://python-all.ru/3.2/reference/compound_stmts.html#with) – даже если возникло исключение:155156```python157with open('spam.txt', 'w') as file:158    file.write('Spam and eggs!')159```160161[`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase) предоставляет следующие атрибуты данных и методы:162163#### `close()`164165Сбрасывает буфер и закрывает этот поток. Этот метод не делает ничего, если файл уже закрыт. Как только файл закрыт, любая операция с файлом (например, чтение или запись) вызовет [`ValueError`](https://python-all.ru/3.2/library/exceptions.html#ValueError).166167Для удобства допускается вызывать этот метод несколько раз; однако эффект будет иметь только первый вызов.168169#### `closed`170171True, если поток закрыт.172173#### `fileno()`174175Возвращает базовый файловый дескриптор (целое число) потока, если он существует. Если объект ввода-вывода не использует файловый дескриптор, возбуждается [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError).176177#### `flush()`178179Сбрасывает буферы записи потока, если это применимо. Для потоков только для чтения и неблокирующих потоков эта операция ничего не делает.180181#### `isatty()`182183Возвращает `True`, если поток интерактивный (т.е. подключен к терминалу/tty-устройству).184185#### `readable()`186187Возвращает `True`, если из потока можно читать. Если False, `read()` возбудит [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError).188189#### `readline(limit=-1)`190191Читает и возвращает одну строку из потока. Если указан *limit*, будет прочитано не более *limit* байт.192193Для двоичных файлов признаком конца строки всегда является `b'\n'`; для текстовых файлов через параметр *newlines* функции [`open()`](https://python-all.ru/3.2/library/functions.html#open) можно указать, какие признаки конца строки распознавать.194195#### `readlines(hint=-1)`196197Читает и возвращает список строк из потока. Можно указать *hint* для ограничения количества читаемых строк: чтение прекратится, когда общий размер (в байтах/символах) всех прочитанных строк превысит *hint*.198199#### `seek(offset, whence=SEEK_SET)`200201Изменяет позицию в потоке на заданное смещение в байтах *offset*. *offset* интерпретируется относительно позиции, задаваемой параметром *whence*. Допустимые значения *whence*:202203- `SEEK_SET` или `0` – начало потока (по умолчанию); *offset* должен быть нулевым или положительным204- `SEEK_CUR` или `1` – текущая позиция в потоке; *offset* может быть отрицательным205- `SEEK_END` или `2` – конец потока; *offset* обычно отрицательный206207Возвращает новую абсолютную позицию.208209Новое в версии 3.1: Константы `SEEK_*`.210211#### `seekable()`212213Возвращает `True`, если поток поддерживает произвольный доступ. Если `False`, [`seek()`](https://python-all.ru/3.2/library/io.html#io.IOBase.seek), [`tell()`](https://python-all.ru/3.2/library/io.html#io.IOBase.tell) и [`truncate()`](https://python-all.ru/3.2/library/io.html#io.IOBase.truncate) возбудят [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError).214215#### `tell()`216217Возвращает текущую позицию в потоке.218219#### `truncate(size=None)`220221Изменяет размер потока до указанного *size* в байтах (или до текущей позиции, если *size* не указан). Текущая позиция в потоке не изменяется. Это изменение размера может увеличить или уменьшить текущий размер файла. В случае увеличения содержимое новой области файла зависит от платформы (в большинстве систем дополнительные байты заполняются нулями, в Windows они не определены). Возвращается новый размер файла.222223#### `writable()`224225Возвращает `True`, если поток поддерживает запись. Если `False`, `write()` и [`truncate()`](https://python-all.ru/3.2/library/io.html#io.IOBase.truncate) возбудят [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError).226227#### `writelines(lines)`228229Записывает список строк в поток. Разделители строк не добавляются, поэтому обычно каждая переданная строка уже содержит разделитель в конце.230231#### `class io.RawIOBase`232233Базовый класс для необработанного бинарного ввода-вывода. Наследует [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase). Открытого конструктора нет.234235Необработанный двоичный ввод-вывод обычно предоставляет низкоуровневый доступ к базовому устройству или API операционной системы и не пытается инкапсулировать его в высокоуровневые примитивы (это оставлено буферизованному и текстовому вводу-выводу, описанным далее на этой странице).236237В дополнение к атрибутам и методам из [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase), RawIOBase предоставляет следующие методы:238239#### `read(n=-1)`240241Читает до *n* байт из объекта и возвращает их. Для удобства, если *n* не указан или равен -1, вызывается [`readall()`](https://python-all.ru/3.2/library/io.html#io.RawIOBase.readall). В противном случае выполняется только один системный вызов. Может быть возвращено меньше *n* байт, если операционная система возвращает меньше *n* байт.242243Если возвращено 0 байт, а *n* не был 0, это означает конец файла. Если объект в неблокирующем режиме и байты недоступны, возвращается `None`.244245#### `readall()`246247Читает и возвращает все байты из потока до EOF, при необходимости выполняя несколько вызовов к потоку.248249#### `readinto(b)`250251Читает до len(b) байт в bytearray *b* и возвращает количество прочитанных байт. Если объект находится в неблокирующем режиме и байты недоступны, возвращается `None`.252253#### `write(b)`254255Записывает заданный объект bytes или bytearray, *b*, в нижележащий необработанный поток данных и возвращает количество записанных байт. Это может быть меньше `len(b)`, в зависимости от особенностей нижележащего необработанного потока данных, и особенно если он находится в неблокирующем режиме. `None` возвращается, если необработанный поток данных настроен так, чтобы не блокироваться, и ни один байт не может быть сразу записан в него.256257#### `class io.BufferedIOBase`258259Базовый класс для двоичных потоков, поддерживающих некоторую буферизацию. Он наследует [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase). Открытый конструктор отсутствует.260261Основное отличие от [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase) заключается в том, что методы [`read()`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase.read), [`readinto()`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase.readinto) и [`write()`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase.write) будут пытаться (соответственно) прочитать столько входных данных, сколько запрошено, или потребить все переданные выходные данные, ценой, возможно, более одного системного вызова.262263Кроме того, эти методы могут вызывать [`BlockingIOError`](https://python-all.ru/3.2/library/io.html#io.BlockingIOError), если нижележащий небуферизованный поток находится в неблокирующем режиме и не может принять или отдать достаточно данных; в отличие от их аналогов из [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase), они никогда не вернут `None`.264265Besides, the [`read()`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase.read) method does not have a default implementation that defers to [`readinto()`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase.readinto).266267Типичная реализация [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase) не должна наследовать от реализации [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase), а должна оборачивать её, как это делают [`BufferedWriter`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter) и [`BufferedReader`](https://python-all.ru/3.2/library/io.html#io.BufferedReader).268269[`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase) предоставляет или переопределяет следующие методы и атрибуты в дополнение к тем, что есть в [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase):270271#### `raw`272273Нижележащий небуферизованный поток (экземпляр [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase)), с которым работает [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase). Это не часть API [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase) и может отсутствовать в некоторых реализациях.274275#### `detach()`276277Отделяет базовый сырой поток от буфера и возвращает его.278279После отсоединения сырого потока буфер переходит в нерабочее состояние.280281Некоторые буферы, такие как [`BytesIO`](https://python-all.ru/3.2/library/io.html#io.BytesIO), не имеют понятия единого небуферизованного потока для возврата из этого метода. Они вызывают [`UnsupportedOperation`](https://python-all.ru/3.2/library/io.html#io.UnsupportedOperation).282283Новое в версии 3.1.284285#### `read(n=-1)`286287Читает и возвращает не более *n* байтов. Если аргумент опущен, равен `None` или отрицателен, данные читаются и возвращаются до достижения EOF. Если поток уже находится в конце, возвращается пустой объект bytes.288289Если аргумент положителен, а базовый сырой поток не является интерактивным, может быть выполнено несколько сырых чтений, чтобы обеспечить требуемое количество байт (если только не достигнут EOF). Но для интерактивных сырых потоков будет выполнено не более одного сырого чтения, и короткий результат не означает, что EOF неизбежен.290291[`BlockingIOError`](https://python-all.ru/3.2/library/io.html#io.BlockingIOError) возникает, если нижележащий небуферизованный поток находится в неблокирующем режиме и в данный момент не имеет доступных данных.292293#### `read1(n=-1)`294295Читает и возвращает до *n* байт, выполняя не более одного вызова метода [`read()`](https://python-all.ru/3.2/library/io.html#io.RawIOBase.read) нижележащего небуферизованного потока. Это может быть полезно при реализации собственной буферизации поверх объекта [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase).296297#### `readinto(b)`298299Читает до len(b) байтов в bytearray *b* и возвращает количество прочитанных байтов.300301Как и [`read()`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase.read), к нижележащему необработанному потоку может быть выполнено несколько чтений, если только он не является «интерактивным».302303[`BlockingIOError`](https://python-all.ru/3.2/library/io.html#io.BlockingIOError) возникает, если нижележащий небуферизованный поток находится в неблокирующем режиме и в данный момент не имеет доступных данных.304305#### `write(b)`306307Записывает указанный объект bytes или bytearray *b* и возвращает количество записанных байтов (никогда не меньше `len(b)`, так как при ошибке записи будет возбуждено исключение [`IOError`](https://python-all.ru/3.2/library/exceptions.html#IOError)). В зависимости от конкретной реализации эти байты могут быть немедленно записаны в нижележащий поток или сохранены в буфере для повышения производительности и снижения задержек.308309В неблокирующем режиме возникает [`BlockingIOError`](https://python-all.ru/3.2/library/io.html#io.BlockingIOError), если данные необходимо записать в небуферизованный поток, но он не может принять все данные без блокировки.310311### 15.2.3.2. Сырой файловый ввод-вывод312313#### `class io.FileIO(name, mode='r', closefd=True)`314315[`FileIO`](https://python-all.ru/3.2/library/io.html#io.FileIO) представляет файл на уровне ОС, содержащий байтовые данные. Он реализует интерфейс [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase) (а следовательно, и интерфейс [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase)).316317Параметр *name* может быть одним из двух:318319- строка символов или объект bytes, представляющий путь к открываемому файлу;320- целое число, представляющее номер существующего файлового дескриптора на уровне ОС, к которому будет предоставлять доступ результирующий объект [`⟦/2FileIO`](https://python-all.ru/3.2/library/io.html#io.FileIO).321322Параметр *mode* может быть равен `'r'`, `'w'` или `'a'` для чтения (по умолчанию), записи или дозаписи. Файл будет создан, если он не существует, при открытии на запись или дозапись; при открытии на запись файл будет усечён. Добавление `'+'` к режиму позволяет одновременно читать и писать.323324Методы `read()` (при вызове с положительным аргументом), `readinto()` и `write()` этого класса будут выполнять только один системный вызов.325326В дополнение к атрибутам и методам от [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase) и [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase), [`FileIO`](https://python-all.ru/3.2/library/io.html#io.FileIO) предоставляет следующие атрибуты и методы:327328#### `mode`329330Режим, указанный в конструкторе.331332#### `name`333334Имя файла. Это дескриптор файла, если имя не указано в конструкторе.335336### 15.2.3.3. Буферизированные потоки данных337338Буферизированные потоки ввода-вывода предоставляют интерфейс более высокого уровня к устройству ввода-вывода, чем небуферизированный.339340#### `class io.BytesIO([initial_bytes])`341342Реализация потока, использующая буфер байт в памяти. Наследует [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase).343344Аргумент *initial\_bytes* содержит необязательные начальные данные [`bytes`](https://python-all.ru/3.2/library/functions.html#bytes).345346[`BytesIO`](https://python-all.ru/3.2/library/io.html#io.BytesIO) предоставляет или переопределяет следующие методы в дополнение к методам из [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase) и [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase):347348#### `getbuffer()`349350Возвращает доступное для чтения и записи представление содержимого буфера без его копирования. Изменение этого представления также прозрачно обновляет содержимое буфера:351352```python353>>> b = io.BytesIO(b"abcdef")354>>> view = b.getbuffer()355>>> view[2:4] = b"56"356>>> b.getvalue()357b'ab56ef'358```359360> **Примечание**361>362> Пока существует представление, объект [`BytesIO`](https://python-all.ru/3.2/library/io.html#io.BytesIO) не может быть изменён в размере.363364Новое в версии 3.2.365366#### `getvalue()`367368Возвращает объект `bytes`, содержащий всё содержимое буфера.369370#### `read1()`371372В [`BytesIO`](https://python-all.ru/3.2/library/io.html#io.BytesIO) это эквивалентно `read()`.373374#### `class io.BufferedReader(raw, buffer_size=DEFAULT_BUFFER_SIZE)`375376Буфер, обеспечивающий доступ более высокого уровня к читаемому последовательному объекту [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase). Наследует [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase). При чтении данных из этого объекта из нижележащего необработанного потока может запрашиваться больший объём данных, которые сохраняются во внутреннем буфере. Затем буферизованные данные могут быть прямо возвращены при последующих чтениях.377378Конструктор создаёт [`BufferedReader`](https://python-all.ru/3.2/library/io.html#io.BufferedReader) для переданного читаемого потока *raw* и *buffer\_size*. Если *buffer\_size* опущен, используется [`DEFAULT_BUFFER_SIZE`](https://python-all.ru/3.2/library/io.html#io.DEFAULT_BUFFER_SIZE).379380[`BufferedReader`](https://python-all.ru/3.2/library/io.html#io.BufferedReader) предоставляет или переопределяет следующие методы в дополнение к методам из [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase) и [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase):381382#### `peek([n])`383384Возвращает байты из потока без продвижения позиции. Для выполнения вызова производится не более одного чтения из сырого потока. Количество возвращённых байт может быть меньше или больше запрошенного.385386#### `read([n])`387388Читает и возвращает *n* байт, или, если *n* не указан или отрицателен, до EOF или если вызов чтения заблокируется в неблокирующем режиме.389390#### `read1(n)`391392Читает и возвращает до *n* байт, выполняя только один вызов небуферизованного потока. Если в буфере есть хотя бы один байт, возвращаются только буферизованные байты. В противном случае выполняется один вызов чтения небуферизованного потока.393394#### `class io.BufferedWriter(raw, buffer_size=DEFAULT_BUFFER_SIZE)`395396Буфер, предоставляющий высокоуровневый доступ к записываемому последовательному объекту [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase). Он наследует [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase). При записи в этот объект данные обычно хранятся во внутреннем буфере. Буфер будет сброшен в нижележащий объект [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase) при различных условиях, в том числе:397398- когда буфер становится слишком мал для всех ожидающих данных;399- при вызове [`flush()`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter.flush);400- при запросе `seek()` (для объектов [`BufferedRandom`](https://python-all.ru/3.2/library/io.html#io.BufferedRandom));401- когда объект [`BufferedWriter`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter) закрывается или уничтожается.402403Конструктор создаёт [`BufferedWriter`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter) для переданного записываемого потока *raw*. Если *buffer\_size* не указан, по умолчанию используется [`DEFAULT_BUFFER_SIZE`](https://python-all.ru/3.2/library/io.html#io.DEFAULT_BUFFER_SIZE).404405Поддерживается третий аргумент *max\_buffer\_size*, но он не используется и является устаревшим.406407[`BufferedWriter`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter) предоставляет или переопределяет следующие методы в дополнение к методам из [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase) и [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase):408409#### `flush()`410411Принудительно сбрасывает байты, находящиеся в буфере, в необработанный поток. Если необработанный поток блокируется, должно быть возбуждено исключение [`BlockingIOError`](https://python-all.ru/3.2/library/io.html#io.BlockingIOError).412413#### `write(b)`414415Записывает объект bytes или bytearray *b* и возвращает количество записанных байтов. В неблокирующем режиме, если требуется сбросить буфер, но необработанный поток блокируется, возбуждается исключение [`BlockingIOError`](https://python-all.ru/3.2/library/io.html#io.BlockingIOError).416417#### `class io.BufferedRandom(raw, buffer_size=DEFAULT_BUFFER_SIZE)`418419Буферизованный интерфейс для потоков с произвольным доступом. Он наследует [`BufferedReader`](https://python-all.ru/3.2/library/io.html#io.BufferedReader) и [`BufferedWriter`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter), а также поддерживает функциональность `seek()` и `tell()`.420421Конструктор создаёт читатель и писатель для позиционируемого необработанного потока, заданного в первом аргументе. Если *buffer\_size* опущен, по умолчанию используется [`DEFAULT_BUFFER_SIZE`](https://python-all.ru/3.2/library/io.html#io.DEFAULT_BUFFER_SIZE).422423Третий аргумент, *max\_buffer\_size*, поддерживается, но не используется и устарел.424425[`BufferedRandom`](https://python-all.ru/3.2/library/io.html#io.BufferedRandom) способен на всё, что могут [`BufferedReader`](https://python-all.ru/3.2/library/io.html#io.BufferedReader) или [`BufferedWriter`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter).426427#### `class io.BufferedRWPair(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE)`428429Буферизованный объект ввода-вывода, объединяющий два однонаправленных объекта [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase) – один читаемый, другой записываемый – в единую двунаправленную конечную точку. Он наследует [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase).430431*reader* и *writer* – это объекты [`RawIOBase`](https://python-all.ru/3.2/library/io.html#io.RawIOBase), предназначенные соответственно для чтения и записи. Если *buffer\_size* опущен, по умолчанию используется [`DEFAULT_BUFFER_SIZE`](https://python-all.ru/3.2/library/io.html#io.DEFAULT_BUFFER_SIZE).432433Четвёртый аргумент, *max\_buffer\_size*, поддерживается, но не используется и устарел.434435[`BufferedRWPair`](https://python-all.ru/3.2/library/io.html#io.BufferedRWPair) реализует все методы [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase), за исключением [`detach()`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase.detach), который возбуждает [`UnsupportedOperation`](https://python-all.ru/3.2/library/io.html#io.UnsupportedOperation).436437> **Предупреждение**438>439> [`BufferedRWPair`](https://python-all.ru/3.2/library/io.html#io.BufferedRWPair) не пытается синхронизировать доступ к своим базовым необработанным потокам. Не следует передавать ему один и тот же объект в качестве читателя и писателя; вместо этого используйте [`BufferedRandom`](https://python-all.ru/3.2/library/io.html#io.BufferedRandom).440441### 15.2.3.4. Текстовый ввод-вывод442443#### `class io.TextIOBase`444445Базовый класс для текстовых потоков. Этот класс предоставляет посимвольный и построчный интерфейс для потокового ввода-вывода. Метод `readinto()` отсутствует, поскольку строки Python неизменяемы. Он наследует [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase). Открытый конструктор отсутствует.446447[`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase) предоставляет или переопределяет следующие атрибуты данных и методы в дополнение к унаследованным от [`IOBase`](https://python-all.ru/3.2/library/io.html#io.IOBase):448449#### `encoding`450451Имя кодировки, используемой для декодирования байтов потока в строки и для кодирования строк в байты.452453#### `errors`454455Настройка обработки ошибок декодера или кодера.456457#### `newlines`458459Строка, кортеж строк или `None`, указывающие на переведённые на данный момент символы новой строки. В зависимости от реализации и начальных флагов конструктора это может быть недоступно.460461#### `buffer`462463Базовый бинарный буфер (экземпляр [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase)), с которым работает [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase). Это не часть API [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase) и может отсутствовать в некоторых реализациях.464465#### `detach()`466467Отделяет базовый бинарный буфер от [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase) и возвращает его.468469После отсоединения базового буфера [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase) переходит в неработоспособное состояние.470471Некоторые реализации [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase), например [`StringIO`](https://python-all.ru/3.2/library/io.html#io.StringIO), могут не иметь понятия базового буфера, и вызов этого метода приведёт к возбуждению [`UnsupportedOperation`](https://python-all.ru/3.2/library/io.html#io.UnsupportedOperation).472473Новое в версии 3.1.474475#### `read(n)`476477Читает и возвращает не более *n* символов из потока в виде одной [`str`](https://python-all.ru/3.2/library/functions.html#str). Если *n* отрицательно или `None`, читает до конца файла (EOF).478479#### `readline(limit=-1)`480481Читает до символа новой строки или конца файла и возвращает одну строку `str`. Если поток уже достиг конца файла, возвращается пустая строка.482483Если *limit* указан, будет прочитано не более *limit* символов.484485#### `seek(offset, whence=SEEK_SET)`486487Изменяет позицию в потоке на заданный *offset*. Поведение зависит от параметра *whence*:488489- `SEEK_SET` или `0`: поиск от начала потока (по умолчанию); *offset* должен быть либо числом, возвращённым [`TextIOBase.tell()`](https://python-all.ru/3.2/library/io.html#io.TextIOBase.tell), либо нулём. Любое другое значение *offset* приводит к неопределённому поведению.490- `SEEK_CUR` или `1`: «поиск» на текущую позицию; *offset* должен быть нулём, что означает отсутствие операции (все остальные значения не поддерживаются).491- `SEEK_END` или `2`: переход в конец потока; *offset* должен быть равен нулю (другие значения не поддерживаются).492493Возвращает новую абсолютную позицию в виде непрозрачного числа.494495Новое в версии 3.1: Константы `SEEK_*`.496497#### `tell()`498499Возвращает текущую позицию в потоке в виде непрозрачного числа. Обычно это число не соответствует количеству байт в базовом двоичном хранилище.500501#### `write(s)`502503Записывает строку *s* в поток и возвращает количество записанных символов.504505#### `class io.TextIOWrapper(buffer, encoding=None, errors=None, newline=None, line_buffering=False)`506507Буферизированный текстовый поток поверх бинарного потока [`BufferedIOBase`](https://python-all.ru/3.2/library/io.html#io.BufferedIOBase). Наследует [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase).508509*encoding* задаёт имя кодировки, в которую будет декодироваться или кодироваться поток. По умолчанию используется [`locale.getpreferredencoding()`](https://python-all.ru/3.2/library/locale.html#locale.getpreferredencoding).510511*errors* – необязательная строка, определяющая, как обрабатывать ошибки кодирования и декодирования. Передача `'strict'` вызывает исключение [`ValueError`](https://python-all.ru/3.2/library/exceptions.html#ValueError) при ошибке кодирования (значение по умолчанию `None` имеет тот же эффект), а `'ignore'` игнорирует ошибки. (Обратите внимание, что игнорирование ошибок кодирования может привести к потере данных.) `'replace'` вставляет замещающий символ (например, `'?'`) в места неверных данных. При записи можно использовать `'xmlcharrefreplace'` (замена соответствующей XML-ссылкой на символ) или `'backslashreplace'` (замена escape-последовательностями с обратной косой чертой). Допустимо любое другое имя обработки ошибок, зарегистрированное в [`codecs.register_error()`](https://python-all.ru/3.2/library/codecs.html#codecs.register_error).512513*newline* управляет обработкой концов строк. Может принимать значения `None`, `''`, `'\n'`, `'\r'` и `'\r\n'`. Работает следующим образом:514515- При чтении данных из потока, если *newline* равно `None`, включается режим [*универсальных концов строк*](https://python-all.ru/3.2/glossary.html#term-universal-newlines). Строки во входных данных могут заканчиваться на `'\n'`, `'\r'` или `'\r\n'`, и они преобразуются в `'\n'` перед возвратом вызывающему коду. Если значение равно `''`, режим универсальных концов строк также включён, но символы концов строк возвращаются вызывающему коду без преобразования. Если значение равно любому другому допустимому значению, входные строки завершаются только указанной строкой, и символ конца строки возвращается вызывающему коду без преобразования.516- При записи в поток, если *newline* равен `None`, все записанные символы `'\n'` преобразуются в системный разделитель строк по умолчанию [`os.linesep`](https://python-all.ru/3.2/library/os.html#os.linesep). Если *newline* равен `''` или `'\n'`, никакого преобразования не происходит. Если *newline* – любое другое допустимое значение, все записанные символы `'\n'` преобразуются в указанную строку.517518Если *line\_buffering* равно `True`, `flush()` подразумевается при вызове write, содержащем символ новой строки.519520[`TextIOWrapper`](https://python-all.ru/3.2/library/io.html#io.TextIOWrapper) предоставляет один атрибут в дополнение к атрибутам [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase) и его родительских классов:521522#### `line_buffering`523524Определяет, включена ли построчная буферизация.525526#### `class io.StringIO(initial_value='', newline=None)`527528Поток в памяти для текстового ввода-вывода.529530Начальное значение буфера (по умолчанию пустая строка) можно задать с помощью *initial\_value*. Аргумент *newline* работает так же, как в [`TextIOWrapper`](https://python-all.ru/3.2/library/io.html#io.TextIOWrapper). По умолчанию перевод строки не выполняется.531532[`StringIO`](https://python-all.ru/3.2/library/io.html#io.StringIO) предоставляет этот метод в дополнение к методам из [`TextIOBase`](https://python-all.ru/3.2/library/io.html#io.TextIOBase) и его родительских классов:533534#### `getvalue()`535536Возвращает `str`, содержащую полное содержимое буфера в любой момент до вызова метода `close()` объекта [`StringIO`](https://python-all.ru/3.2/library/io.html#io.StringIO).537538Пример использования:539540```python541import io542543output = io.StringIO()544output.write('First line.\n')545print('Second line.', file=output)546547# Извлечь содержимое файла – это будет548# 'Первая строка.549Вторая строка.550'551contents = output.getvalue()552553# Закрыть объект и освободить буфер памяти –554# .getvalue() теперь будет вызывать исключение.555output.close()556```557558#### `class io.IncrementalNewlineDecoder`559560Вспомогательный кодек для декодирования концов строк в режиме [*универсальных концов строк*](https://python-all.ru/3.2/glossary.html#term-universal-newlines). Наследует [`codecs.IncrementalDecoder`](https://python-all.ru/3.2/library/codecs.html#codecs.IncrementalDecoder).561562## 15.2.4. Производительность563564В этом разделе рассматривается производительность предоставленных конкретных реализаций ввода-вывода.565566### 15.2.4.1. Бинарный ввод-вывод567568Читая и записывая только большие блоки данных даже при запросе одного байта, буферизованный ввод-вывод скрывает неэффективность вызова и выполнения небуферизованных процедур ввода-вывода операционной системы. Выигрыш зависит от ОС и типа выполняемого ввода-вывода. Например, в некоторых современных ОС, таких как Linux, небуферизованный дисковый ввод-вывод может быть таким же быстрым, как буферизованный. Однако суть в том, что буферизованный ввод-вывод обеспечивает предсказуемую производительность независимо от платформы и базового устройства. Поэтому для бинарных данных почти всегда предпочтительнее использовать буферизованный ввод-вывод, а не небуферизованный.569570### 15.2.4.2. Текстовый ввод-вывод571572Текстовый ввод-вывод через бинарное хранилище (например, файл) значительно медленнее, чем бинарный ввод-вывод через то же хранилище, потому что требуется преобразование между юникодом и бинарными данными с помощью символьного кодека. Это может стать заметным при обработке огромных объёмов текстовых данных, таких как большие файлы журналов. Кроме того, `TextIOWrapper.tell()` и `TextIOWrapper.seek()` работают довольно медленно из-за используемого алгоритма восстановления.573574[`StringIO`](https://python-all.ru/3.2/library/io.html#io.StringIO), однако, является собственным контейнером юникода в памяти и будет демонстрировать скорость, аналогичную [`BytesIO`](https://python-all.ru/3.2/library/io.html#io.BytesIO).575576### 15.2.4.3. Многопоточность577578Объекты [`FileIO`](https://python-all.ru/3.2/library/io.html#io.FileIO) являются потокобезопасными в той степени, в какой потокобезопасны системные вызовы (например, `read(2)` в Unix), которые они обёртывают.579580Буферизированные бинарные объекты (экземпляры [`BufferedReader`](https://python-all.ru/3.2/library/io.html#io.BufferedReader), [`BufferedWriter`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter), [`BufferedRandom`](https://python-all.ru/3.2/library/io.html#io.BufferedRandom) и [`BufferedRWPair`](https://python-all.ru/3.2/library/io.html#io.BufferedRWPair)) защищают свои внутренние структуры с помощью блокировки; поэтому их можно безопасно вызывать из нескольких потоков одновременно.581582Объекты [`TextIOWrapper`](https://python-all.ru/3.2/library/io.html#io.TextIOWrapper) не являются потокобезопасными.583584### 15.2.4.4. Повторная входимость585586Бинарные буферизованные объекты (экземпляры [`BufferedReader`](https://python-all.ru/3.2/library/io.html#io.BufferedReader), [`BufferedWriter`](https://python-all.ru/3.2/library/io.html#io.BufferedWriter), [`BufferedRandom`](https://python-all.ru/3.2/library/io.html#io.BufferedRandom) и [`BufferedRWPair`](https://python-all.ru/3.2/library/io.html#io.BufferedRWPair)) не являются реентерабельными. Хотя реентерабельные вызовы в нормальных ситуациях не возникают, они могут появиться при выполнении ввода-вывода в обработчике [`signal`](https://python-all.ru/3.2/library/signal.html#module-signal). Если поток попытается повторно войти в буферизованный объект, к которому он уже обращается, возбуждается [`RuntimeError`](https://python-all.ru/3.2/library/exceptions.html#RuntimeError). Заметьте, это не запрещает другому потоку входить в буферизованный объект.587588Сказанное выше неявно распространяется и на текстовые файлы, поскольку функция [`open()`](https://python-all.ru/3.2/library/functions.html#open) обёртывает буферизированный объект внутри [`TextIOWrapper`](https://python-all.ru/3.2/library/io.html#io.TextIOWrapper). Это включает стандартные потоки и, следовательно, также влияет на встроенную функцию [`print()`](https://python-all.ru/3.2/library/functions.html#print).589