16.2. io – Основные инструменты для работы с потоками¶io – Core tools for working with streams

16.2.1.1. Текстовый ввод/вывод¶Text I/O

Текстовый ввод-вывод ожидает и создаёт объекты str. Это означает, что когда хранилище данных изначально состоит из байтов (как в случае с файлом), кодирование и декодирование данных выполняется прозрачно, а также выполняется опциональное преобразование символов новой строки, специфичных для платформы.

Самый простой способ создать текстовый поток – использовать open(), опционально указав кодировку:

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

Текстовые потоки в памяти также доступны как объекты StringIO:

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

API текстовых потоков подробно описан в документации TextIOBase.

16.2.1.2. Двоичный ввод/вывод¶Binary I/O

Двоичный ввод-вывод (также называемый буферизованным вводом-выводом) ожидает и создаёт объекты bytes. Никакого кодирования, декодирования или преобразования новых строк не выполняется. Эта категория потоков может использоваться для всех видов нетекстовых данных, а также когда требуется ручное управление обработкой текстовых данных.

Самый простой способ создать двоичный поток – использовать open() с 'b' в строке режима:

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

Двоичные потоки в памяти также доступны как объекты BytesIO:

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

API двоичных потоков подробно описан в документации BufferedIOBase.

Другие модули библиотеки могут предоставлять дополнительные способы создания текстовых или двоичных потоков. Смотрите, например, socket.socket.makefile().

16.2.1.3. Сырой ввод/вывод¶Raw I/O

Необработанный ввод-вывод (также называемый небуферизованным вводом-выводом) обычно используется как низкоуровневый строительный блок для двоичных и текстовых потоков; редко бывает полезно напрямую манипулировать необработанным потоком из пользовательского кода. Тем не менее, можно создать необработанный поток, открыв файл в двоичном режиме с отключённой буферизацией:

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

API сырых потоков подробно описан в документации RawIOBase.

16.2.2.1. Потоки в памяти¶In-memory streams

Также можно использовать объект, подобный str или bytes, в качестве файла как для чтения, так и для записи. Для строк StringIO можно использовать как файл, открытый в текстовом режиме. BytesIO можно использовать как файл, открытый в двоичном режиме. Оба предоставляют полные возможности чтения и записи с произвольным доступом.

16.2.3.1. Базовые классы ввода/вывода¶I/O Base Classes

class io.IOBase¶

Абстрактный базовый класс для всех классов ввода-вывода, работающий с потоками байтов. Отсутствует открытый конструктор.

Этот класс предоставляет пустые абстрактные реализации для многих методов, которые производные классы могут выборочно переопределять; реализации по умолчанию представляют файл, который нельзя читать, записывать или позиционировать.

Хотя IOBase не объявляет read(), readinto(), или write(), поскольку их сигнатуры различаются, реализации и клиенты должны считать эти методы частью интерфейса. Кроме того, реализации могут вызывать ValueError (или UnsupportedOperation) при вызове неподдерживаемых операций.

Основным типом для двоичных данных, читаемых из файла или записываемых в файл, является bytes. bytearray также принимаются, а в некоторых случаях (например, для readinto()) требуются. Классы текстового ввода-вывода работают с данными типа str.

Обратите внимание, что вызов любого метода (даже запросов) для закрытого потока не определён. Реализации могут вызывать 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()¶

Возвращает базовый файловый дескриптор (целое число) потока, если он существует. Если объект ввода-вывода не использует файловый дескриптор, вызывается OSError.

flush()¶

Сбрасывает буферы записи потока, если это применимо. Для потоков только для чтения и неблокирующих потоков эта операция ничего не делает.

isatty()¶

Возвращает True, если поток интерактивный (т.е. подключен к терминалу/tty-устройству).

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])¶

Изменяет позицию в потоке на указанное количество байт offset. offset интерпретируется относительно позиции, заданной whence. Значение по умолчанию для whence – SEEK_SET. Допустимые значения для whence:

• SEEK_SET или 0 – начало потока (по умолчанию); offset должен быть нулевым или положительным
• SEEK_CUR или 1 – текущая позиция в потоке; offset может быть отрицательным
• SEEK_END или 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 не указан). Текущая позиция в потоке не изменяется. Это изменение размера может увеличить или уменьшить текущий размер файла. В случае увеличения содержимое новой области файла зависит от платформы (в большинстве систем дополнительные байты заполняются нулями, в Windows они не определены). Возвращается новый размер файла.

