`tarfile.md`

924 строк · 85.6 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.11/library/tarfile.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) – Чтение и запись файлов tar-архивов89**Исходный код:** [Lib/tarfile.py](https://python-all.ru/src/3.11/Lib/tarfile.py)1011---1213Модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) позволяет читать и записывать tar-архивы, в том числе сжатые gzip, bz2 и lzma. Используйте модуль [`zipfile`](https://python-all.ru/3.11/library/zipfile.html#module-zipfile) для чтения и записи файлов `.zip` или функции более высокого уровня из [shutil](https://python-all.ru/3.11/library/shutil.html#archiving-operations).1415Некоторые факты и цифры:1617- читает и записывает сжатые архивы [`gzip`](https://python-all.ru/3.11/library/gzip.html#module-gzip), [`bz2`](https://python-all.ru/3.11/library/bz2.html#module-bz2) и [`lzma`](https://python-all.ru/3.11/library/lzma.html#module-lzma) если соответствующие модули доступны.18- поддержка чтения/записи формата POSIX.1-1988 (ustar).19- поддержка чтения/записи формата GNU tar, включая расширения *longname* и *longlink*, поддержка только чтения всех вариантов расширения *sparse*, включая восстановление разрежённых файлов.20- поддержка чтения/записи формата POSIX.1-2001 (pax).21- работает с директориями, обычными файлами, жёсткими ссылками, символическими ссылками, каналами FIFO, символьными и блочными устройствами, а также может получать и восстанавливать информацию о файлах, такую как временная метка, права доступа и владелец.2223Изменено в версии 3.3: Добавлена поддержка сжатия [`lzma`](https://python-all.ru/3.11/library/lzma.html#module-lzma).2425#### `tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)`2627Возвращает объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) для имени пути *name*. Подробную информацию об объектах [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) и допустимых именованных аргументах см. в разделе [Объекты TarFile](https://python-all.ru/3.11/library/tarfile.html#tarfile-objects).2829*mode* должен быть строкой вида `'filemode[:compression]'`, по умолчанию равен `'r'`. Вот полный список комбинаций режимов:3031| Режим | Действие |32| --- | --- |33| `'r' or 'r:*'` | Открыть для чтения с прозрачным сжатием (рекомендуется). |34| `'r:'` | Открыть для чтения исключительно без сжатия. |35| `'r:gz'` | Открыть для чтения со сжатием gzip. |36| `'r:bz2'` | Открыть для чтения со сжатием bzip2. |37| `'r:xz'` | Открыть для чтения со сжатием lzma. |38| `'x'` или `'x:'` | Создать tar-файл исключительно без сжатия. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.11/library/exceptions.html#FileExistsError), если файл уже существует. |39| `'x:gz'` | Создать tar-файл со сжатием gzip. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.11/library/exceptions.html#FileExistsError), если файл уже существует. |40| `'x:bz2'` | Создать tar-файл со сжатием bzip2. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.11/library/exceptions.html#FileExistsError), если файл уже существует. |41| `'x:xz'` | Создать tar-файл со сжатием lzma. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.11/library/exceptions.html#FileExistsError), если файл уже существует. |42| `'a' or 'a:'` | Открыть для добавления без сжатия. Файл создаётся, если он не существует. |43| `'w' or 'w:'` | Открывается для записи без сжатия. |44| `'w:gz'` | Открывается для записи со сжатием gzip. |45| `'w:bz2'` | Открывается для записи со сжатием bzip2. |46| `'w:xz'` | Открывается для записи со сжатием lzma. |4748Обратите внимание, что `'a:gz'`, `'a:bz2'` или `'a:xz'` невозможны. Если *режим* не подходит для открытия определённого (сжатого) файла для чтения, возбуждается [`ReadError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.ReadError). Используйте *режим* `'r'`, чтобы избежать этого. Если метод сжатия не поддерживается, возбуждается [`CompressionError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.CompressionError).4950Если указан *fileobj*, он используется вместо [файлового объекта](https://python-all.ru/3.11/glossary.html#term-file-object), открытого в бинарном режиме для *имени*. Предполагается, что он находится на позиции 0.5152Для режимов `'w:gz'`, `'r:gz'`, `'w:bz2'`, `'r:bz2'`, `'x:gz'`, `'x:bz2'`, [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open) принимает именованный аргумент *compresslevel* (по умолчанию `9`) для указания уровня сжатия файла.5354Для режимов `'w:xz'` и `'x:xz'` [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open) принимает именованный аргумент *preset* для указания уровня сжатия файла.5556Для специальных целей существует второй формат для *mode*: `'filemode|[compression]'`. [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open) вернёт объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile), который обрабатывает данные как поток блоков. Произвольный доступ к файлу не осуществляется. Если передан *fileobj*, им может быть любой объект, имеющий метод [`read()`](https://python-all.ru/3.11/library/io.html#io.RawIOBase.read) или [`write()`](https://python-all.ru/3.11/library/io.html#io.RawIOBase.write) (в зависимости от *режима*), работающий с байтами. *bufsize* задаёт размер блока, по умолчанию `20 * 512` байт. Используйте этот вариант в сочетании, например, с `sys.stdin.buffer`, сокетным [файловым объектом](https://python-all.ru/3.11/glossary.html#term-file-object) или ленточным устройством. Однако такой объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) ограничен тем, что не допускает произвольного доступа; см. [Примеры](https://python-all.ru/3.11/library/tarfile.html#tar-examples). Текущие возможные режимы:5758| Режим | Действие |59| --- | --- |60| `'r\|*'` | Открывает *поток данных* tar-блоков для чтения с прозрачным сжатием. |61| `'r\|'` | Открывает *поток данных* несжатых tar-блоков для чтения. |62| `'r\|gz'` | Открывает сжатый gzip *поток данных* для чтения. |63| `'r\|bz2'` | Открывает сжатый bzip2 *поток данных* для чтения. |64| `'r\|xz'` | Открывает сжатый lzma *поток данных* для чтения. |65| `'w\|'` | Открывает несжатый *поток данных* для записи. |66| `'w\|gz'` | Открывает сжатый gzip *поток данных* для записи. |67| `'w\|bz2'` | Открывает сжатый bzip2 *поток данных* для записи. |68| `'w\|xz'` | Открывает сжатый lzma *поток данных* для записи. |6970Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание).7172Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object).7374#### `class tarfile.TarFile`7576Класс для чтения и записи tar-архивов. Не используйте этот класс напрямую: вместо него используйте [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open). См. [Объекты TarFile](https://python-all.ru/3.11/library/tarfile.html#tarfile-objects).7778#### `tarfile.is_tarfile(name)`7980Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если *name* является tar-архивом, который может прочитать модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile). *name* может быть [`str`](https://python-all.ru/3.11/library/stdtypes.html#str), файлом или файлоподобным объектом.8182Изменено в версии 3.9: Добавлена поддержка файлов и файлоподобных объектов.8384Модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) определяет следующие исключения:8586#### `exception tarfile.TarError`8788Базовый класс для всех исключений [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile).8990#### `exception tarfile.ReadError`9192Возникает при открытии tar-архива, который не может быть обработан модулем [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) или является некорректным.9394#### `exception tarfile.CompressionError`9596Возникает, когда метод сжатия не поддерживается или данные не удаётся корректно декодировать.9798#### `exception tarfile.StreamError`99100Возникает при ограничениях, типичных для объектов, работающих в режиме потока [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile).101102#### `exception tarfile.ExtractError`103104Возникает при *нефатальных* ошибках при использовании [`TarFile.extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract), но только если [`TarFile.errorlevel`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.errorlevel)`== 2`.105106#### `exception tarfile.HeaderError`107108Возникает при вызове [`TarInfo.frombuf()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.frombuf), если полученный буфер некорректен.109110#### `exception tarfile.FilterError`111112Базовый класс для элементов, [отклонённых](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) фильтрами.113114#### `tarinfo`115116Информация об элементе, который фильтр отказался извлекать, в виде [TarInfo](https://python-all.ru/3.11/library/tarfile.html#tarinfo-objects).117118#### `exception tarfile.AbsolutePathError`119120Возникает при отказе извлекать элемент с абсолютным путём.121122#### `exception tarfile.OutsideDestinationError`123124Возникает при отказе извлекать элемент за пределами целевого каталога.125126#### `exception tarfile.SpecialFileError`127128Возникает при отказе извлекать специальный файл (например, устройство или канал).129130#### `exception tarfile.AbsoluteLinkError`131132Возникает при отказе извлекать символическую ссылку с абсолютным путём.133134#### `exception tarfile.LinkOutsideDestinationError`135136Возникает при отказе извлекать символическую ссылку, указывающую за пределы целевого каталога.137138#### `exception tarfile.LinkFallbackError`139140Возникает при отказе эмулировать ссылку (жёсткую или символическую) путём извлечения другого элемента архива, если этот элемент был бы отклонён расположением фильтра. Исключение, вызванное для отклонения заменяющего элемента, доступно как `BaseException.__context__`.141142Новое в версии 3.11.13.143144На уровне модуля доступны следующие константы:145146#### `tarfile.ENCODING`147148Кодировка символов по умолчанию: `'utf-8'` в Windows, значение, возвращаемое [`sys.getfilesystemencoding()`](https://python-all.ru/3.11/library/sys.html#sys.getfilesystemencoding) в остальных случаях.149150#### `tarfile.REGTYPE`151152#### `tarfile.AREGTYPE`153154Обычный файл [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).155156#### `tarfile.LNKTYPE`157158Ссылка (внутри tar-файла) [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).159160#### `tarfile.SYMTYPE`161162Символическая ссылка [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).163164#### `tarfile.CHRTYPE`165166Символьное устройство [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).167168#### `tarfile.BLKTYPE`169170Блочное устройство [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).171172#### `tarfile.DIRTYPE`173174Каталог [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).175176#### `tarfile.FIFOTYPE`177178FIFO-устройство [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).179180#### `tarfile.CONTTYPE`181182Непрерывный файл [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).183184#### `tarfile.GNUTYPE_LONGNAME`185186Длинное имя GNU tar [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).187188#### `tarfile.GNUTYPE_LONGLINK`189190Длинная ссылка GNU tar [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).191192#### `tarfile.GNUTYPE_SPARSE`193194Разрежённый файл GNU tar [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type).195196Каждая из следующих констант определяет формат tar-архива, который модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) может создавать. Подробнее см. раздел [Поддерживаемые форматы tar](https://python-all.ru/3.11/library/tarfile.html#tar-formats) для получения подробностей.197198#### `tarfile.USTAR_FORMAT`199200Формат POSIX.1-1988 (ustar).201202#### `tarfile.GNU_FORMAT`203204Формат GNU tar.205206#### `tarfile.PAX_FORMAT`207208Формат POSIX.1-2001 (pax).209210#### `tarfile.DEFAULT_FORMAT`211212Формат по умолчанию для создания архивов. В настоящее время это [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT).213214Изменено в версии 3.8: Формат по умолчанию для новых архивов был изменён на [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT) с [`GNU_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.GNU_FORMAT).215216> **См. также**217>218> **Модуль [`zipfile`](https://python-all.ru/3.11/library/zipfile.html#module-zipfile)**219>220> Документация стандартного модуля [`zipfile`](https://python-all.ru/3.11/library/zipfile.html#module-zipfile).221>222> **[Операции архивирования](https://python-all.ru/3.11/library/shutil.html#archiving-operations)**223>224> Документация средств архивирования высокого уровня, предоставляемых стандартным модулем [`shutil`](https://python-all.ru/3.11/library/shutil.html#module-shutil).225>226> **[Руководство GNU tar, базовый формат tar](https://python-all.ru/3.11/library/tarfile.html)**227>228> Документация для файлов архивов tar, включая расширения GNU tar.229230## Объекты TarFile231232Объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) предоставляет интерфейс к архиву tar. Архив tar представляет собой последовательность блоков. Элемент архива (хранимый файл) состоит из заголовочного блока, за которым следуют блоки данных. Файл можно сохранить в архив tar несколько раз. Каждый элемент архива представляется объектом [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo), подробнее см. [Объекты TarInfo](https://python-all.ru/3.11/library/tarfile.html#tarinfo-objects).233234Объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3.11/reference/compound_stmts.html#with). Он будет автоматически закрыт по завершении блока. Обратите внимание: в случае исключения архив, открытый для записи, не будет финализирован; будет закрыт только внутренний файловый объект. Пример использования см. в разделе [Примеры](https://python-all.ru/3.11/library/tarfile.html#tar-examples).235236Новое в версии 3.2: Добавлена поддержка протокола менеджера контекста.237238#### `class tarfile.TarFile(name=None, mode='r', fileobj=None, format=DEFAULT_FORMAT, tarinfo=TarInfo, dereference=False, ignore_zeros=False, encoding=ENCODING, errors='surrogateescape', pax_headers=None, debug=0, errorlevel=1)`239240Все последующие аргументы необязательны и также могут быть доступны как атрибуты экземпляра.241242*name* – это путь к архиву. *name* может быть [объектом, подобным пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). Его можно опустить, если указан *fileobj*. В этом случае используется атрибут файлового объекта `name`, если он существует.243244*mode* может быть `'r'` для чтения из существующего архива, `'a'` для добавления данных в существующий файл, `'w'` для создания нового файла с перезаписью существующего или `'x'` для создания нового файла только в том случае, если он ещё не существует.245246Если указан *fileobj*, он используется для чтения или записи данных. Если это можно определить, *mode* переопределяется режимом *fileobj*. *fileobj* будет использоваться с позиции 0.247248> **Примечание**249>250> *fileobj* не закрывается при закрытии [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile).251252*format* управляет форматом архива для записи. Он должен быть одной из констант [`USTAR_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.USTAR_FORMAT), [`GNU_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.GNU_FORMAT) или [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT), определённых на уровне модуля. При чтении формат будет определён автоматически, даже если в одном архиве присутствуют разные форматы.253254Аргумент *tarinfo* можно использовать для замены класса по умолчанию [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) на другой.255256Если *dereference* равно [`False`](https://python-all.ru/3.11/library/constants.html#False), в архив добавляются символические и жёсткие ссылки. Если [`True`](https://python-all.ru/3.11/library/constants.html#True), в архив добавляется содержимое целевых файлов. Это не влияет на системы, не поддерживающие символические ссылки.257258Если *ignore\_zeros* равно [`False`](https://python-all.ru/3.11/library/constants.html#False), пустой блок считается концом архива. Если [`True`](https://python-all.ru/3.11/library/constants.html#True), пустые (и недействительные) блоки пропускаются, и предпринимается попытка получить как можно больше элементов. Это полезно только для чтения объединённых или повреждённых архивов.259260*debug* может быть установлен от `0` (нет отладочных сообщений) до `3` (все отладочные сообщения). Сообщения записываются в `sys.stderr`.261262*errorlevel* управляет обработкой ошибок извлечения, см. [`the corresponding attribute`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.errorlevel).263264Аргументы *encoding* и *errors* определяют кодировку символов, используемую для чтения или записи архива, и способ обработки ошибок преобразования. Настройки по умолчанию подходят для большинства пользователей. Подробную информацию см. в разделе [Проблемы Unicode](https://python-all.ru/3.11/library/tarfile.html#tar-unicode).265266Аргумент *pax\_headers* – необязательный словарь строк, который будет добавлен как глобальный заголовок pax, если *format* равно [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT).267268Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`.269270Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание).271272Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object).273274#### `classmethod TarFile.open(...)`275276Альтернативный конструктор. Функция [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open) на самом деле является сокращением для этого метода класса.277278#### `TarFile.getmember(name)`279280Возвращает объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) для элемента *name*. Если *name* не найден в архиве, возбуждается [`KeyError`](https://python-all.ru/3.11/library/exceptions.html#KeyError).281282> **Примечание**283>284> Если элемент встречается в архиве более одного раза, последнее его вхождение считается самой актуальной версией.285286#### `TarFile.getmembers()`287288Возвращает элементы архива в виде списка объектов [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Порядок списка соответствует порядку элементов в архиве.289290#### `TarFile.getnames()`291292Возвращает элементы в виде списка их имён. Порядок списка соответствует порядку списка, возвращаемого [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers).293294#### `TarFile.list(verbose=True, *, members=None)`295296Выводит оглавление в `sys.stdout`. Если *verbose* равно [`False`](https://python-all.ru/3.11/library/constants.html#False), печатаются только имена элементов. Если же [`True`](https://python-all.ru/3.11/library/constants.html#True), выводятся данные, аналогичные **ls -l**. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers).297298Изменено в версии 3.5: Добавлен параметр *members*.299300#### `TarFile.next()`301302Возвращает следующий элемент архива в виде объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo), когда [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) открыт для чтения. Если больше нет элементов, возвращает [`None`](https://python-all.ru/3.11/library/constants.html#None).303304#### `TarFile.extractall(path='.', members=None, *, numeric_owner=False, filter=None)`305306Извлекает все элементы из архива в текущую рабочую директорию или в директорию *path*. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers). Сведения о директории (владелец, время изменения, права доступа) устанавливаются после извлечения всех элементов. Это сделано для обхода двух проблем: время изменения директории сбрасывается при каждом создании в ней файла, и если права директории не разрешают запись, извлечение в неё файлов завершится ошибкой.307308Если *numeric\_owner* равно [`True`](https://python-all.ru/3.11/library/constants.html#True), для установки владельца и группы извлечённых файлов используются числовые uid и gid из tar-файла. В противном случае используются именованные значения из tar-файла.309310Аргумент *filter*, добавленный в Python 3.11.4, определяет, как `members` изменяются или отклоняются перед извлечением. Подробнее см. [Фильтры извлечения](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter). Рекомендуется явно задавать этот аргумент в зависимости от того, какие возможности *tar* необходимо поддерживать.311312> **Предупреждение**313>314> Никогда не извлекайте архивы из ненадёжных источников без предварительной проверки. Возможно создание файлов за пределами *path*, например, элементов с абсолютными именами, начинающимися с `"/"`, или с именами, содержащими две точки `".."`.315>316> Установите `filter='data'`, чтобы предотвратить наиболее опасные проблемы безопасности, и прочитайте раздел [Extraction filters](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter) для подробностей.317318Изменено в версии 3.5: Добавлен параметр *numeric\_owner*.319320Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object).321322Изменено в версии 3.11.4: Добавлен параметр *filter*.323324#### `TarFile.extract(member, path='', set_attrs=True, *, numeric_owner=False, filter=None)`325326Извлекает элемент из архива в текущую рабочую директорию, используя его полное имя. Информация о файле извлекается максимально точно. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Можно указать другую директорию с помощью *path*. *path* может быть [объектом, подобным пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). Атрибуты файла (владелец, mtime, права доступа) устанавливаются, если *set\_attrs* не равно false.327328Аргументы *numeric\_owner* и *filter* такие же, как для [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall).329330> **Примечание**331>332> Метод [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) не решает ряд проблем извлечения. В большинстве случаев стоит рассмотреть использование метода [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall).333334> **Предупреждение**335>336> См. предупреждение для [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall).337>338> Установите `filter='data'`, чтобы предотвратить наиболее опасные проблемы безопасности, и прочитайте раздел [Extraction filters](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter) для подробностей.339340Изменено в версии 3.2: Добавлен параметр *set\_attrs*.341342Изменено в версии 3.5: Добавлен параметр *numeric\_owner*.343344Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object).345346Изменено в версии 3.11.4: Добавлен параметр *filter*.347348#### `TarFile.extractfile(member)`349350Извлекает элемент из архива в виде файлового объекта. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Если *member* – обычный файл или ссылка, возвращается объект [`io.BufferedReader`](https://python-all.ru/3.11/library/io.html#io.BufferedReader). Для всех остальных существующих элементов возвращается [`None`](https://python-all.ru/3.11/library/constants.html#None). Если *member* не найден в архиве, вызывается [`KeyError`](https://python-all.ru/3.11/library/exceptions.html#KeyError).351352Изменено в версии 3.3: Возвращается объект [`io.BufferedReader`](https://python-all.ru/3.11/library/io.html#io.BufferedReader).353354#### `TarFile.errorlevel: int`355356Если *errorlevel* равен `0`, ошибки игнорируются при использовании [`TarFile.extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`TarFile.extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall). Тем не менее, они отображаются как сообщения об ошибках в отладочном выводе, когда *debug* больше 0. Если `1` (по умолчанию), все *фатальные* ошибки вызываются как исключения [`OSError`](https://python-all.ru/3.11/library/exceptions.html#OSError) или [`FilterError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.FilterError). Если `2`, все *нефатальные* ошибки также вызываются как исключения [`TarError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarError).357358Некоторые исключения, например, вызванные неправильными типами аргументов или повреждением данных, всегда вызываются.359360Пользовательские [фильтры извлечения](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter) должны вызывать [`FilterError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.FilterError) для *фатальных* ошибок и [`ExtractError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.ExtractError) для *нефатальных*.361362Обратите внимание, что при возникновении исключения архив может быть извлечён частично. Ответственность за очистку лежит на пользователе.363364#### `TarFile.extraction_filter`365366Новое в версии 3.11.4.367368[Фильтр извлечения](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter), используемый по умолчанию для аргумента *filter* методов [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall).369370Атрибут может быть `None` или вызываемым объектом. Строковые имена для этого атрибута не допускаются, в отличие от аргумента *filter* для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract).371372Если `extraction_filter` равен `None` (значение по умолчанию), вызов метода извлечения без аргумента *filter* приведёт к использованию фильтра [`fully_trusted`](https://python-all.ru/3.11/library/tarfile.html#tarfile.fully_trusted_filter) для совместимости с предыдущими версиями Python.373374В Python 3.12+ оставление `extraction_filter=None` вызовет `DeprecationWarning`.375376Начиная с Python 3.14, если оставить `extraction_filter=None`, методы извлечения по умолчанию будут использовать фильтр [`data`](https://python-all.ru/3.11/library/tarfile.html#tarfile.data_filter).377378Атрибут может быть установлен для экземпляров или переопределён в подклассах. Также возможно установить его для самого класса `TarFile`, чтобы задать глобальное значение по умолчанию; однако, поскольку это влияет на все случаи использования *tarfile*, лучшей практикой будет делать это только в приложениях верхнего уровня или [`site configuration`](https://python-all.ru/3.11/library/site.html#module-site). Чтобы задать глобальное значение по умолчанию таким образом, функцию фильтра необходимо обернуть в [`staticmethod()`](https://python-all.ru/3.11/library/functions.html#staticmethod), чтобы предотвратить внедрение аргумента `self`.379380#### `TarFile.add(name, arcname=None, recursive=True, *, filter=None)`381382Добавляет файл *name* в архив. *name* может быть любым типом файла (каталог, FIFO, символическая ссылка и т.д.). Если задан, *arcname* указывает альтернативное имя файла в архиве. Каталоги добавляются рекурсивно по умолчанию. Этого можно избежать, установив *recursive* в [`False`](https://python-all.ru/3.11/library/constants.html#False). Рекурсия добавляет записи в отсортированном порядке. Если задан *filter*, он должен быть функцией, которая принимает аргумент объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) и возвращает изменённый объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Если же она возвращает [`None`](https://python-all.ru/3.11/library/constants.html#None), объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) будет исключён из архива. Пример см. в [Примерах](https://python-all.ru/3.11/library/tarfile.html#tar-examples).383384Изменено в версии 3.2: Добавлен параметр *filter*.385386Изменено в версии 3.7: Рекурсия добавляет записи в отсортированном порядке.387388#### `TarFile.addfile(tarinfo, fileobj=None)`389390Добавляет объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) *tarinfo* в архив. Если указан *fileobj*, он должен быть [двоичным файлом](https://python-all.ru/3.11/glossary.html#term-binary-file), из которого читаются `tarinfo.size` байтов и добавляются в архив. Можно создавать объекты [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) напрямую или с помощью [`gettarinfo()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.gettarinfo).391392#### `TarFile.gettarinfo(name=None, arcname=None, fileobj=None)`393394Создаёт объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) из результата [`os.stat()`](https://python-all.ru/3.11/library/os.html#os.stat) или эквивалентного для существующего файла. Файл задаётся либо именем *name*, либо указывается как [файловый объект](https://python-all.ru/3.11/glossary.html#term-file-object) *fileobj* с файловым дескриптором. *name* может быть [объектом, подобным пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). Если задан, *arcname* указывает альтернативное имя файла в архиве; в противном случае имя берётся из атрибута [`name`](https://python-all.ru/3.11/library/io.html#io.FileIO.name) объекта *fileobj* или из аргумента *name*. Имя должно быть текстовой строкой.395396Можно изменить некоторые атрибуты объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) перед его добавлением с помощью [`addfile()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.addfile). Если файловый объект не является обычным файловым объектом, расположенным в начале файла, такие атрибуты, как [`size`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.size), могут потребовать изменения. Это относится к таким объектам, как [`GzipFile`](https://python-all.ru/3.11/library/gzip.html#gzip.GzipFile). Атрибут [`name`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.name) также может быть изменён, и в этом случае *arcname* может быть фиктивной строкой.397398Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object).399400#### `TarFile.close()`401402Закрывает [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile). В режиме записи в архив добавляются два завершающих нулевых блока.403404#### `TarFile.pax_headers: dict`405406Словарь, содержащий пары ключ-значение глобальных заголовков pax.407408## Объекты TarInfo409410Объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) представляет один элемент в [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile). Помимо хранения всех необходимых атрибутов файла (таких как тип, размер, время, права доступа, владелец и т.д.), он предоставляет некоторые полезные методы для определения его типа. Он *не* содержит сами данные файла.411412Объекты [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) возвращаются методами [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile): [`getmember()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmember), [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers) и [`gettarinfo()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.gettarinfo).413414Изменение объектов, возвращённых методами [`getmember()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmember) или [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers), повлияет на все последующие операции с архивом. В случаях, когда это нежелательно, можно использовать [`copy.copy()`](https://python-all.ru/3.11/library/copy.html#module-copy) или вызвать метод [`replace()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.replace), чтобы создать изменённую копию за один шаг.415416Некоторые атрибуты могут быть установлены в `None`, чтобы указать, что часть метаданных не используется или неизвестна. Разные методы [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) обрабатывают `None` по-разному:417418- Методы [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall) будут игнорировать соответствующие метаданные, оставляя их установленными по умолчанию.419- [`addfile()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.addfile) завершится ошибкой.420- [`list()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.list) выведет строку-заполнитель.421422Изменено в версии 3.11.4: Добавлены [`replace()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.replace) и обработка `None`.423424#### `class tarfile.TarInfo(name='')`425426Создаёт объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo).427428#### `classmethod TarInfo.frombuf(buf, encoding, errors)`429430Создаёт и возвращает объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) из строкового буфера *buf*.431432Вызывает [`HeaderError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.HeaderError), если буфер некорректен.433434#### `classmethod TarInfo.fromtarfile(tarfile)`435436Читает следующий элемент из объекта [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) *tarfile* и возвращает его в виде объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo).437438#### `TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')`439440Создаёт строковый буфер из объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Подробнее об аргументах см. конструктор класса [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile).441442Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`.443444Объект `TarInfo` имеет следующие открытые атрибуты данных:445446#### `TarInfo.name: str`447448Имя элемента архива.449450#### `TarInfo.size: int`451452Размер в байтах.453454#### `TarInfo.mtime: int | float`455456Время последнего изменения в секундах с [начала эпохи](https://python-all.ru/3.11/library/time.html#epoch), как в [`os.stat_result.st_mtime`](https://python-all.ru/3.11/library/os.html#os.stat_result.st_mtime).457458Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута.459460#### `TarInfo.mode: int`461462Биты прав доступа, как для [`os.chmod()`](https://python-all.ru/3.11/library/os.html#os.chmod).463464Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута.465466#### `TarInfo.type`467468Тип файла. Обычно *type* – это одна из следующих констант: [`REGTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.REGTYPE), [`AREGTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.AREGTYPE), [`LNKTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.LNKTYPE), [`SYMTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.SYMTYPE), [`DIRTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.DIRTYPE), [`FIFOTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.FIFOTYPE), [`CONTTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.CONTTYPE), [`CHRTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.CHRTYPE), [`BLKTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.BLKTYPE), [`GNUTYPE_SPARSE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.GNUTYPE_SPARSE). Чтобы более удобно определить тип объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo), используйте методы `is*()`, описанные ниже.469470#### `TarInfo.linkname: str`471472Имя целевого файла, которое присутствует только в объектах [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) типов [`LNKTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.LNKTYPE) и [`SYMTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.SYMTYPE).473474Для символических ссылок (`SYMTYPE`) значение *linkname* указывается относительно каталога, содержащего ссылку. Для жёстких ссылок (`LNKTYPE`) значение *linkname* указывается относительно корня архива.475476#### `TarInfo.uid: int`477478Идентификатор пользователя, который изначально сохранил этот элемент.479480Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута.481482#### `TarInfo.gid: int`483484Идентификатор группы пользователя, который изначально сохранил этот элемент.485486Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута.487488#### `TarInfo.uname: str`489490Имя пользователя.491492Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута.493494#### `TarInfo.gname: str`495496Имя группы.497498Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута.499500#### `TarInfo.chksum: int`501502Контрольная сумма заголовка.503504#### `TarInfo.devmajor: int`505506Старший номер устройства.507508#### `TarInfo.devminor: int`509510Младший номер устройства.511512#### `TarInfo.offset: int`513514Заголовок tar начинается здесь.515516#### `TarInfo.offset_data: int`517518Данные файла начинаются здесь.519520#### `TarInfo.sparse`521522Информация о разреженном элементе.523524#### `TarInfo.pax_headers: dict`525526Словарь, содержащий пары ключ-значение связанного расширенного заголовка pax.527528#### `TarInfo.replace(name=..., mtime=..., mode=..., linkname=..., uid=..., gid=..., uname=..., gname=..., deep=True)`529530Новое в версии 3.11.4.531532Возвращает *новую* копию объекта `TarInfo` с указанными изменёнными атрибутами. Например, чтобы вернуть `TarInfo` с именем группы, установленным в `'staff'`, используйте:533534```python535new_tarinfo = old_tarinfo.replace(gname='staff')536```537538По умолчанию создаётся глубокая копия. Если *deep* равен false, копия поверхностная, то есть `pax_headers` и любые пользовательские атрибуты являются общими с исходным объектом `TarInfo`.539540Объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) также предоставляет несколько удобных запросных методов:541542#### `TarInfo.isfile()`543544Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) является обычным файлом.545546#### `TarInfo.isreg()`547548То же, что и [`isfile()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.isfile).549550#### `TarInfo.isdir()`551552Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это каталог.553554#### `TarInfo.issym()`555556Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это символическая ссылка.557558#### `TarInfo.islnk()`559560Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это жёсткая ссылка.561562#### `TarInfo.ischr()`563564Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это символьное устройство.565566#### `TarInfo.isblk()`567568Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это блочное устройство.569570#### `TarInfo.isfifo()`571572Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это FIFO.573574#### `TarInfo.isdev()`575576Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это символьное устройство, блочное устройство или FIFO.577578## Фильтры извлечения579580Новое в версии 3.11.4.581582Формат *tar* предназначен для сохранения всех деталей файловых систем UNIX-подобных ОС, что делает его очень мощным. К сожалению, эти возможности позволяют легко создавать tar-файлы, которые при извлечении могут иметь непреднамеренные – а возможно и вредоносные – эффекты. Например, извлечение tar-файла может перезаписать произвольные файлы различными способами (например, с использованием абсолютных путей, компонентов пути `..` или символических ссылок, влияющих на последующие элементы).583584В большинстве случаев полная функциональность не требуется. Поэтому *tarfile* поддерживает фильтры извлечения: механизм ограничения функциональности, что позволяет смягчить некоторые проблемы безопасности.585586> **См. также**587>588> **[**PEP 706**](https://python-all.ru/3.11/library/tarfile.html)**589>590> Содержит дополнительную мотивацию и обоснование дизайна.591592Аргумент *filter* для [`TarFile.extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) или [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall) может быть:593594- строка `'fully_trusted'`: соблюдать все метаданные, указанные в архиве. Следует использовать, если пользователь полностью доверяет архиву или реализует собственную сложную проверку.595- строка `'tar'`: соблюдать большинство специфических для *tar* возможностей (т.е. возможностей файловых систем UNIX-подобных ОС), но блокировать те, которые могут быть неожиданными или вредоносными. Подробнее см. [`tar_filter()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.tar_filter).596- строка `'data'`: игнорировать или блокировать большинство специфических для UNIX-подобных файловых систем возможностей. Предназначен для извлечения кроссплатформенных архивов. Подробнее см. [`data_filter()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.data_filter).597- `None` (по умолчанию): использовать [`TarFile.extraction_filter`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extraction_filter).598599  Если это также `None` (значение по умолчанию), будет использован фильтр `'fully_trusted'` (для совместимости с более ранними версиями Python).600601  В Python 3.12 значение по умолчанию будет выдавать `DeprecationWarning`.602603  В Python 3.14 фильтр `'data'` станет фильтром по умолчанию. Переключиться можно раньше; см. [`TarFile.extraction_filter`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extraction_filter).604- Вызываемый объект, который будет вызываться для каждого извлекаемого элемента с объектом [TarInfo](https://python-all.ru/3.11/library/tarfile.html#tarinfo-objects), описывающим элемент и путь назначения, куда извлекается архив (т.е. один и тот же путь используется для всех элементов):605606  ```python607  filter(member: TarInfo, path: str, /) -> TarInfo | None608  ```609610  Вызываемый объект вызывается непосредственно перед извлечением каждого элемента, поэтому он может учитывать текущее состояние диска. Он может:611612  - вернуть объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo), который будет использоваться вместо метаданных в архиве, или613  - вернуть `None`, в этом случае элемент будет пропущен, или614  - вызвать исключение для прерывания операции или пропуска элемента, в зависимости от [`errorlevel`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.errorlevel). Обратите внимание, что при прерывании извлечения [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall) может оставить архив частично извлечённым. Он не пытается выполнить очистку.615616### Именованные фильтры по умолчанию617618Предопределённые именованные фильтры доступны как функции, поэтому их можно повторно использовать в пользовательских фильтрах:619620#### `tarfile.fully_trusted_filter(member, path)`621622Возвращает *элемент* без изменений.623624Это реализует фильтр `'fully_trusted'`.625626#### `tarfile.tar_filter(member, path)`627628Реализует фильтр `'tar'`.629630- Удаляет начальные слеши (`/` и [`os.sep`](https://python-all.ru/3.11/library/os.html#os.sep)) из имён файлов.631- [Отказывается](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы с абсолютными путями (если имя является абсолютным даже после удаления слешей, например `C:/foo` в Windows). Это вызывает [`AbsolutePathError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.AbsolutePathError).632- [Отказывается](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы, абсолютный путь которых (после разрешения симлинков) оказался бы за пределами целевой директории. Это вызывает [`OutsideDestinationError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.OutsideDestinationError).633- Сбрасывает биты высоких режимов (setuid, setgid, sticky) и биты записи для группы и остальных ([`S_IWGRP`](https://python-all.ru/3.11/library/stat.html#stat.S_IWGRP) | [`S_IWOTH`](https://python-all.ru/3.11/library/stat.html#stat.S_IWOTH)).634635Возвращает изменённый элемент `TarInfo`.636637#### `tarfile.data_filter(member, path)`638639Реализует фильтр `'data'`. В дополнение к тому, что делает `tar_filter`:640641- Нормализует цели ссылок ([`TarInfo.linkname`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.linkname)) с помощью [`os.path.normpath()`](https://python-all.ru/3.11/library/os.path.html#os.path.normpath). Обратите внимание, что это удаляет внутренние компоненты `..`, что может изменить смысл ссылки, если путь в `TarInfo.linkname` проходит через символические ссылки.642- [Отказывается](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) извлекать ссылки (жёсткие или символические), которые указывают на абсолютные пути или ведут за пределы целевой директории.643644  Это вызывает [`AbsoluteLinkError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.AbsoluteLinkError) или [`LinkOutsideDestinationError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.LinkOutsideDestinationError).645646  Обратите внимание, что такие файлы отклоняются даже на платформах, не поддерживающих символические ссылки.647- [Отказывается](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы устройств (включая каналы). Это вызывает [`SpecialFileError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.SpecialFileError).648- Для обычных файлов, включая жёсткие ссылки:649650  - Устанавливает права на чтение и запись для владельца ([`S_IRUSR`](https://python-all.ru/3.11/library/stat.html#stat.S_IRUSR) | [`S_IWUSR`](https://python-all.ru/3.11/library/stat.html#stat.S_IWUSR)).651  - Удаляет права на выполнение для группы и остальных ([`S_IXGRP`](https://python-all.ru/3.11/library/stat.html#stat.S_IXGRP) | [`S_IXOTH`](https://python-all.ru/3.11/library/stat.html#stat.S_IXOTH)), если владелец ими не обладает ([`S_IXUSR`](https://python-all.ru/3.11/library/stat.html#stat.S_IXUSR)).652- Для остальных файлов (каталогов) устанавливает `mode` в `None`, чтобы методы извлечения пропускали применение битов разрешений.653- Устанавливает информацию о пользователе и группе (`uid`, `gid`, `uname`, `gname`) в `None`, чтобы методы извлечения пропускали её установку.654655Возвращает изменённый элемент `TarInfo`.656657Изменено в версии 3.11.13: Теперь цели ссылок нормализованы.658659### Ошибки фильтра660661Когда фильтр отказывается извлекать файл, он возбуждает соответствующее исключение, подкласс [`FilterError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.FilterError). Это прервёт извлечение, если [`TarFile.errorlevel`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.errorlevel) равно 1 или больше. При `errorlevel=0` ошибка будет зарегистрирована, а элемент будет пропущен, но извлечение продолжится.662663### Рекомендации по дополнительной проверке664665Даже с `filter='data'`, *tarfile* не подходит для извлечения недоверенных файлов без предварительной проверки. Среди прочих проблем, предопределённые фильтры не предотвращают атаки типа «отказ в обслуживании». Пользователям следует проводить дополнительные проверки.666667Вот неполный список аспектов, которые стоит учесть:668669- Извлекайте в [`new temporary directory`](https://python-all.ru/3.11/library/tempfile.html#tempfile.mkdtemp), чтобы предотвратить, например, использование существующих ссылок, и упростить очистку после неудачного извлечения.670- Запретите символические ссылки, если эта функциональность не требуется.671- При работе с недоверенными данными используйте внешние (например, на уровне ОС) ограничения на использование диска, памяти и процессора.672- Проверяет имена файлов по списку разрешённых символов (для фильтрации управляющих символов, омоглифов, разделителей пути из других систем и т.д.).673- Проверяет, что имена файлов имеют ожидаемые расширения (чтобы предотвратить файлы, которые выполняются при «двойном клике», или файлы без расширения, такие как специальные имена устройств Windows).674- Ограничивает количество извлечённых файлов, общий объём извлечённых данных, длину имён файлов (включая длину символических ссылок) и размер отдельных файлов.675- Проверяет наличие файлов, которые будут затенены на файловых системах без учёта регистра.676677Также обратите внимание:678679- Tar-файлы могут содержать несколько версий одного и того же файла. Ожидается, что более поздние версии перезапишут любые предыдущие. Эта возможность критически важна для обновления ленточных архивов, но может быть злонамеренно использована.680- *tarfile* не защищает от проблем с «активными» данными, например, когда злоумышленник манипулирует целевым (или исходным) каталогом во время извлечения (или архивирования).681682### Поддержка старых версий Python683684Фильтры извлечения были добавлены в Python 3.12 и перенесены в более старые версии в качестве обновлений безопасности. Чтобы проверить, доступна ли эта возможность, используйте, например, `hasattr(tarfile, 'data_filter')`, а не проверку версии Python.685686Следующие примеры показывают, как поддерживать версии Python с этой возможностью и без неё. Обратите внимание, что установка `extraction_filter` повлияет на все последующие операции.687688- Полностью доверенный архив:689690  ```python691  my_tarfile.extraction_filter = (lambda member, path: member)692  my_tarfile.extractall()693  ```694- Используйте фильтр `'data'`, если он доступен, иначе вернитесь к поведению Python 3.11 (`'fully_trusted'`), если эта возможность недоступна:695696  ```python697  my_tarfile.extraction_filter = getattr(tarfile, 'data_filter',698                                         (lambda member, path: member))699  my_tarfile.extractall()700  ```701- Используйте фильтр `'data'`; *завершить ошибкой*, если он недоступен:702703  ```python704  my_tarfile.extractall(filter=tarfile.data_filter)705  ```706707  или:708709  ```python710  my_tarfile.extraction_filter = tarfile.data_filter711  my_tarfile.extractall()712  ```713- Используйте фильтр `'data'`; *предупредить*, если он недоступен:714715  ```python716  if hasattr(tarfile, 'data_filter'):717      my_tarfile.extractall(filter='data')718  else:719      # удалить, когда больше не нужно720      warn_the_user('Extracting may be unsafe; consider updating Python')721      my_tarfile.extractall()722  ```723724### Пример фильтра извлечения с состоянием725726Хотя методы извлечения *tarfile* принимают простой вызываемый объект *filter*, пользовательские фильтры могут быть более сложными объектами с внутренним состоянием. Может быть полезно реализовать их в виде контекстных менеджеров, чтобы использовать следующим образом:727728```python729with StatefulFilter() as filter_func:730    tar.extractall(path, filter=filter_func)731```732733Такой фильтр можно написать, например, так:734735```python736class StatefulFilter:737    def __init__(self):738        self.file_count = 0739740    def __enter__(self):741        return self742743    def __call__(self, member, path):744        self.file_count += 1745        return member746747    def __exit__(self, *exc_info):748        print(f'{self.file_count} files extracted')749```750751## Интерфейс командной строки752753Новое в версии 3.4.754755Модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) предоставляет простой интерфейс командной строки для работы с tar-архивами.756757Если вы хотите создать новый tar-архив, укажите его имя после опции [`-c`](https://python-all.ru/3.11/library/tarfile.html#cmdoption-tarfile-c), а затем перечислите имена файлов, которые должны быть включены:758759```console760$ python -m tarfile -c monty.tar  spam.txt eggs.txt761```762763Можно также передать каталог:764765```console766$ python -m tarfile -c monty.tar life-of-brian_1979/767```768769Если вы хотите извлечь tar-архив в текущий каталог, используйте опцию [`-e`](https://python-all.ru/3.11/library/tarfile.html#cmdoption-tarfile-e):770771```console772$ python -m tarfile -e monty.tar773```774775Вы также можете извлечь tar-архив в другой каталог, передав его имя:776777```console778$ python -m tarfile -e monty.tar  other-dir/779```780781Чтобы получить список файлов в tar-архиве, используйте опцию [`-l`](https://python-all.ru/3.11/library/tarfile.html#cmdoption-tarfile-l):782783```console784$ python -m tarfile -l monty.tar785```786787### Параметры командной строки788789#### `-l <tarfile>`790791#### `--list <tarfile>`792793Выводит список файлов в tar-архиве.794795#### `-c <tarfile> <source1> ... <sourceN>`796797#### `--create <tarfile> <source1> ... <sourceN>`798799Создаёт tar-архив из исходных файлов.800801#### `-e <tarfile> [<output_dir>]`802803#### `--extract <tarfile> [<output_dir>]`804805Извлекает tar-архив в текущий каталог, если *output\_dir* не указан.806807#### `-t <tarfile>`808809#### `--test <tarfile>`810811Проверяет, является ли tar-файл допустимым.812813#### `-v, --verbose`814815Подробный вывод.816817#### `--filter <filtername>`818819Указывает *фильтр* для `--extract`. Подробнее см. [Фильтры извлечения](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter). Принимаются только строковые имена (то есть `fully_trusted`, `tar`, и `data`).820821Новое в версии 3.11.4.822823## Примеры824825Как извлечь полный tar-архив в текущий рабочий каталог:826827```python828import tarfile829tar = tarfile.open("sample.tar.gz")830tar.extractall()831tar.close()832```833834Как извлечь подмножество tar-архива с помощью [`TarFile.extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), используя функцию-генератор вместо списка:835836```python837import os838import tarfile839840def py_files(members):841    for tarinfo in members:842        if os.path.splitext(tarinfo.name)[1] == ".py":843            yield tarinfo844845tar = tarfile.open("sample.tar.gz")846tar.extractall(members=py_files(tar))847tar.close()848```849850Как создать несжатый tar-архив из списка имён файлов:851852```python853import tarfile854tar = tarfile.open("sample.tar", "w")855for name in ["foo", "bar", "quux"]:856    tar.add(name)857tar.close()858```859860Тот же пример с использованием оператора [`with`](https://python-all.ru/3.11/reference/compound_stmts.html#with):861862```python863import tarfile864with tarfile.open("sample.tar", "w") as tar:865    for name in ["foo", "bar", "quux"]:866        tar.add(name)867```868869Как прочитать tar-архив, сжатый gzip, и вывести информацию о некоторых элементах:870871```python872import tarfile873tar = tarfile.open("sample.tar.gz", "r:gz")874for tarinfo in tar:875    print(tarinfo.name, "is", tarinfo.size, "bytes in size and is ", end="")876    if tarinfo.isreg():877        print("a regular file.")878    elif tarinfo.isdir():879        print("a directory.")880    else:881        print("something else.")882tar.close()883```884885Как создать архив и сбросить информацию о пользователе, используя параметр *фильтр* в [`TarFile.add()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.add):886887```python888import tarfile889def reset(tarinfo):890    tarinfo.uid = tarinfo.gid = 0891    tarinfo.uname = tarinfo.gname = "root"892    return tarinfo893tar = tarfile.open("sample.tar.gz", "w:gz")894tar.add("foo", filter=reset)895tar.close()896```897898## Поддерживаемые форматы tar899900Существует три формата tar, которые можно создать с помощью модуля [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile):901902- Формат POSIX.1-1988 ustar ([`USTAR_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.USTAR_FORMAT)). Он поддерживает имена файлов длиной не более 256 символов и имена ссылок – до 100 символов. Максимальный размер файла – 8 ГиБ. Это старый и ограниченный, но широко поддерживаемый формат.903- Формат GNU tar ([`GNU_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.GNU_FORMAT)). Он поддерживает длинные имена файлов и ссылок, файлы размером более 8 ГиБ и разрежённые файлы. Это де-факто стандарт в системах GNU/Linux. [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) полностью поддерживает расширения GNU tar для длинных имён; поддержка разрежённых файлов – только для чтения.904- Формат POSIX.1-2001 pax ([`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT)). Это самый гибкий формат, практически без ограничений. Он поддерживает длинные имена файлов и ссылок, большие файлы и хранит пути переносимым способом. Современные реализации tar, включая GNU tar, bsdtar/libarchive и star, полностью поддерживают расширенные возможности *pax*; некоторые старые или неподдерживаемые библиотеки могут не поддерживать, но должны обрабатывать архивы *pax* так, как если бы они были в универсально поддерживаемом формате *ustar*. Это текущий формат по умолчанию для новых архивов.905906  Он расширяет существующий формат *ustar* дополнительными заголовками для информации, которую иначе нельзя сохранить. Существует две разновидности заголовков pax: расширенные заголовки влияют только на последующий заголовок файла, глобальные заголовки действительны для всего архива и влияют на все последующие файлы. Все данные в заголовке pax кодируются в *UTF-8* по соображениям переносимости.907908Существуют ещё некоторые варианты формата tar, которые можно читать, но не создавать:909910- Древний формат V7. Это первый формат tar из Unix Seventh Edition, хранящий только обычные файлы и каталоги. Имена не должны быть длиннее 100 символов, информация об имени пользователя/группы отсутствует. Некоторые архивы имеют неправильные контрольные суммы заголовков в случае полей с не-ASCII символами.911- Расширенный формат SunOS tar. Этот формат является вариантом формата POSIX.1-2001 pax, но несовместим с ним.912913## Проблемы Unicode914915Формат tar изначально был задуман для создания резервных копий на ленточных накопителях с основным упором на сохранение информации о файловой системе. Сегодня tar-архивы обычно используются для распространения файлов и обмена архивами по сетям. Одна проблема исходного формата (который является основой всех других форматов) заключается в том, что нет концепции поддержки разных кодировок символов. Например, обычный tar-архив, созданный в системе с *UTF-8*, не может быть корректно прочитан в системе с *Latin-1*, если он содержит символы, отличные от *ASCII*. Текстовые метаданные (например, имена файлов, имена ссылок, имена пользователей/групп) будут повреждены. К сожалению, нет способа автоматически определить кодировку архива. Формат pax был разработан для решения этой проблемы. Он хранит не-ASCII метаданные, используя универсальную кодировку символов *UTF-8*.916917Детали преобразования символов в [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) управляются ключевыми аргументами *encoding* и *errors* класса [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile).918919*encoding* определяет кодировку символов, используемую для метаданных в архиве. Значение по умолчанию – [`sys.getfilesystemencoding()`](https://python-all.ru/3.11/library/sys.html#sys.getfilesystemencoding) или `'ascii'` в качестве запасного варианта. В зависимости от того, читается или записывается архив, метаданные должны быть либо декодированы, либо закодированы. Если *encoding* не установлена соответствующим образом, это преобразование может завершиться ошибкой.920921Аргумент *errors* определяет, как обрабатываются символы, которые невозможно преобразовать. Возможные значения перечислены в разделе [Обработчики ошибок](https://python-all.ru/3.11/library/codecs.html#error-handlers). Схема по умолчанию – `'surrogateescape'`, которую Python также использует для своих системных вызовов, см. [Имена файлов, аргументы командной строки и переменные окружения](https://python-all.ru/3.11/library/os.html#os-filenames).922923Для архивов [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT) (по умолчанию) *encoding* обычно не требуется, потому что все метаданные хранятся с использованием *UTF-8*. *encoding* используется только в редких случаях, когда декодируются бинарные заголовки pax или когда хранятся строки с суррогатными символами.924