Документация Python неофициальный перевод

fileinput.md

141 строк · 16.2 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.15/library/fileinput.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `fileinput` – итерация по строкам из нескольких входных потоков89**Исходный код:** [Lib/fileinput.py](https://python-all.ru/src/3.15/Lib/fileinput.py)1011---1213Этот модуль реализует вспомогательный класс и функции для быстрого создания цикла по стандартному вводу или списку файлов. Если нужно только прочитать или записать один файл, см. [`open()`](https://python-all.ru/3.15/library/functions.html#open).1415Типичное использование:1617```python18import fileinput19for line in fileinput.input(encoding="utf-8"):20    process(line)21```2223Функция перебирает строки всех файлов, указанных в `sys.argv[1:]`; если список пуст, по умолчанию используется `sys.stdin`. Если имя файла равно `'-'`, оно также заменяется на `sys.stdin`, а необязательные аргументы *mode* и *openhook* игнорируются. Чтобы задать альтернативный список имён файлов, передайте его первым аргументом в [`input()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.input). Допускается также одно имя файла.2425Все файлы по умолчанию открываются в текстовом режиме, но это можно изменить, указав параметр *mode* в вызове [`input()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.input) или [`FileInput`](https://python-all.ru/3.15/library/fileinput.html#fileinput.FileInput). Если при открытии или чтении файла происходит ошибка ввода-вывода, возбуждается [`OSError`](https://python-all.ru/3.15/library/exceptions.html#OSError).2627Изменено в версии 3.3: [`IOError`](https://python-all.ru/3.15/library/exceptions.html#IOError) раньше возбуждалось; теперь оно является псевдонимом [`OSError`](https://python-all.ru/3.15/library/exceptions.html#OSError).2829Если `sys.stdin` используется более одного раза, второй и последующие вызовы не вернут ни одной строки, за исключением, возможно, интерактивного использования или если он был явно сброшен (например, с помощью `sys.stdin.seek(0)`).3031Пустые файлы открываются и сразу закрываются; их присутствие в списке имён файлов становится заметным, только когда последний открытый файл пуст.3233Строки возвращаются с сохранением всех символов новой строки; это означает, что последняя строка в файле может не иметь такого символа.3435Можно управлять открытием файлов, передав хук открытия через параметр *openhook* в [`fileinput.input()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.input) или [`FileInput()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.FileInput). Хук должен быть функцией, принимающей два аргумента: *filename* и *mode*, и возвращающей соответствующий образом открытый файлоподобный объект. Если указаны *encoding* и/или *errors*, они будут переданы хуку как дополнительные именованные аргументы. Этот модуль предоставляет [`hook_compressed()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.hook_compressed) для поддержки сжатых файлов.3637Следующая функция является основным интерфейсом этого модуля:3839#### `fileinput.input(files=None, inplace=False, backup='', *, mode='r', openhook=None, encoding=None, errors=None)`4041Создаёт экземпляр класса [`FileInput`](https://python-all.ru/3.15/library/fileinput.html#fileinput.FileInput). Этот экземпляр будет использоваться как глобальное состояние для функций этого модуля, а также возвращается для использования во время итерации. Параметры этой функции будут переданы конструктору класса `FileInput`.4243Экземпляр [`FileInput`](https://python-all.ru/3.15/library/fileinput.html#fileinput.FileInput) можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3.15/reference/compound_stmts.html#with). В этом примере *input* закрывается после выхода из оператора `with`, даже если возникло исключение:4445```python46with fileinput.input(files=('spam.txt', 'eggs.txt'), encoding="utf-8") as f:47    for line in f:48        process(line)49```5051Изменено в версии 3.2: Может использоваться как контекстный менеджер.5253Изменено в версии 3.8: Именованные параметры *mode* и *openhook* теперь являются только ключевыми (keyword-only).5455Изменено в версии 3.10: Добавлены именованные параметры *encoding* и *errors*.5657Следующие функции используют глобальное состояние, созданное [`fileinput.input()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.input); если активное состояние отсутствует, возбуждается [`RuntimeError`](https://python-all.ru/3.15/library/exceptions.html#RuntimeError).5859#### `fileinput.filename()`6061Возвращает имя файла, который в данный момент читается. До чтения первой строки возвращает `None`.6263#### `fileinput.fileno()`6465Возвращает целочисленный «файловый дескриптор» текущего файла. Когда файл не открыт (до первой строки и между файлами), возвращает `-1`.6667#### `fileinput.lineno()`6869Возвращает накопленный номер строки для только что прочитанной строки. До чтения первой строки возвращает `0`. После чтения последней строки последнего файла возвращает номер этой строки.7071#### `fileinput.filelineno()`7273Возвращает номер строки в текущем файле. До чтения первой строки возвращает `0`. После чтения последней строки последнего файла возвращает номер этой строки внутри файла.7475#### `fileinput.isfirstline()`7677Возвращает `True`, если только что прочитанная строка является первой строкой своего файла, иначе возвращает `False`.7879#### `fileinput.isstdin()`8081Возвращает `True`, если последняя строка была прочитана из `sys.stdin`, иначе возвращает `False`.8283#### `fileinput.nextfile()`8485Закрывает текущий файл, чтобы следующая итерация начала чтение с первой строки следующего файла (если такой есть); строки, не прочитанные из файла, не учитываются в общем количестве строк. Имя файла не изменяется до тех пор, пока не будет прочитана первая строка следующего файла. До чтения первой строки эта функция не действует; её нельзя использовать для пропуска первого файла. После чтения последней строки последнего файла эта функция также не действует.8687#### `fileinput.close()`8889Закрывает последовательность.9091Класс, реализующий поведение последовательности, предоставляемое модулем, также доступен для создания подклассов:9293#### `class fileinput.FileInput(files=None, inplace=False, backup='', *, mode='r', openhook=None, encoding=None, errors=None)`9495Класс `FileInput` является реализацией; его методы [`filename()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.filename), [`fileno()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.fileno), [`lineno()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.lineno), [`filelineno()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.filelineno), [`isfirstline()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.isfirstline), [`isstdin()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.isstdin), [`nextfile()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.nextfile) и [`close()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.close) соответствуют функциям с теми же именами в модуле. Кроме того, он является [итерируемым](https://python-all.ru/3.15/glossary.html#term-iterable) и имеет метод [`readline()`](https://python-all.ru/3.15/library/io.html#io.TextIOBase.readline), который возвращает следующую входную строку. К последовательности следует обращаться строго последовательно; произвольный доступ и `readline()` несовместимы.9697С помощью *mode* можно указать, какой режим файла будет передан в [`open()`](https://python-all.ru/3.15/library/functions.html#open). Он должен быть одним из `'r'` и `'rb'`.9899Параметр *openhook*, если задан, должен быть функцией, принимающей два аргумента: *filename* и *mode*, и возвращающей соответствующим образом открытый файлоподобный объект. *inplace* и *openhook* нельзя использовать вместе.100101Можно указать *encoding* и *errors*, которые передаются в [`open()`](https://python-all.ru/3.15/library/functions.html#open) или *openhook*.102103Экземпляр `FileInput` можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3.15/reference/compound_stmts.html#with). В этом примере *input* закрывается после выхода из оператора `with`, даже если возникло исключение:104105```python106with FileInput(files=('spam.txt', 'eggs.txt')) as input:107    process(input)108```109110Изменено в версии 3.2: Может использоваться как контекстный менеджер.111112Изменено в версии 3.8: Именованные параметры *mode* и *openhook* теперь передаются только как именованные (keyword-only).113114Изменено в версии 3.10: Добавлены именованные параметры *encoding* и *errors*.115116Изменено в версии 3.11: Режимы `'rU'` и `'U'`, а также метод `__getitem__()` были удалены.117118**Необязательная фильтрация на месте:** если именованный аргумент `inplace=True` передан в [`fileinput.input()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.input) или в конструктор [`FileInput`](https://python-all.ru/3.15/library/fileinput.html#fileinput.FileInput), файл перемещается в резервную копию, а стандартный вывод направляется во входной файл (если файл с тем же именем, что и резервная копия, уже существует, он будет молча заменён). Это позволяет написать фильтр, который перезаписывает свой входной файл на месте. Если задан параметр *backup* (обычно как `backup='.<some extension>'`), он указывает расширение для резервного файла, и резервный файл остаётся; по умолчанию расширение равно `'.bak'` и оно удаляется при закрытии выходного файла. Фильтрация на месте отключается, когда читается стандартный ввод.119120Следующие два хука открытия предоставляются этим модулем:121122#### `fileinput.hook_compressed(filename, mode, *, encoding=None, errors=None)`123124Прозрачно открывает файлы, сжатые gzip и bzip2 (распознаваемые по расширениям `'.gz'` и `'.bz2'`), с использованием модулей [`gzip`](https://python-all.ru/3.15/library/gzip.html#module-gzip) и [`bz2`](https://python-all.ru/3.15/library/bz2.html#module-bz2). Если расширение имени файла не `'.gz'` и не `'.bz2'`, файл открывается обычным образом (то есть с помощью [`open()`](https://python-all.ru/3.15/library/functions.html#open) без какого-либо распаковывания).125126Значения *encoding* и *errors* передаются в [`io.TextIOWrapper`](https://python-all.ru/3.15/library/io.html#io.TextIOWrapper) для сжатых файлов и в open для обычных файлов.127128Пример использования: `fi = fileinput.FileInput(openhook=fileinput.hook_compressed, encoding="utf-8")`129130Изменено в версии 3.10: Добавлены именованные параметры *encoding* и *errors*.131132#### `fileinput.hook_encoded(encoding, errors=None)`133134Возвращает хук, который открывает каждый файл с помощью [`open()`](https://python-all.ru/3.15/library/functions.html#open), используя заданные *encoding* и *errors* для чтения файла.135136Пример использования: `fi = fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8", "surrogateescape"))`137138Изменено в версии 3.6: Добавлен необязательный параметр *errors*.139140Устарело с версии 3.10: Эта функция устарела, поскольку [`fileinput.input()`](https://python-all.ru/3.15/library/fileinput.html#fileinput.input) и [`FileInput`](https://python-all.ru/3.15/library/fileinput.html#fileinput.FileInput) теперь имеют параметры *encoding* и *errors*.141