writable()¶

Return True if the stream supports writing. If False, write() and truncate() will raise OSError.

writelines(lines)¶

Записывает список строк в поток. Разделители строк не добавляются, поэтому обычно каждая переданная строка уже содержит разделитель в конце.

__del__()¶

Подготовка к уничтожению объекта. IOBase предоставляет реализацию этого метода по умолчанию, которая вызывает метод close() экземпляра.

class io.RawIOBase¶

Базовый класс для необработанного бинарного ввода-вывода. Наследует IOBase. Открытого конструктора нет.

Необработанный двоичный ввод-вывод обычно предоставляет низкоуровневый доступ к базовому устройству или API операционной системы и не пытается инкапсулировать его в высокоуровневые примитивы (это оставлено буферизованному и текстовому вводу-выводу, описанным далее на этой странице).

В дополнение к атрибутам и методам из IOBase, RawIOBase предоставляет следующие методы:

read(size=-1)¶

Читает до size байт из объекта и возвращает их. Для удобства, если size не указан или равен -1, вызывается readall(). В противном случае выполняется только один системный вызов. Может быть возвращено меньше size байт, если системный вызов вернул меньше size байт.

Если возвращено 0 байт, а size не был равен 0, это означает конец файла. Если объект находится в неблокирующем режиме и байты недоступны, возвращается None.

readall()¶

Читает и возвращает все байты из потока до EOF, при необходимости выполняя несколько вызовов к потоку.

readinto(b)¶

Читает до len(b) байт в bytearray b и возвращает количество прочитанных байт. Если объект находится в неблокирующем режиме и байты недоступны, возвращается None.

write(b)¶

Записывает заданный объект bytes или bytearray, b, в нижележащий небуферизованный поток и возвращает количество записанных байт. Оно может быть меньше len(b) в зависимости от особенностей нижележащего небуферизованного потока, особенно если он находится в неблокирующем режиме. None возвращается, если небуферизованный поток настроен не блокироваться и ни один байт не может быть сразу записан в него.

class io.BufferedIOBase¶

Базовый класс для двоичных потоков, поддерживающих некоторую буферизацию. Он наследует IOBase. Открытый конструктор отсутствует.

Основное отличие от RawIOBase заключается в том, что методы read(), readinto() и write() будут пытаться (соответственно) прочитать столько входных данных, сколько запрошено, или потребить все переданные выходные данные, ценой, возможно, более одного системного вызова.

Кроме того, эти методы могут вызывать BlockingIOError, если нижележащий небуферизованный поток находится в неблокирующем режиме и не может принять или отдать достаточно данных; в отличие от их аналогов из RawIOBase, они никогда не вернут None.

Besides, the read() method does not have a default implementation that defers to readinto().

Типичная реализация BufferedIOBase не должна наследовать от реализации RawIOBase, а должна оборачивать её, как это делают BufferedWriter и BufferedReader.

BufferedIOBase предоставляет или переопределяет следующие методы и атрибуты в дополнение к тем, что есть в IOBase:

raw¶

Нижележащий небуферизованный поток (экземпляр RawIOBase), с которым работает BufferedIOBase. Это не часть API BufferedIOBase и может отсутствовать в некоторых реализациях.

detach()¶

Отделяет базовый сырой поток от буфера и возвращает его.

После отсоединения сырого потока буфер переходит в нерабочее состояние.

Некоторые буферы, такие как BytesIO, не имеют понятия единого небуферизованного потока для возврата из этого метода. Они вызывают UnsupportedOperation.

Новое в версии 3.1.

read(size=-1)¶

Читает и возвращает до size байт. Если аргумент опущен, равен None или отрицателен, данные читаются и возвращаются до достижения EOF. Пустой объект bytes возвращается, если поток уже находится в конце файла.

Если аргумент положителен, а базовый сырой поток не является интерактивным, может быть выполнено несколько сырых чтений, чтобы обеспечить требуемое количество байт (если только не достигнут EOF). Но для интерактивных сырых потоков будет выполнено не более одного сырого чтения, и короткий результат не означает, что EOF неизбежен.

