Содержание страницы
15.2. io – Основные инструменты для работы с потоками¶io – Core tools for working with streams
15.2.1. Обзор¶Overview
Модуль io предоставляет основные средства Python для работы с различными типами ввода-вывода. Существует три основных типа ввода-вывода: текстовый ввод-вывод, двоичный ввод-вывод и необработанный ввод-вывод. Это общие категории, и для каждой из них могут использоваться различные подсистемы хранения. Конкретные объекты, принадлежащие к любой из этих категорий, часто называют потоками данных; другой распространённый термин – объекты, подобные файлам.
Независимо от категории, каждый конкретный объект потока также может обладать различными возможностями: он может быть только для чтения, только для записи или для чтения и записи. Он также может поддерживать произвольный доступ (переход вперёд или назад к любому месту) или только последовательный доступ (например, в случае сокета или канала).
Все потоки внимательны к типу данных, которые им передаются. Например, передача объекта str методу write() двоичного потока вызовет исключение TypeError. То же самое произойдёт при передаче объекта bytes методу write() текстового потока.
15.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.
15.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().
15.2.1.3. Необработанный ввод-вывод¶Raw I/O
Необработанный ввод-вывод (также называемый небуферизованным вводом-выводом) обычно используется как низкоуровневый строительный блок для двоичных и текстовых потоков; редко бывает полезно напрямую манипулировать необработанным потоком из пользовательского кода. Тем не менее, можно создать необработанный поток, открыв файл в двоичном режиме с отключённой буферизацией:
f = open("myfile.jpg", "rb", buffering=0)
API сырых потоков подробно описан в документации RawIOBase.
15.2.2. Интерфейс модуля высокого уровня¶High-level Module Interface
- io.DEFAULT_BUFFER_SIZE¶
- Целое число, содержащее размер буфера по умолчанию, используемый буферизованными классами ввода-вывода модуля. open() использует blksize файла (получаемый с помощью os.stat()), если это возможно.
- io.open(file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True)¶
- Это псевдоним для встроенной функции open().
- exception io.BlockingIOError¶
Исключение, возникающее при блокировке неблокирующего потока. Наследует IOError.
В дополнение к атрибутам IOError, BlockingIOError имеет один атрибут:
- characters_written¶
- Целое число, содержащее количество символов, записанных в поток до его блокировки.
- exception io.UnsupportedOperation¶
- Исключение, наследующее IOError и ValueError, которое возбуждается при вызове неподдерживаемой операции над потоком.
15.2.2.1. Потоки в памяти¶In-memory streams
Также можно использовать объект, подобный str или bytes, в качестве файла как для чтения, так и для записи. Для строк StringIO можно использовать как файл, открытый в текстовом режиме. BytesIO можно использовать как файл, открытый в двоичном режиме. Оба предоставляют полные возможности чтения и записи с произвольным доступом.
См. также
- sys
- содержит стандартные потоки ввода-вывода: sys.stdin, sys.stdout и sys.stderr.
15.2.3. Иерархия классов¶Class hierarchy
Реализация потоков ввода-вывода организована в виде иерархии классов. Сначала абстрактные базовые классы (ABC), которые используются для определения различных категорий потоков, затем конкретные классы, предоставляющие стандартные реализации потоков.
Примечание
Абстрактные базовые классы также предоставляют реализации некоторых методов по умолчанию, чтобы упростить реализацию конкретных классов потоков. Например, BufferedIOBase предоставляет неоптимизированные реализации readinto() и readline().
На вершине иерархии ввода-вывода находится абстрактный базовый класс IOBase. Он определяет базовый интерфейс для потока. Однако обратите внимание, что нет разделения между чтением и записью в потоках; реализациям разрешено вызывать UnsupportedOperation, если они не поддерживают данную операцию.
Абстрактный базовый класс RawIOBase расширяет IOBase. Он занимается чтением и записью байтов в поток. FileIO является подклассом RawIOBase и предоставляет интерфейс для файлов в файловой системе машины.
Абстрактный базовый класс BufferedIOBase занимается буферизацией на сыром байтовом потоке (RawIOBase). Его подклассы BufferedWriter, BufferedReader и BufferedRWPair буферизуют потоки, которые доступны для чтения, записи или для чтения и записи одновременно. BufferedRandom предоставляет буферизованный интерфейс для потоков с произвольным доступом. Ещё один подкласс BufferedIOBase, BytesIO, представляет собой поток байтов в памяти.
Абстрактный базовый класс TextIOBase, ещё один подкласс IOBase, занимается потоками, байты которых представляют текст, и обрабатывает кодирование и декодирование в строки и из строк. TextIOWrapper, который расширяет его, представляет собой буферизованный текстовый интерфейс к буферизованному сырому потоку (BufferedIOBase). Наконец, StringIO – это поток текста в памяти.
Имена аргументов не являются частью спецификации, и только аргументы open() предназначены для использования в качестве именованных аргументов.
15.2.3.1. Базовые классы ввода-вывода¶I/O Base Classes
- class io.IOBase¶
Абстрактный базовый класс для всех классов ввода-вывода, работающий с потоками байтов. Отсутствует открытый конструктор.
Этот класс предоставляет пустые абстрактные реализации для многих методов, которые производные классы могут выборочно переопределять; реализации по умолчанию представляют файл, который нельзя читать, записывать или позиционировать.
Хотя IOBase не объявляет read(), readinto(), или write(), поскольку их сигнатуры различаются, реализации и клиенты должны считать эти методы частью интерфейса. Кроме того, реализации могут возбуждать IOError при вызове неподдерживаемых операций.
Базовым типом для двоичных данных, читаемых из файла или записываемых в файл, является bytes. Типы bytearray также принимаются, а в некоторых случаях (например, readinto) требуются. Классы текстового ввода-вывода работают с данными типа str.
Обратите внимание, что вызов любого метода (даже запросов) на закрытом потоке является неопределённым поведением. Реализации могут возбуждать IOError в этом случае.
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()¶
- Возвращает базовый файловый дескриптор (целое число) потока, если он существует. Если объект ввода-вывода не использует файловый дескриптор, возбуждается IOError.
- flush()¶
- Сбрасывает буферы записи потока, если это применимо. Для потоков только для чтения и неблокирующих потоков эта операция ничего не делает.
- isatty()¶
- Возвращает True, если поток интерактивный (т.е. подключен к терминалу/tty-устройству).
- readline(limit=-1)¶
Читает и возвращает одну строку из потока. Если указан limit, будет прочитано не более limit байт.
Для двоичных файлов признаком конца строки всегда является b'\n'; для текстовых файлов через параметр newlines функции open() можно указать, какие признаки конца строки распознавать.
- readlines(hint=-1)¶
- Читает и возвращает список строк из потока. Можно указать hint для ограничения количества читаемых строк: чтение прекратится, когда общий размер (в байтах/символах) всех прочитанных строк превысит hint.
- seek(offset, whence=SEEK_SET)¶
Изменяет позицию в потоке на заданное смещение в байтах offset. offset интерпретируется относительно позиции, задаваемой параметром whence. Допустимые значения whence:
- SEEK_SET или 0 – начало потока (по умолчанию); offset должен быть нулевым или положительным
- SEEK_CUR или 1 – текущая позиция в потоке; offset может быть отрицательным
- SEEK_END или 2 – конец потока; offset обычно отрицательный
Возвращает новую абсолютную позицию.
Новое в версии 3.1: Константы SEEK_*.
- seekable()¶
- Возвращает True, если поток поддерживает произвольный доступ. Если False, seek(), tell() и truncate() возбудят IOError.
- tell()¶
- Возвращает текущую позицию в потоке.
- truncate(size=None)¶
- Изменяет размер потока до указанного size в байтах (или до текущей позиции, если size не указан). Текущая позиция в потоке не изменяется. Это изменение размера может увеличить или уменьшить текущий размер файла. В случае увеличения содержимое новой области файла зависит от платформы (в большинстве систем дополнительные байты заполняются нулями, в Windows они не определены). Возвращается новый размер файла.
- writable()¶
- Возвращает True, если поток поддерживает запись. Если False, write() и truncate() возбудят IOError.
- writelines(lines)¶
- Записывает список строк в поток. Разделители строк не добавляются, поэтому обычно каждая переданная строка уже содержит разделитель в конце.
- class io.RawIOBase¶
Базовый класс для необработанного бинарного ввода-вывода. Наследует IOBase. Открытого конструктора нет.
Необработанный двоичный ввод-вывод обычно предоставляет низкоуровневый доступ к базовому устройству или API операционной системы и не пытается инкапсулировать его в высокоуровневые примитивы (это оставлено буферизованному и текстовому вводу-выводу, описанным далее на этой странице).
В дополнение к атрибутам и методам из IOBase, RawIOBase предоставляет следующие методы:
- read(n=-1)¶
Читает до n байт из объекта и возвращает их. Для удобства, если n не указан или равен -1, вызывается readall(). В противном случае выполняется только один системный вызов. Может быть возвращено меньше n байт, если операционная система возвращает меньше n байт.
Если возвращено 0 байт, а n не был 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(n=-1)¶
Читает и возвращает не более n байтов. Если аргумент опущен, равен None или отрицателен, данные читаются и возвращаются до достижения EOF. Если поток уже находится в конце, возвращается пустой объект bytes.
Если аргумент положителен, а базовый сырой поток не является интерактивным, может быть выполнено несколько сырых чтений, чтобы обеспечить требуемое количество байт (если только не достигнут EOF). Но для интерактивных сырых потоков будет выполнено не более одного сырого чтения, и короткий результат не означает, что EOF неизбежен.
BlockingIOError возникает, если нижележащий небуферизованный поток находится в неблокирующем режиме и в данный момент не имеет доступных данных.
- read1(n=-1)¶
- Читает и возвращает до n байт, выполняя не более одного вызова метода read() нижележащего небуферизованного потока. Это может быть полезно при реализации собственной буферизации поверх объекта BufferedIOBase.
- readinto(b)¶
Читает до len(b) байтов в bytearray b и возвращает количество прочитанных байтов.
Как и read(), к нижележащему необработанному потоку может быть выполнено несколько чтений, если только он не является «интерактивным».
BlockingIOError возникает, если нижележащий небуферизованный поток находится в неблокирующем режиме и в данный момент не имеет доступных данных.
- write(b)¶
Записывает указанный объект bytes или bytearray b и возвращает количество записанных байтов (никогда не меньше len(b), так как при ошибке записи будет возбуждено исключение IOError). В зависимости от конкретной реализации эти байты могут быть немедленно записаны в нижележащий поток или сохранены в буфере для повышения производительности и снижения задержек.
В неблокирующем режиме возникает BlockingIOError, если данные необходимо записать в небуферизованный поток, но он не может принять все данные без блокировки.
15.2.3.2. Сырой файловый ввод-вывод¶Raw File I/O
- class io.FileIO(name, mode='r', closefd=True)¶
FileIO представляет файл на уровне ОС, содержащий байтовые данные. Он реализует интерфейс RawIOBase (а следовательно, и интерфейс IOBase).
Параметр name может быть одним из двух:
- строка символов или объект bytes, представляющий путь к открываемому файлу;
- целое число, представляющее номер существующего файлового дескриптора на уровне ОС, к которому будет предоставлять доступ результирующий объект ⟦/2FileIO.
Параметр mode может быть равен 'r', 'w' или 'a' для чтения (по умолчанию), записи или дозаписи. Файл будет создан, если он не существует, при открытии на запись или дозапись; при открытии на запись файл будет усечён. Добавление '+' к режиму позволяет одновременно читать и писать.
Методы read() (при вызове с положительным аргументом), readinto() и write() этого класса будут выполнять только один системный вызов.
В дополнение к атрибутам и методам от IOBase и RawIOBase, FileIO предоставляет следующие атрибуты и методы:
- mode¶
- Режим, указанный в конструкторе.
- name¶
- Имя файла. Это дескриптор файла, если имя не указано в конструкторе.
15.2.3.3. Буферизированные потоки данных¶Buffered Streams
Буферизированные потоки ввода-вывода предоставляют интерфейс более высокого уровня к устройству ввода-вывода, чем небуферизированный.
- class io.BytesIO([initial_bytes])¶
Реализация потока, использующая буфер байт в памяти. Наследует BufferedIOBase.
Аргумент initial_bytes содержит необязательные начальные данные bytes.
BytesIO предоставляет или переопределяет следующие методы в дополнение к методам из BufferedIOBase и IOBase:
- getvalue()¶
- Возвращает объект bytes, содержащий всё содержимое буфера.
- class io.BufferedReader(raw, buffer_size=DEFAULT_BUFFER_SIZE)¶
Буфер, обеспечивающий доступ более высокого уровня к читаемому последовательному объекту RawIOBase. Наследует BufferedIOBase. При чтении данных из этого объекта из нижележащего необработанного потока может запрашиваться больший объём данных, которые сохраняются во внутреннем буфере. Затем буферизованные данные могут быть прямо возвращены при последующих чтениях.
Конструктор создаёт BufferedReader для переданного читаемого потока raw и buffer_size. Если buffer_size опущен, используется DEFAULT_BUFFER_SIZE.
BufferedReader предоставляет или переопределяет следующие методы в дополнение к методам из BufferedIOBase и IOBase:
- peek([n])¶
- Возвращает байты из потока без продвижения позиции. Для выполнения вызова производится не более одного чтения из сырого потока. Количество возвращённых байт может быть меньше или больше запрошенного.
- read([n])¶
- Читает и возвращает n байт, или, если n не указан или отрицателен, до EOF или если вызов чтения заблокируется в неблокирующем режиме.
- read1(n)¶
- Читает и возвращает до n байт, выполняя только один вызов небуферизованного потока. Если в буфере есть хотя бы один байт, возвращаются только буферизованные байты. В противном случае выполняется один вызов чтения небуферизованного потока.
- class io.BufferedWriter(raw, buffer_size=DEFAULT_BUFFER_SIZE)¶
Буфер, предоставляющий высокоуровневый доступ к записываемому последовательному объекту RawIOBase. Он наследует BufferedIOBase. При записи в этот объект данные обычно хранятся во внутреннем буфере. Буфер будет сброшен в нижележащий объект RawIOBase при различных условиях, в том числе:
- когда буфер становится слишком мал для всех ожидающих данных;
- при вызове flush();
- при запросе seek() (для объектов BufferedRandom);
- когда объект BufferedWriter закрывается или уничтожается.
Конструктор создаёт BufferedWriter для переданного записываемого потока raw. Если buffer_size не указан, по умолчанию используется DEFAULT_BUFFER_SIZE.
Третий аргумент, max_buffer_size, поддерживается, но не используется и устарел.
BufferedWriter предоставляет или переопределяет следующие методы в дополнение к методам из BufferedIOBase и IOBase:
- flush()¶
- Принудительно сбрасывает байты, находящиеся в буфере, в необработанный поток. Если необработанный поток блокируется, должно быть возбуждено исключение BlockingIOError.
- write(b)¶
- Записывает объект bytes или bytearray b и возвращает количество записанных байтов. В неблокирующем режиме, если требуется сбросить буфер, но необработанный поток блокируется, возбуждается исключение BlockingIOError.
- class io.BufferedRWPair(reader, writer, buffer_size=DEFAULT_BUFFER_SIZE)¶
Буферизованный объект ввода-вывода, обеспечивающий комбинированный доступ более высокого уровня к двум последовательным объектам RawIOBase: один для чтения, другой для записи. Он полезен для пар однонаправленных каналов связи (например, каналов). Он наследует BufferedIOBase.
reader и writer – это объекты RawIOBase, предназначенные соответственно для чтения и записи. Если buffer_size опущен, по умолчанию используется DEFAULT_BUFFER_SIZE.
Четвёртый аргумент, max_buffer_size, поддерживается, но не используется и устарел.
BufferedRWPair реализует все методы BufferedIOBase, за исключением detach(), который возбуждает UnsupportedOperation.
- class io.BufferedRandom(raw, buffer_size=DEFAULT_BUFFER_SIZE)¶
Буферизованный интерфейс для потоков с произвольным доступом. Он наследует BufferedReader и BufferedWriter, а также поддерживает функциональность seek() и tell().
Конструктор создаёт читатель и писатель для позиционируемого необработанного потока, заданного в первом аргументе. Если buffer_size опущен, по умолчанию используется DEFAULT_BUFFER_SIZE.
Третий аргумент, max_buffer_size, поддерживается, но не используется и устарел.
BufferedRandom способен на всё, что могут BufferedReader или BufferedWriter.
15.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(n)¶
- Читает и возвращает не более n символов из потока в виде одной str. Если n отрицательно или None, читает до конца файла (EOF).
- readline()¶
- Читает до символа новой строки или конца файла и возвращает одну строку str. Если поток уже достиг конца файла, возвращается пустая строка.
- write(s)¶
- Записывает строку s в поток и возвращает количество записанных символов.
- class io.TextIOWrapper(buffer, encoding=None, errors=None, newline=None, line_buffering=False)¶
Буферизированный текстовый поток поверх бинарного потока BufferedIOBase. Наследует TextIOBase.
encoding задаёт имя кодировки, в которую будет декодироваться или кодироваться поток. По умолчанию используется locale.getpreferredencoding().
errors – необязательная строка, определяющая, как обрабатывать ошибки кодирования и декодирования. Передача 'strict' вызывает исключение ValueError при ошибке кодирования (значение по умолчанию None имеет тот же эффект), а 'ignore' игнорирует ошибки. (Обратите внимание, что игнорирование ошибок кодирования может привести к потере данных.) 'replace' вставляет замещающий символ (например, '?') в места неверных данных. При записи можно использовать 'xmlcharrefreplace' (замена соответствующей XML-ссылкой на символ) или 'backslashreplace' (замена escape-последовательностями с обратной косой чертой). Допустимо любое другое имя обработки ошибок, зарегистрированное в codecs.register_error().
newline может быть None, '', '\n', '\r' или '\r\n'. Он управляет обработкой концов строк. Если он равен None, включён универсальный режим концов строк. При включённом режиме на вводе концы строк '\n', '\r' или '\r\n' преобразуются в '\n' перед возвратом вызывающему. И наоборот, на выводе '\n' преобразуется в системный разделитель строк по умолчанию os.linesep. Если newline является любым другим допустимым значением, этот символ становится концом строки при чтении файла и возвращается без преобразования. На выводе '\n' преобразуется в newline.
Если line_buffering равно True, flush() подразумевается при вызове write, содержащем символ новой строки.
TextIOWrapper предоставляет один атрибут в дополнение к атрибутам TextIOBase и его родительских классов:
- line_buffering¶
- Определяет, включена ли построчная буферизация.
- class io.StringIO(initial_value='', newline=None)¶
Поток в памяти для текстового ввода-вывода.
Начальное значение буфера (по умолчанию пустая строка) можно задать с помощью initial_value. Аргумент newline работает так же, как в TextIOWrapper. По умолчанию перевод строки не выполняется.
StringIO предоставляет этот метод в дополнение к методам из TextIOBase и его родительских классов:
- getvalue()¶
- Возвращает str, содержащую полное содержимое буфера в любой момент до вызова метода close() объекта StringIO.
Пример использования:
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.
15.2.4. Дополнительные темы¶Advanced topics
Здесь будут рассмотрены несколько дополнительных тем, относящихся к конкретным реализациям ввода-вывода, описанным выше.
15.2.4.1. Производительность¶Performance
15.2.4.1.1. Двоичный ввод-вывод¶Binary I/O
Читая и записывая только большие блоки данных, даже когда пользователь запрашивает один байт, буферизованный ввод-вывод скрывает любую неэффективность вызова и выполнения небуферизованных процедур ввода-вывода операционной системы. Выигрыш сильно зависит от ОС и типа выполняемого ввода-вывода (например, в некоторых современных ОС, таких как Linux, небуферизованный дисковый ввод-вывод может быть таким же быстрым, как буферизованный). Однако суть в том, что буферизованный ввод-вывод обеспечивает предсказуемую производительность независимо от платформы и нижележащего устройства. Поэтому почти всегда предпочтительнее использовать буферизованный ввод-вывод, а не небуферизованный.
15.2.4.1.2. Текстовый ввод-вывод¶Text I/O
Текстовый ввод-вывод поверх бинарного хранилища (например, файла) работает значительно медленнее, чем бинарный ввод-вывод через то же хранилище, поскольку требует преобразования из Unicode в бинарные данные с помощью кодека символов. Это может стать заметно при обработке больших объёмов текстовых данных (например, очень больших файлов журналов). Кроме того, TextIOWrapper.tell() и TextIOWrapper.seek() работают довольно медленно из-за используемого алгоритма восстановления.
StringIO, однако, является собственным контейнером юникода в памяти и будет демонстрировать скорость, аналогичную BytesIO.
15.2.4.2. Многопоточность¶Multi-threading
Объекты FileIO потокобезопасны настолько, насколько потокобезопасны системные вызовы (например, read(2) в Unix), которые они оборачивают.
Буферизированные бинарные объекты (экземпляры BufferedReader, BufferedWriter, BufferedRandom и BufferedRWPair) защищают свои внутренние структуры с помощью блокировки; поэтому их можно безопасно вызывать из нескольких потоков одновременно.
Объекты TextIOWrapper не являются потокобезопасными.
15.2.4.3. Реентерабельность¶Reentrancy
Буферизованные бинарные объекты (экземпляры BufferedReader, BufferedWriter, BufferedRandom и BufferedRWPair) не являются реентерабельными. Хотя повторные вызовы в обычных ситуациях не возникают, они могут появиться, если выполнять ввод-вывод в обработчике signal. Если попытаться повторно войти в буферизованный объект, когда к нему уже идёт обращение из того же потока, то возбуждается RuntimeError.
Сказанное выше неявно распространяется и на текстовые файлы, поскольку функция open() помещает буферизованный объект внутрь TextIOWrapper. Это касается и стандартных потоков, а значит, затрагивает и встроенную функцию print().