BlockingIOError возникает, если нижележащий небуферизованный поток находится в неблокирующем режиме и в данный момент не имеет доступных данных.

read1(size=-1)¶

Читает и возвращает до size байт, выполняя не более одного вызова метода read() нижележащего небуферизованного потока. Это может быть полезно при реализации собственной буферизации поверх объекта BufferedIOBase.

readinto(b)¶

Читает до len(b) байт в bytearray b и возвращает количество прочитанных байт.

Как и read(), может выполняться несколько чтений из нижележащего небуферизованного потока, если только последний не является интерактивным.

BlockingIOError возникает, если нижележащий небуферизованный поток находится в неблокирующем режиме и в данный момент не имеет доступных данных.

write(b)¶

Записывает заданный объект bytes или bytearray, b, и возвращает количество записанных байт (никогда не меньше len(b), так как в случае неудачи записи будет вызвано исключение OSError). В зависимости от конкретной реализации эти байты могут быть немедленно записаны в нижележащий поток или сохранены в буфере по соображениям производительности и задержки.

В неблокирующем режиме возникает BlockingIOError, если данные необходимо записать в небуферизованный поток, но он не может принять все данные без блокировки.

16.2.3.2. Сырой файловый ввод/вывод¶Raw File I/O

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

FileIO представляет файл на уровне ОС, содержащий байтовые данные. Он реализует интерфейс RawIOBase (а следовательно, и интерфейс IOBase).

Параметр name может быть одним из двух:

• строка символов или объект bytes, представляющий путь к файлу, который будет открыт;
• целое число, представляющее номер существующего файлового дескриптора на уровне ОС, к которому будет предоставлять доступ результирующий объект ⟦/2FileIO.

Параметр mode может быть 'r', 'w', 'x' или 'a' для чтения (по умолчанию), записи, эксклюзивного создания или добавления. Файл будет создан, если он не существует, при открытии для записи или добавления; при открытии для записи он будет обрезан. FileExistsError будет возбуждено, если файл уже существует при открытии для создания. Открытие файла для создания подразумевает запись, поэтому этот режим ведёт себя аналогично 'w'. Добавьте '+' в режим, чтобы разрешить одновременное чтение и запись.

Методы read() (при вызове с положительным аргументом), readinto() и write() этого класса будут выполнять только один системный вызов.

Можно использовать собственный открыватель, передав вызываемый объект как opener. Внутренний файловый дескриптор для файлового объекта затем получается вызовом opener с аргументами (name, flags). opener должен возвращать открытый файловый дескриптор (если передать os.open как opener, то поведение будет аналогично передаче None).

Созданный файл является ненаследуемым.

Примеры использования параметра opener см. во встроенной функции open().

Изменено в версии 3.3: Добавлен параметр opener. Добавлен режим 'x'.

Изменено в версии 3.4: Файл теперь не наследуется.

In addition to the attributes and methods from IOBase and RawIOBase, FileIO provides the following data attributes:

mode¶

Режим, указанный в конструкторе.

name¶

Имя файла. Это дескриптор файла, если имя не указано в конструкторе.

16.2.3.3. Буферизированные потоки¶Buffered Streams

Буферизированные потоки ввода-вывода предоставляют интерфейс более высокого уровня к устройству ввода-вывода, чем небуферизированный.

class io.BytesIO([initial_bytes])¶

Реализация потока, использующая буфер байтов в памяти. Наследует BufferedIOBase. Буфер отбрасывается при вызове метода close().

Аргумент initial_bytes содержит необязательные начальные данные bytes.

BytesIO предоставляет или переопределяет следующие методы в дополнение к методам из BufferedIOBase и IOBase:

getbuffer()¶

Возвращает доступное для чтения и записи представление содержимого буфера без его копирования. Изменение этого представления также прозрачно обновляет содержимое буфера:

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

Примечание

Пока существует представление, объект BytesIO не может быть изменён в размере или закрыт.

Новое в версии 3.2.

getvalue()¶

Возвращает bytes, содержащий всё содержимое буфера.

read1()¶

В BytesIO это эквивалентно read().

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

Буфер, обеспечивающий доступ более высокого уровня к читаемому последовательному объекту RawIOBase. Наследует BufferedIOBase. При чтении данных из этого объекта из нижележащего необработанного потока может запрашиваться больший объём данных, которые сохраняются во внутреннем буфере. Затем буферизованные данные могут быть прямо возвращены при последующих чтениях.

Конструктор создаёт BufferedReader для переданного читаемого потока raw и buffer_size. Если buffer_size опущен, используется DEFAULT_BUFFER_SIZE.

BufferedReader предоставляет или переопределяет следующие методы в дополнение к методам из BufferedIOBase и IOBase:

peek([size])¶

Возвращает байты из потока без продвижения позиции. Для выполнения вызова производится не более одного чтения из сырого потока. Количество возвращённых байт может быть меньше или больше запрошенного.

read([size])¶

Читает и возвращает size байт, или, если size не задан или отрицателен, до достижения EOF или пока вызов чтения не заблокируется в неблокирующем режиме.

read1(size)¶

Читает и возвращает до size байт, выполняя только один вызов к сырому потоку. Если хотя бы один байт уже находится в буфере, возвращаются только буферизованные байты. В противном случае выполняется один вызов чтения сырого потока.

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

Буфер, обеспечивающий доступ более высокого уровня к записываемому последовательному объекту RawIOBase. Наследует BufferedIOBase. При записи в этот объект данные обычно помещаются во внутренний буфер. Буфер будет сброшен в нижележащий объект RawIOBase при следующих условиях:

• когда буфер становится слишком мал для всех ожидающих данных;
• при вызове flush();
• при запросе seek() (для объектов BufferedRandom);
• когда объект BufferedWriter закрывается или уничтожается.

Конструктор создаёт BufferedWriter для переданного записываемого потока raw. Если buffer_size не указан, по умолчанию используется DEFAULT_BUFFER_SIZE.

BufferedWriter предоставляет или переопределяет следующие методы в дополнение к методам из BufferedIOBase и IOBase:

flush()¶

Принудительно сбрасывает байты, находящиеся в буфере, в необработанный поток. Если необработанный поток блокируется, должно быть возбуждено исключение BlockingIOError.

write(b)¶

Записывает объект bytes или bytearray, b и возвращает количество записанных байт. В неблокирующем режиме возникает BlockingIOError, если буфер необходимо выгрузить, но необработанный поток блокируется.

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

Буферизованный интерфейс для потоков с произвольным доступом. Он наследует BufferedReader и BufferedWriter, а также поддерживает функциональность seek() и tell().

Конструктор создаёт читатель и писатель для позиционируемого необработанного потока, заданного в первом аргументе. Если buffer_size опущен, по умолчанию используется DEFAULT_BUFFER_SIZE.

BufferedRandom способен на всё, что могут BufferedReader или BufferedWriter.

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

Буферизованный объект ввода-вывода, объединяющий два однонаправленных объекта RawIOBase – один читаемый, другой записываемый – в единую двунаправленную конечную точку. Он наследует BufferedIOBase.

reader и writer – это объекты RawIOBase, предназначенные соответственно для чтения и записи. Если buffer_size опущен, по умолчанию используется DEFAULT_BUFFER_SIZE.

BufferedRWPair реализует все методы BufferedIOBase, за исключением detach(), который возбуждает UnsupportedOperation.

Предупреждение

BufferedRWPair не пытается синхронизировать доступ к своим базовым необработанным потокам. Не следует передавать ему один и тот же объект в качестве читателя и писателя; вместо этого используйте BufferedRandom.

16.2.3.4. Текстовый ввод-вывод¶Text I/O

class io.TextIOBase¶

Базовый класс для текстовых потоков. Этот класс предоставляет посимвольный и построчный интерфейс для потокового ввода-вывода. Метод readinto() отсутствует, поскольку строки Python неизменяемы. Он наследует IOBase. Открытый конструктор отсутствует.

TextIOBase предоставляет или переопределяет следующие атрибуты данных и методы в дополнение к унаследованным от IOBase:

encoding¶

Имя кодировки, используемой для декодирования байтов потока в строки и для кодирования строк в байты.

errors¶

Настройка обработки ошибок декодера или кодера.

newlines¶

Строка, кортеж строк или None, указывающие на переведённые на данный момент символы новой строки. В зависимости от реализации и начальных флагов конструктора это может быть недоступно.

buffer¶

Базовый бинарный буфер (экземпляр BufferedIOBase), с которым работает TextIOBase. Это не часть API TextIOBase и может отсутствовать в некоторых реализациях.

detach()¶

Отделяет базовый бинарный буфер от TextIOBase и возвращает его.

После отсоединения базового буфера TextIOBase переходит в неработоспособное состояние.

Некоторые реализации TextIOBase, например StringIO, могут не иметь понятия базового буфера, и вызов этого метода приведёт к возбуждению UnsupportedOperation.

Новое в версии 3.1.

read(size)¶

Читает не более size символов из потока и возвращает их в виде одной строки str. Если size отрицателен или равен None, читает до конца файла.

readline(size=-1)¶

Читает до символа новой строки или конца файла и возвращает одну строку str. Если поток уже достиг конца файла, возвращается пустая строка.

Если указан size, будет прочитано не более size символов.

seek(offset[, whence])¶

Изменяет позицию в потоке на указанное значение offset. Поведение зависит от параметра whence. Значение по умолчанию для whence – SEEK_SET.

• SEEK_SET или 0: поиск от начала потока (по умолчанию); offset должен быть либо числом, возвращённым TextIOBase.tell(), либо нулём. Любое другое значение offset приводит к неопределённому поведению.
• SEEK_CUR или 1: «поиск» на текущую позицию; offset должен быть нулём, что означает отсутствие операции (все остальные значения не поддерживаются).
• SEEK_END или 2: переход в конец потока; offset должен быть равен нулю (другие значения не поддерживаются).

Возвращает новую абсолютную позицию в виде непрозрачного числа.

Новое в версии 3.1: Константы SEEK_*.

tell()¶

Возвращает текущую позицию в потоке в виде непрозрачного числа. Обычно это число не соответствует количеству байт в базовом двоичном хранилище.

write(s)¶

Записывает строку s в поток и возвращает количество записанных символов.

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

Буферизированный текстовый поток поверх бинарного потока BufferedIOBase. Наследует TextIOBase.

encoding задаёт имя кодировки, которая будет использоваться для декодирования или кодирования потока. По умолчанию используется locale.getpreferredencoding(False).

errors – необязательная строка, определяющая, как обрабатывать ошибки кодирования и декодирования. Передача 'strict' вызывает исключение ValueError при ошибке кодирования (значение по умолчанию None имеет тот же эффект), а 'ignore' игнорирует ошибки. (Обратите внимание, что игнорирование ошибок кодирования может привести к потере данных.) 'replace' вставляет замещающий символ (например, '?') в места неверных данных. При записи можно использовать 'xmlcharrefreplace' (замена соответствующей XML-ссылкой на символ) или 'backslashreplace' (замена escape-последовательностями с обратной косой чертой). Допустимо любое другое имя обработки ошибок, зарегистрированное в codecs.register_error().

newline управляет обработкой концов строк. Может принимать значения None, '', '\n', '\r' и '\r\n'. Работает следующим образом:

• При чтении данных из потока, если newline равно None, включается режим универсальных концов строк. Строки во входных данных могут заканчиваться на '\n', '\r' или '\r\n', и они преобразуются в '\n' перед возвратом вызывающему коду. Если значение равно '', режим универсальных концов строк также включён, но символы концов строк возвращаются вызывающему коду без преобразования. Если значение равно любому другому допустимому значению, входные строки завершаются только указанной строкой, и символ конца строки возвращается вызывающему коду без преобразования.
• При записи в поток, если newline равен None, все записанные символы '\n' преобразуются в системный разделитель строк по умолчанию os.linesep. Если newline равен '' или '\n', никакого преобразования не происходит. Если newline – любое другое допустимое значение, все записанные символы '\n' преобразуются в указанную строку.

Если line_buffering равно True, flush() подразумевается при вызове write, содержащем символ новой строки.

Если write_through равно True, вызовы write() гарантированно не буферизируются: любые данные, записанные в объект TextIOWrapper, немедленно передаются его нижележащему бинарному buffer.

Изменено в версии 3.3: Добавлен аргумент write_through.

Изменено в версии 3.3: Кодировка по умолчанию encoding теперь locale.getpreferredencoding(False) вместо locale.getpreferredencoding(). Не меняйте временно кодировку локали с помощью locale.setlocale(), используйте текущую кодировку локали вместо предпочитаемой пользователем.

TextIOWrapper предоставляет один атрибут в дополнение к атрибутам TextIOBase и его родительских классов:

line_buffering¶

Определяет, включена ли построчная буферизация.

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

Поток в памяти для текстового ввода-вывода. Текстовый буфер очищается при вызове метода close().

Начальное значение буфера можно задать, указав initial_value. Если преобразование концов строк включено, символы новой строки будут кодироваться так, как если бы они были записаны через write(). Поток позиционируется в начало буфера.

Аргумент newline работает так же, как в TextIOWrapper. По умолчанию только символ \n считается концом строки, и никакого преобразования концов строк не выполняется. Если newline установлен в None, символы новой строки записываются как \n на всех платформах, но при чтении всё равно выполняется универсальное декодирование концов строк.

StringIO предоставляет этот метод в дополнение к методам из TextIOBase и его родительских классов:

getvalue()¶

Возвращает str, содержащий всё содержимое буфера. Символы новой строки декодируются так, как если бы они были прочитаны через read(), хотя позиция в потоке не изменяется.

Пример использования:

import io

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

# Извлечь содержимое файла – это будет
# 'Первая строка.
Вторая строка.
'
contents = output.getvalue()

# Закрыть объект и освободить буфер памяти –
# .getvalue() теперь будет вызывать исключение.
output.close()

class io.IncrementalNewlineDecoder¶

Вспомогательный кодек для декодирования концов строк в режиме универсальных концов строк. Наследует codecs.IncrementalDecoder.

16.2.4.1. Двоичный ввод-вывод¶Binary I/O

Читая и записывая только большие блоки данных, даже когда пользователь запрашивает один байт, буферизованный ввод-вывод скрывает любую неэффективность вызова и выполнения небуферизованных процедур ввода-вывода операционной системы. Выигрыш зависит от ОС и типа выполняемого ввода-вывода. Например, в некоторых современных ОС, таких как Linux, небуферизованный дисковый ввод-вывод может быть таким же быстрым, как буферизованный. Однако суть в том, что буферизованный ввод-вывод обеспечивает предсказуемую производительность независимо от платформы и нижележащего устройства. Поэтому для двоичных данных почти всегда предпочтительнее использовать буферизованный ввод-вывод, а не небуферизованный.

16.2.4.2. Текстовый ввод-вывод¶Text I/O

Текстовый ввод-вывод через бинарное хранилище (например, файл) значительно медленнее, чем бинарный ввод-вывод через то же хранилище, потому что требуется преобразование между юникодом и бинарными данными с помощью символьного кодека. Это может стать заметным при обработке огромных объёмов текстовых данных, таких как большие файлы журналов. Кроме того, TextIOWrapper.tell() и TextIOWrapper.seek() работают довольно медленно из-за используемого алгоритма восстановления.

StringIO, однако, является собственным контейнером юникода в памяти и будет демонстрировать скорость, аналогичную BytesIO.

16.2.4.3. Многопоточность¶Multi-threading

Объекты FileIO являются потокобезопасными в той степени, в какой потокобезопасны системные вызовы (например, read(2) в Unix), которые они обёртывают.

Буферизированные бинарные объекты (экземпляры BufferedReader, BufferedWriter, BufferedRandom и BufferedRWPair) защищают свои внутренние структуры с помощью блокировки; поэтому их можно безопасно вызывать из нескольких потоков одновременно.

Объекты TextIOWrapper не являются потокобезопасными.

16.2.4.4. Реентерабельность¶Reentrancy

Буферизированные бинарные объекты (экземпляры BufferedReader, BufferedWriter, BufferedRandom и BufferedRWPair) не являются реентерабельными. Хотя реентерабельные вызовы обычно не происходят в нормальных ситуациях, они могут возникнуть при выполнении ввода-вывода в обработчике сигнала. Если поток попытается повторно войти в буферизированный объект, к которому он уже обращается, вызывается RuntimeError. Обратите внимание, это не запрещает другому потоку входить в буферизированный объект.

Сказанное выше неявно распространяется и на текстовые файлы, поскольку функция open() обёртывает буферизированный объект внутри TextIOWrapper. Это включает стандартные потоки и, следовательно, также влияет на встроенную функцию print().