tarfile.md
1> **Источник:** https://python-all.ru/3.9/library/tarfile.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile) – Чтение и запись файлов tar-архивов89**Исходный код:** [Lib/tarfile.py](https://python-all.ru/src/3.9/Lib/tarfile.py)1011---1213Модуль [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile) позволяет читать и записывать tar-архивы, в том числе сжатые gzip, bz2 и lzma. Используйте модуль [`zipfile`](https://python-all.ru/3.9/library/zipfile.html#module-zipfile) для чтения и записи файлов `.zip` или функции более высокого уровня из [shutil](https://python-all.ru/3.9/library/shutil.html#archiving-operations).1415Некоторые факты и цифры:1617- читает и записывает сжатые архивы [`gzip`](https://python-all.ru/3.9/library/gzip.html#module-gzip), [`bz2`](https://python-all.ru/3.9/library/bz2.html#module-bz2) и [`lzma`](https://python-all.ru/3.9/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.9/library/lzma.html#module-lzma).2425#### `tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)`2627Возвращает объект [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile) для имени пути *name*. Подробную информацию об объектах [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile) и допустимых именованных аргументах см. в разделе [Объекты TarFile](https://python-all.ru/3.9/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.9/library/exceptions.html#FileExistsError), если файл уже существует. |39| `'x:gz'` | Создаёт tar-файл со сжатием gzip. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.9/library/exceptions.html#FileExistsError), если файл уже существует. |40| `'x:bz2'` | Создаёт tar-файл со сжатием bzip2. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.9/library/exceptions.html#FileExistsError), если файл уже существует. |41| `'x:xz'` | Создаёт tar-файл со сжатием lzma. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.9/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.9/library/tarfile.html#tarfile.ReadError). Используйте *режим* `'r'`, чтобы избежать этого. Если метод сжатия не поддерживается, возбуждается [`CompressionError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.CompressionError).4950Если указан *fileobj*, он используется вместо [файлового объекта](https://python-all.ru/3.9/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.9/library/tarfile.html#tarfile.open) принимает именованный аргумент *compresslevel* (по умолчанию `9`) для указания уровня сжатия файла.5354Для режимов `'w:xz'` и `'x:xz'` [`tarfile.open()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.open) принимает именованный аргумент *preset* для указания уровня сжатия файла.5556Для специальных целей существует второй формат для *mode*: `'filemode|[compression]'`. [`tarfile.open()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.open) вернёт объект [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile), который обрабатывает данные как поток блоков. Поиск по файлу с произвольным доступом не выполняется. Если задан *fileobj*, это может быть любой объект с методами `read()` или `write()` (в зависимости от *mode*). *bufsize* задаёт размер блока; по умолчанию `20 * 512` байт. Используйте этот вариант в сочетании, например, с `sys.stdin`, сокетным [файловым объектом](https://python-all.ru/3.9/glossary.html#term-file-object) или ленточным устройством. Однако такой объект [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile) ограничен тем, что не допускает произвольный доступ – см. [Примеры](https://python-all.ru/3.9/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.9/glossary.html#term-path-like-object).7374#### `class tarfile.TarFile`7576Класс для чтения и записи tar-архивов. Не используйте этот класс напрямую: вместо него используйте [`tarfile.open()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.open). См. [Объекты TarFile](https://python-all.ru/3.9/library/tarfile.html#tarfile-objects).7778#### `tarfile.is_tarfile(name)`7980Возвращает [`True`](https://python-all.ru/3.9/library/constants.html#True), если *name* является tar-архивом, который может прочитать модуль [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile). *name* может быть [`str`](https://python-all.ru/3.9/library/stdtypes.html#str), файлом или файлоподобным объектом.8182Изменено в версии 3.9: Добавлена поддержка файлов и файлоподобных объектов.8384Модуль [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile) определяет следующие исключения:8586#### `exception tarfile.TarError`8788Базовый класс для всех исключений [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile).8990#### `exception tarfile.ReadError`9192Возникает при открытии tar-архива, который не может быть обработан модулем [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile) или является некорректным.9394#### `exception tarfile.CompressionError`9596Возникает, когда метод сжатия не поддерживается или данные не удаётся корректно декодировать.9798#### `exception tarfile.StreamError`99100Возникает при ограничениях, типичных для объектов, работающих в режиме потока [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile).101102#### `exception tarfile.ExtractError`103104Возникает при *нефатальных* ошибках при использовании [`TarFile.extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract), но только если [`TarFile.errorlevel`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.errorlevel)`== 2`.105106#### `exception tarfile.HeaderError`107108Возникает при вызове [`TarInfo.frombuf()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo.frombuf), если полученный буфер некорректен.109110#### `exception tarfile.FilterError`111112Базовый класс для элементов, [отклонённых](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-refuse) фильтрами.113114#### `tarinfo`115116Информация об элементе, который фильтр отказался извлекать, в виде [TarInfo](https://python-all.ru/3.9/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.9.25 (не выпущена).143144На уровне модуля доступны следующие константы:145146#### `tarfile.ENCODING`147148Кодировка символов по умолчанию: `'utf-8'` в Windows, значение, возвращаемое [`sys.getfilesystemencoding()`](https://python-all.ru/3.9/library/sys.html#sys.getfilesystemencoding) в остальных случаях.149150Каждая из следующих констант определяет формат tar-архива, который модуль [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile) может создавать. Подробнее см. раздел [Поддерживаемые форматы tar](https://python-all.ru/3.9/library/tarfile.html#tar-formats) для получения подробностей.151152#### `tarfile.USTAR_FORMAT`153154Формат POSIX.1-1988 (ustar).155156#### `tarfile.GNU_FORMAT`157158Формат GNU tar.159160#### `tarfile.PAX_FORMAT`161162Формат POSIX.1-2001 (pax).163164#### `tarfile.DEFAULT_FORMAT`165166Формат по умолчанию для создания архивов. В настоящее время это [`PAX_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.PAX_FORMAT).167168Изменено в версии 3.8: Формат по умолчанию для новых архивов был изменён на [`PAX_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.PAX_FORMAT) с [`GNU_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.GNU_FORMAT).169170> **См. также**171>172> **Модуль [`zipfile`](https://python-all.ru/3.9/library/zipfile.html#module-zipfile)**173>174> Документация стандартного модуля [`zipfile`](https://python-all.ru/3.9/library/zipfile.html#module-zipfile).175>176> **[Операции архивирования](https://python-all.ru/3.9/library/shutil.html#archiving-operations)**177>178> Документация средств архивирования высокого уровня, предоставляемых стандартным модулем [`shutil`](https://python-all.ru/3.9/library/shutil.html#module-shutil).179>180> **[Руководство GNU tar, базовый формат tar](https://python-all.ru/3.9/library/tarfile.html)**181>182> Документация для файлов архивов tar, включая расширения GNU tar.183184## Объекты TarFile185186Объект [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile) предоставляет интерфейс к архиву tar. Архив tar представляет собой последовательность блоков. Элемент архива (хранимый файл) состоит из заголовочного блока, за которым следуют блоки данных. Файл можно сохранить в архив tar несколько раз. Каждый элемент архива представляется объектом [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo), подробнее см. [Объекты TarInfo](https://python-all.ru/3.9/library/tarfile.html#tarinfo-objects).187188Объект [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile) можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3.9/reference/compound_stmts.html#with). Он будет автоматически закрыт по завершении блока. Обратите внимание: в случае исключения архив, открытый для записи, не будет финализирован; будет закрыт только внутренний файловый объект. Пример использования см. в разделе [Примеры](https://python-all.ru/3.9/library/tarfile.html#tar-examples).189190Новое в версии 3.2: Добавлена поддержка протокола менеджера контекста.191192#### `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)`193194Все последующие аргументы необязательны и также могут быть доступны как атрибуты экземпляра.195196*name* – это путь к архиву. *name* может быть [объектом, подобным пути](https://python-all.ru/3.9/glossary.html#term-path-like-object). Его можно опустить, если указан *fileobj*. В этом случае используется атрибут файлового объекта `name`, если он существует.197198*mode* может быть `'r'` для чтения из существующего архива, `'a'` для добавления данных в существующий файл, `'w'` для создания нового файла с перезаписью существующего или `'x'` для создания нового файла только в том случае, если он ещё не существует.199200Если указан *fileobj*, он используется для чтения или записи данных. Если это можно определить, *mode* переопределяется режимом *fileobj*. *fileobj* будет использоваться с позиции 0.201202> **Примечание**203>204> *fileobj* не закрывается при закрытии [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile).205206*format* управляет форматом архива для записи. Он должен быть одной из констант [`USTAR_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.USTAR_FORMAT), [`GNU_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.GNU_FORMAT) или [`PAX_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.PAX_FORMAT), определённых на уровне модуля. При чтении формат будет определён автоматически, даже если в одном архиве присутствуют разные форматы.207208Аргумент *tarinfo* можно использовать для замены класса по умолчанию [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) на другой.209210Если *dereference* равно [`False`](https://python-all.ru/3.9/library/constants.html#False), в архив добавляются символические и жёсткие ссылки. Если [`True`](https://python-all.ru/3.9/library/constants.html#True), в архив добавляется содержимое целевых файлов. Это не влияет на системы, не поддерживающие символические ссылки.211212Если *ignore\_zeros* равно [`False`](https://python-all.ru/3.9/library/constants.html#False), пустой блок считается концом архива. Если [`True`](https://python-all.ru/3.9/library/constants.html#True), пустые (и недействительные) блоки пропускаются, и предпринимается попытка получить как можно больше элементов. Это полезно только для чтения объединённых или повреждённых архивов.213214*debug* может быть установлен от `0` (нет отладочных сообщений) до `3` (все отладочные сообщения). Сообщения записываются в `sys.stderr`.215216*errorlevel* управляет обработкой ошибок извлечения, см. `the corresponding attribute`.217218Аргументы *encoding* и *errors* определяют кодировку символов, используемую для чтения или записи архива, и способ обработки ошибок преобразования. Настройки по умолчанию подходят для большинства пользователей. Подробную информацию см. в разделе [Проблемы Unicode](https://python-all.ru/3.9/library/tarfile.html#tar-unicode).219220Аргумент *pax\_headers* – необязательный словарь строк, который будет добавлен как глобальный заголовок pax, если *format* равно [`PAX_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.PAX_FORMAT).221222Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`.223224Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание).225226Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.9/glossary.html#term-path-like-object).227228#### `classmethod TarFile.open(...)`229230Альтернативный конструктор. Функция [`tarfile.open()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.open) на самом деле является сокращением для этого метода класса.231232#### `TarFile.getmember(name)`233234Возвращает объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) для элемента *name*. Если *name* не найден в архиве, возбуждается [`KeyError`](https://python-all.ru/3.9/library/exceptions.html#KeyError).235236> **Примечание**237>238> Если элемент встречается в архиве более одного раза, последнее его вхождение считается самой актуальной версией.239240#### `TarFile.getmembers()`241242Возвращает элементы архива в виде списка объектов [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo). Порядок списка соответствует порядку элементов в архиве.243244#### `TarFile.getnames()`245246Возвращает элементы в виде списка их имён. Порядок списка соответствует порядку списка, возвращаемого [`getmembers()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.getmembers).247248#### `TarFile.list(verbose=True, *, members=None)`249250Выводит оглавление в `sys.stdout`. Если *verbose* равно [`False`](https://python-all.ru/3.9/library/constants.html#False), печатаются только имена элементов. Если же [`True`](https://python-all.ru/3.9/library/constants.html#True), выводятся данные, аналогичные **ls -l**. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.getmembers).251252Изменено в версии 3.5: Добавлен параметр *members*.253254#### `TarFile.next()`255256Возвращает следующий элемент архива в виде объекта [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo), когда [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile) открыт для чтения. Если больше нет элементов, возвращает [`None`](https://python-all.ru/3.9/library/constants.html#None).257258#### `TarFile.extractall(path=".", members=None, *, numeric_owner=False, filter=None)`259260Извлекает все элементы из архива в текущую рабочую директорию или в директорию *path*. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.getmembers). Сведения о директории (владелец, время изменения, права доступа) устанавливаются после извлечения всех элементов. Это сделано для обхода двух проблем: время изменения директории сбрасывается при каждом создании в ней файла, и если права директории не разрешают запись, извлечение в неё файлов завершится ошибкой.261262Если *numeric\_owner* равно [`True`](https://python-all.ru/3.9/library/constants.html#True), для установки владельца и группы извлечённых файлов используются числовые uid и gid из tar-файла. В противном случае используются именованные значения из tar-файла.263264Аргумент *filter*, который был добавлен в Python 3.9.17, определяет, как `members` изменяются или отклоняются перед извлечением. См. [Фильтры извлечения](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-filter) для подробностей. Рекомендуется явно задавать этот параметр в зависимости от того, какие возможности *tar* необходимо поддерживать.265266> **Предупреждение**267>268> Никогда не извлекайте архивы из ненадёжных источников без предварительной проверки. Возможно создание файлов за пределами *path*, например, элементов с абсолютными именами, начинающимися с `"/"`, или с именами, содержащими две точки `".."`.269>270> Установите `filter='data'`, чтобы предотвратить наиболее опасные проблемы безопасности, и прочитайте раздел [Extraction filters](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-filter) для подробностей.271272Изменено в версии 3.5: Добавлен параметр *numeric\_owner*.273274Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3.9/glossary.html#term-path-like-object).275276Изменено в версии 3.9.17: добавлен параметр *filter*.277278#### `TarFile.extract(member, path="", set_attrs=True, *, numeric_owner=False, filter=None)`279280Извлекает элемент из архива в текущую рабочую директорию, используя его полное имя. Информация о файле извлекается максимально точно. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo). Можно указать другую директорию с помощью *path*. *path* может быть [объектом, подобным пути](https://python-all.ru/3.9/glossary.html#term-path-like-object). Атрибуты файла (владелец, mtime, права доступа) устанавливаются, если *set\_attrs* не равно false.281282Аргументы *numeric\_owner* и *filter* такие же, как для [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall).283284> **Примечание**285>286> Метод [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) не решает ряд проблем извлечения. В большинстве случаев стоит рассмотреть использование метода [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall).287288> **Предупреждение**289>290> См. предупреждение для [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall).291>292> Установите `filter='data'`, чтобы предотвратить наиболее опасные проблемы безопасности, и прочитайте раздел [Extraction filters](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-filter) для подробностей.293294Изменено в версии 3.2: Добавлен параметр *set\_attrs*.295296Изменено в версии 3.5: Добавлен параметр *numeric\_owner*.297298Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3.9/glossary.html#term-path-like-object).299300Изменено в версии 3.9.17: добавлен параметр *filter*.301302#### `TarFile.extractfile(member)`303304Извлекает элемент из архива в виде файлового объекта. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo). Если *member* – обычный файл или ссылка, возвращается объект [`io.BufferedReader`](https://python-all.ru/3.9/library/io.html#io.BufferedReader). Для всех остальных существующих элементов возвращается [`None`](https://python-all.ru/3.9/library/constants.html#None). Если *member* не найден в архиве, вызывается [`KeyError`](https://python-all.ru/3.9/library/exceptions.html#KeyError).305306Изменено в версии 3.3: Возвращается объект [`io.BufferedReader`](https://python-all.ru/3.9/library/io.html#io.BufferedReader).307308#### `TarFile.errorlevel: int`309310Если *errorlevel* равен `0`, ошибки игнорируются при использовании [`TarFile.extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) и [`TarFile.extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall). Тем не менее, они отображаются как сообщения об ошибках в отладочном выводе, когда *debug* больше 0. Если `1` (по умолчанию), все *фатальные* ошибки вызываются как исключения [`OSError`](https://python-all.ru/3.9/library/exceptions.html#OSError) или [`FilterError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.FilterError). Если `2`, все *нефатальные* ошибки также вызываются как исключения [`TarError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarError).311312Некоторые исключения, например, вызванные неправильными типами аргументов или повреждением данных, всегда вызываются.313314Пользовательские [фильтры извлечения](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-filter) должны вызывать [`FilterError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.FilterError) для *фатальных* ошибок и [`ExtractError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.ExtractError) для *нефатальных*.315316Обратите внимание, что при возникновении исключения архив может быть извлечён частично. Ответственность за очистку лежит на пользователе.317318#### `TarFile.extraction_filter`319320Новое в версии 3.9.17.321322[Фильтр извлечения](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-filter), используемый по умолчанию для аргумента *filter* методов [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall).323324Атрибут может быть `None` или вызываемым объектом. Строковые имена для этого атрибута не допускаются, в отличие от аргумента *filter* для [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract).325326Если `extraction_filter` равен `None` (значение по умолчанию), вызов метода извлечения без аргумента *filter* приведёт к использованию фильтра [`fully_trusted`](https://python-all.ru/3.9/library/tarfile.html#tarfile.fully_trusted_filter) для совместимости с предыдущими версиями Python.327328В Python 3.12+ оставление `extraction_filter=None` вызовет `DeprecationWarning`.329330Начиная с Python 3.14, если оставить `extraction_filter=None`, методы извлечения по умолчанию будут использовать фильтр [`data`](https://python-all.ru/3.9/library/tarfile.html#tarfile.data_filter).331332Атрибут может быть установлен для экземпляров или переопределён в подклассах. Также возможно установить его для самого класса `TarFile`, чтобы задать глобальное значение по умолчанию; однако, поскольку это влияет на все случаи использования *tarfile*, лучшей практикой будет делать это только в приложениях верхнего уровня или [`site configuration`](https://python-all.ru/3.9/library/site.html#module-site). Чтобы задать глобальное значение по умолчанию таким образом, функцию фильтра необходимо обернуть в [`staticmethod()`](https://python-all.ru/3.9/library/functions.html#staticmethod), чтобы предотвратить внедрение аргумента `self`.333334#### `TarFile.add(name, arcname=None, recursive=True, *, filter=None)`335336Добавляет файл *name* в архив. *name* может быть любым типом файла (каталог, FIFO, символическая ссылка и т.д.). Если задан, *arcname* указывает альтернативное имя файла в архиве. Каталоги добавляются рекурсивно по умолчанию. Этого можно избежать, установив *recursive* в [`False`](https://python-all.ru/3.9/library/constants.html#False). Рекурсия добавляет записи в отсортированном порядке. Если задан *filter*, он должен быть функцией, которая принимает аргумент объекта [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) и возвращает изменённый объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo). Если же она возвращает [`None`](https://python-all.ru/3.9/library/constants.html#None), объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) будет исключён из архива. Пример см. в [Примерах](https://python-all.ru/3.9/library/tarfile.html#tar-examples).337338Изменено в версии 3.2: Добавлен параметр *filter*.339340Изменено в версии 3.7: Рекурсия добавляет записи в отсортированном порядке.341342#### `TarFile.addfile(tarinfo, fileobj=None)`343344Добавляет объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) *tarinfo* в архив. Если указан *fileobj*, он должен быть [двоичным файлом](https://python-all.ru/3.9/glossary.html#term-binary-file), из которого читаются `tarinfo.size` байтов и добавляются в архив. Можно создавать объекты [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) напрямую или с помощью [`gettarinfo()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.gettarinfo).345346#### `TarFile.gettarinfo(name=None, arcname=None, fileobj=None)`347348Создаёт объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) из результата [`os.stat()`](https://python-all.ru/3.9/library/os.html#os.stat) или эквивалентного для существующего файла. Файл задаётся либо именем *name*, либо указывается как [файловый объект](https://python-all.ru/3.9/glossary.html#term-file-object) *fileobj* с файловым дескриптором. *name* может быть [объектом, подобным пути](https://python-all.ru/3.9/glossary.html#term-path-like-object). Если задан, *arcname* указывает альтернативное имя файла в архиве; в противном случае имя берётся из атрибута [`name`](https://python-all.ru/3.9/library/io.html#io.FileIO.name) объекта *fileobj* или из аргумента *name*. Имя должно быть текстовой строкой.349350Можно изменить некоторые атрибуты объекта [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) перед его добавлением с помощью [`addfile()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.addfile). Если файловый объект не является обычным файловым объектом, расположенным в начале файла, такие атрибуты, как [`size`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo.size), могут потребовать изменения. Это относится к таким объектам, как [`GzipFile`](https://python-all.ru/3.9/library/gzip.html#gzip.GzipFile). Атрибут [`name`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo.name) также может быть изменён, и в этом случае *arcname* может быть фиктивной строкой.351352Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.9/glossary.html#term-path-like-object).353354#### `TarFile.close()`355356Закрывает [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile). В режиме записи в архив добавляются два завершающих нулевых блока.357358#### `TarFile.pax_headers`359360Словарь, содержащий пары ключ-значение глобальных заголовков pax.361362## Объекты TarInfo363364Объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) представляет один элемент в [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile). Помимо хранения всех необходимых атрибутов файла (таких как тип, размер, время, права доступа, владелец и т.д.), он предоставляет некоторые полезные методы для определения его типа. Он *не* содержит сами данные файла.365366Объекты [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) возвращаются методами [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile): [`getmember()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.getmember), [`getmembers()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.getmembers) и [`gettarinfo()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.gettarinfo).367368Изменение объектов, возвращённых методами `getmember()` или `getmembers()`, повлияет на все последующие операции с архивом. В случаях, когда это нежелательно, можно использовать [`copy.copy()`](https://python-all.ru/3.9/library/copy.html#module-copy) или вызвать метод `replace()`, чтобы создать изменённую копию за один шаг.369370Некоторые атрибуты могут быть установлены в `None`, чтобы указать, что часть метаданных не используется или неизвестна. Разные методы [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) обрабатывают `None` по-разному:371372- Методы [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall) будут игнорировать соответствующие метаданные, оставляя их установленными по умолчанию.373- [`addfile()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.addfile) завершится ошибкой.374- [`list()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.list) выведет строку-заполнитель.375376Изменено в версии 3.9.17: добавлены `replace()` и обработка `None`.377378#### `class tarfile.TarInfo(name="")`379380Создаёт объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo).381382#### `classmethod TarInfo.frombuf(buf, encoding, errors)`383384Создаёт и возвращает объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) из строкового буфера *buf*.385386Вызывает [`HeaderError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.HeaderError), если буфер некорректен.387388#### `classmethod TarInfo.fromtarfile(tarfile)`389390Читает следующий элемент из объекта [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile) *tarfile* и возвращает его в виде объекта [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo).391392#### `TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')`393394Создаёт строковый буфер из объекта [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo). Подробнее об аргументах см. конструктор класса [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile).395396Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`.397398Объект `TarInfo` имеет следующие открытые атрибуты данных:399400#### `TarInfo.name: str`401402Имя элемента архива.403404#### `TarInfo.size: int`405406Размер в байтах.407408#### `TarInfo.mtime: int | float`409410Время последнего изменения в секундах с [начала эпохи](https://python-all.ru/3.9/library/time.html#epoch), как в [`os.stat_result.st_mtime`](https://python-all.ru/3.9/library/os.html#os.stat_result.st_mtime).411412Изменено в версии 3.9.17: может быть установлено в `None` для [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall), в результате чего извлечение пропускает применение этого атрибута.413414#### `TarInfo.mode: int`415416Биты прав доступа, как для [`os.chmod()`](https://python-all.ru/3.9/library/os.html#os.chmod).417418Изменено в версии 3.9.17: может быть установлено в `None` для [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall), в результате чего извлечение пропускает применение этого атрибута.419420#### `TarInfo.type`421422Тип файла. Обычно *type* – это одна из следующих констант: `REGTYPE`, `AREGTYPE`, `LNKTYPE`, `SYMTYPE`, `DIRTYPE`, `FIFOTYPE`, `CONTTYPE`, `CHRTYPE`, `BLKTYPE`, `GNUTYPE_SPARSE`. Чтобы более удобно определить тип объекта [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo), используйте методы `is*()`, описанные ниже.423424#### `TarInfo.linkname: str`425426Имя целевого файла, которое присутствует только в объектах [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) типов `LNKTYPE` и `SYMTYPE`.427428Для символических ссылок (`SYMTYPE`) значение *linkname* указывается относительно каталога, содержащего ссылку. Для жёстких ссылок (`LNKTYPE`) значение *linkname* указывается относительно корня архива.429430#### `TarInfo.uid: int`431432Идентификатор пользователя, который изначально сохранил этот элемент.433434Изменено в версии 3.9.17: может быть установлено в `None` для [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall), в результате чего извлечение пропускает применение этого атрибута.435436#### `TarInfo.gid: int`437438Идентификатор группы пользователя, который изначально сохранил этот элемент.439440Изменено в версии 3.9.17: Может быть установлено в `None` для [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall), в результате чего извлечение пропустит применение этого атрибута.441442#### `TarInfo.uname: str`443444Имя пользователя.445446Изменено в версии 3.9.17: Может быть установлено в `None` для [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall), в результате чего извлечение пропустит применение этого атрибута.447448#### `TarInfo.gname: str`449450Имя группы.451452Изменено в версии 3.9.17: Может быть установлено в `None` для [`extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall), в результате чего извлечение пропустит применение этого атрибута.453454#### `TarInfo.pax_headers: dict`455456Словарь, содержащий пары ключ-значение связанного расширенного заголовка pax.457458#### `TarInfo.replace(name=..., mtime=..., mode=..., linkname=...,`459460#### `uid=..., gid=..., uname=..., gname=...,`461462#### `deep=True)`463464Новое в версии 3.9.17.465466Возвращает *новую* копию объекта `TarInfo` с указанными изменёнными атрибутами. Например, чтобы вернуть `TarInfo` с именем группы, установленным в `'staff'`, используйте:467468```python469new_tarinfo = old_tarinfo.replace(gname='staff')470```471472По умолчанию создаётся глубокая копия. Если *deep* равен false, копия поверхностная, то есть `pax_headers` и любые пользовательские атрибуты являются общими с исходным объектом `TarInfo`.473474Объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo) также предоставляет несколько удобных запросных методов:475476#### `TarInfo.isfile()`477478Возвращает [`True`](https://python-all.ru/3.9/library/constants.html#True), если объект `Tarinfo` является обычным файлом.479480#### `TarInfo.isreg()`481482То же, что и [`isfile()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo.isfile).483484#### `TarInfo.isdir()`485486Возвращает [`True`](https://python-all.ru/3.9/library/constants.html#True), если это каталог.487488#### `TarInfo.issym()`489490Возвращает [`True`](https://python-all.ru/3.9/library/constants.html#True), если это символическая ссылка.491492#### `TarInfo.islnk()`493494Возвращает [`True`](https://python-all.ru/3.9/library/constants.html#True), если это жёсткая ссылка.495496#### `TarInfo.ischr()`497498Возвращает [`True`](https://python-all.ru/3.9/library/constants.html#True), если это символьное устройство.499500#### `TarInfo.isblk()`501502Возвращает [`True`](https://python-all.ru/3.9/library/constants.html#True), если это блочное устройство.503504#### `TarInfo.isfifo()`505506Возвращает [`True`](https://python-all.ru/3.9/library/constants.html#True), если это FIFO.507508#### `TarInfo.isdev()`509510Возвращает [`True`](https://python-all.ru/3.9/library/constants.html#True), если это символьное устройство, блочное устройство или FIFO.511512## Фильтры извлечения513514Новое в версии 3.9.17.515516Формат *tar* предназначен для сохранения всех деталей файловых систем UNIX-подобных ОС, что делает его очень мощным. К сожалению, эти возможности позволяют легко создавать tar-файлы, которые при извлечении могут иметь непреднамеренные – а возможно и вредоносные – эффекты. Например, извлечение tar-файла может перезаписать произвольные файлы различными способами (например, с использованием абсолютных путей, компонентов пути `..` или символических ссылок, влияющих на последующие элементы).517518В большинстве случаев полная функциональность не требуется. Поэтому *tarfile* поддерживает фильтры извлечения: механизм ограничения функциональности, что позволяет смягчить некоторые проблемы безопасности.519520> **См. также**521>522> **[**PEP 706**](https://python-all.ru/3.9/library/tarfile.html)**523>524> Содержит дополнительную мотивацию и обоснование дизайна.525526Аргумент *filter* для [`TarFile.extract()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extract) или [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall) может быть:527528- строка `'fully_trusted'`: соблюдать все метаданные, указанные в архиве. Следует использовать, если пользователь полностью доверяет архиву или реализует собственную сложную проверку.529- строка `'tar'`: соблюдать большинство специфических для *tar* возможностей (т.е. возможностей файловых систем UNIX-подобных ОС), но блокировать те, которые могут быть неожиданными или вредоносными. Подробнее см. [`tar_filter()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.tar_filter).530- строка `'data'`: игнорировать или блокировать большинство специфических для UNIX-подобных файловых систем возможностей. Предназначен для извлечения кроссплатформенных архивов. Подробнее см. [`data_filter()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.data_filter).531- `None` (по умолчанию): использовать [`TarFile.extraction_filter`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extraction_filter).532533 Если это также `None` (значение по умолчанию), будет использован фильтр `'fully_trusted'` (для совместимости с более ранними версиями Python).534535 В Python 3.12 значение по умолчанию будет выдавать `DeprecationWarning`.536537 В Python 3.14 фильтр `'data'` станет фильтром по умолчанию. Переключиться можно раньше; см. [`TarFile.extraction_filter`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extraction_filter).538- Вызываемый объект, который будет вызываться для каждого извлекаемого элемента с объектом [TarInfo](https://python-all.ru/3.9/library/tarfile.html#tarinfo-objects), описывающим элемент и путь назначения, куда извлекается архив (т.е. один и тот же путь используется для всех элементов):539540 ```python541 filter(/, member: TarInfo, path: str) -> TarInfo | None542 ```543544 Вызываемый объект вызывается непосредственно перед извлечением каждого элемента, поэтому он может учитывать текущее состояние диска. Он может:545546 - вернуть объект [`TarInfo`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo), который будет использоваться вместо метаданных в архиве, или547 - вернуть `None`, в этом случае элемент будет пропущен, или548 - вызвать исключение для прерывания операции или пропуска элемента, в зависимости от [`errorlevel`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.errorlevel). Обратите внимание, что при прерывании извлечения [`extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall) может оставить архив частично извлечённым. Он не пытается выполнить очистку.549550### Именованные фильтры по умолчанию551552Предопределённые именованные фильтры доступны как функции, поэтому их можно повторно использовать в пользовательских фильтрах:553554#### `tarfile.fully_trusted_filter(/, member, path)`555556Возвращает *элемент* без изменений.557558Это реализует фильтр `'fully_trusted'`.559560#### `tarfile.tar_filter(/, member, path)`561562Реализует фильтр `'tar'`.563564- Удаляет начальные слеши (`/` и [`os.sep`](https://python-all.ru/3.9/library/os.html#os.sep)) из имён файлов.565- [Отказывается](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы с абсолютными путями (если имя является абсолютным даже после удаления слешей, например `C:/foo` в Windows). Это вызывает [`AbsolutePathError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.AbsolutePathError).566- [Отказывается](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы, абсолютный путь которых (после разрешения симлинков) оказался бы за пределами целевой директории. Это вызывает [`OutsideDestinationError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.OutsideDestinationError).567- Очищает биты высоких режимов (setuid, setgid, sticky) и биты записи для группы и остальных (`S_IWOTH`).568569Возвращает изменённый элемент `TarInfo`.570571#### `tarfile.data_filter(/, member, path)`572573Реализует фильтр `'data'`. В дополнение к тому, что делает `tar_filter`:574575- Нормализует цели ссылок ([`TarInfo.linkname`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarInfo.linkname)) с помощью [`os.path.normpath()`](https://python-all.ru/3.9/library/os.path.html#os.path.normpath). Обратите внимание, что это удаляет внутренние компоненты `..`, что может изменить смысл ссылки, если путь в `TarInfo.linkname` проходит через символические ссылки.576- [Отказывается](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-refuse) извлекать ссылки (жёсткие или символические), которые указывают на абсолютные пути или ведут за пределы целевой директории.577578 Это вызывает [`AbsoluteLinkError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.AbsoluteLinkError) или [`LinkOutsideDestinationError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.LinkOutsideDestinationError).579580 Обратите внимание, что такие файлы отклоняются даже на платформах, не поддерживающих символические ссылки.581- [Отказывается](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы устройств (включая каналы). Это вызывает [`SpecialFileError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.SpecialFileError).582- Для обычных файлов, включая жёсткие ссылки:583584 - Устанавливает права на чтение и запись для владельца (`S_IWUSR`).585 - Удаляет право на выполнение для группы и остальных (`S_IXOTH`) если владелец не имеет его ([`S_IXUSR`](https://python-all.ru/3.9/library/stat.html#stat.S_IXUSR)).586- Для остальных файлов (каталогов) устанавливает `mode` в `None`, чтобы методы извлечения пропускали применение битов разрешений.587- Устанавливает информацию о пользователе и группе (`uid`, `gid`, `uname`, `gname`) в `None`, чтобы методы извлечения пропускали её установку.588589Возвращает изменённый элемент `TarInfo`.590591Изменено в версии 3.9.25 (не выпущена): Цели ссылок теперь нормализуются.592593### Ошибки фильтра594595Когда фильтр отказывается извлекать файл, он возбуждает соответствующее исключение, подкласс [`FilterError`](https://python-all.ru/3.9/library/tarfile.html#tarfile.FilterError). Это прервёт извлечение, если [`TarFile.errorlevel`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.errorlevel) равно 1 или больше. При `errorlevel=0` ошибка будет зарегистрирована, а элемент будет пропущен, но извлечение продолжится.596597### Рекомендации по дополнительной проверке598599Даже с `filter='data'`, *tarfile* не подходит для извлечения недоверенных файлов без предварительной проверки. Среди прочих проблем, предопределённые фильтры не предотвращают атаки типа «отказ в обслуживании». Пользователям следует проводить дополнительные проверки.600601Вот неполный список аспектов, которые стоит учесть:602603- Извлекайте в [`new temporary directory`](https://python-all.ru/3.9/library/tempfile.html#tempfile.mkdtemp), чтобы предотвратить, например, использование существующих ссылок, и упростить очистку после неудачного извлечения.604- Запретите символические ссылки, если эта функциональность не требуется.605- При работе с недоверенными данными используйте внешние (например, на уровне ОС) ограничения на использование диска, памяти и процессора.606- Проверяет имена файлов по списку разрешённых символов (для фильтрации управляющих символов, омоглифов, разделителей пути из других систем и т.д.).607- Проверяет, что имена файлов имеют ожидаемые расширения (чтобы предотвратить файлы, которые выполняются при «двойном клике», или файлы без расширения, такие как специальные имена устройств Windows).608- Ограничивает количество извлечённых файлов, общий объём извлечённых данных, длину имён файлов (включая длину символических ссылок) и размер отдельных файлов.609- Проверяет наличие файлов, которые будут затенены на файловых системах без учёта регистра.610611Также обратите внимание:612613- Tar-файлы могут содержать несколько версий одного и того же файла. Ожидается, что более поздние версии перезапишут любые предыдущие. Эта возможность критически важна для обновления ленточных архивов, но может быть злонамеренно использована.614- *tarfile* не защищает от проблем с «активными» данными, например, когда злоумышленник манипулирует целевым (или исходным) каталогом во время извлечения (или архивирования).615616### Поддержка старых версий Python617618Фильтры извлечения были добавлены в Python 3.12 и перенесены в более старые версии в качестве обновлений безопасности. Чтобы проверить, доступна ли эта возможность, используйте, например, `hasattr(tarfile, 'data_filter')`, а не проверку версии Python.619620Следующие примеры показывают, как поддерживать версии Python с этой возможностью и без неё. Обратите внимание, что установка `extraction_filter` повлияет на все последующие операции.621622- Полностью доверенный архив:623624 ```python625 my_tarfile.extraction_filter = (lambda member, path: member)626 my_tarfile.extractall()627 ```628- Используйте фильтр `'data'`, если он доступен, иначе вернитесь к поведению Python 3.11 (`'fully_trusted'`), если эта возможность недоступна:629630 ```python631 my_tarfile.extraction_filter = getattr(tarfile, 'data_filter',632 (lambda member, path: member))633 my_tarfile.extractall()634 ```635- Используйте фильтр `'data'`; *завершить ошибкой*, если он недоступен:636637 ```python638 my_tarfile.extractall(filter=tarfile.data_filter)639 ```640641 или:642643 ```python644 my_tarfile.extraction_filter = tarfile.data_filter645 my_tarfile.extractall()646 ```647- Используйте фильтр `'data'`; *предупредить*, если он недоступен:648649 ```python650 if hasattr(tarfile, 'data_filter'):651 my_tarfile.extractall(filter='data')652 else:653 # удалить, когда больше не нужно654 warn_the_user('Extracting may be unsafe; consider updating Python')655 my_tarfile.extractall()656 ```657658### Пример фильтра извлечения с состоянием659660Хотя методы извлечения *tarfile* принимают простой вызываемый объект *filter*, пользовательские фильтры могут быть более сложными объектами с внутренним состоянием. Может быть полезно реализовать их в виде контекстных менеджеров, чтобы использовать следующим образом:661662```python663with StatefulFilter() as filter_func:664 tar.extractall(path, filter=filter_func)665```666667Такой фильтр можно написать, например, так:668669```python670class StatefulFilter:671 def __init__(self):672 self.file_count = 0673674 def __enter__(self):675 return self676677 def __call__(self, member, path):678 self.file_count += 1679 return member680681 def __exit__(self, *exc_info):682 print(f'{self.file_count} files extracted')683```684685## Интерфейс командной строки686687Новое в версии 3.4.688689Модуль [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile) предоставляет простой интерфейс командной строки для работы с tar-архивами.690691Если вы хотите создать новый tar-архив, укажите его имя после опции [`-c`](https://python-all.ru/3.9/library/tarfile.html#cmdoption-tarfile-c), а затем перечислите имена файлов, которые должны быть включены:692693```console694$ python -m tarfile -c monty.tar spam.txt eggs.txt695```696697Можно также передать каталог:698699```console700$ python -m tarfile -c monty.tar life-of-brian_1979/701```702703Если вы хотите извлечь tar-архив в текущий каталог, используйте опцию [`-e`](https://python-all.ru/3.9/library/tarfile.html#cmdoption-tarfile-e):704705```console706$ python -m tarfile -e monty.tar707```708709Вы также можете извлечь tar-архив в другой каталог, передав его имя:710711```console712$ python -m tarfile -e monty.tar other-dir/713```714715Чтобы получить список файлов в tar-архиве, используйте опцию [`-l`](https://python-all.ru/3.9/library/tarfile.html#cmdoption-tarfile-l):716717```console718$ python -m tarfile -l monty.tar719```720721### Параметры командной строки722723#### `-l <tarfile>`724725#### `--list <tarfile>`726727Выводит список файлов в tar-архиве.728729#### `-c <tarfile> <source1> ... <sourceN>`730731#### `--create <tarfile> <source1> ... <sourceN>`732733Создаёт tar-архив из исходных файлов.734735#### `-e <tarfile> [<output_dir>]`736737#### `--extract <tarfile> [<output_dir>]`738739Извлекает tar-архив в текущий каталог, если *output\_dir* не указан.740741#### `-t <tarfile>`742743#### `--test <tarfile>`744745Проверяет, является ли tar-файл допустимым.746747#### `-v, --verbose`748749Подробный вывод.750751#### `--filter <filtername>`752753Указывает *фильтр* для `--extract`. Подробнее см. [Фильтры извлечения](https://python-all.ru/3.9/library/tarfile.html#tarfile-extraction-filter). Принимаются только строковые имена (то есть `fully_trusted`, `tar`, и `data`).754755Новое в версии 3.9.17.756757## Примеры758759Как извлечь полный tar-архив в текущий рабочий каталог:760761```python762import tarfile763tar = tarfile.open("sample.tar.gz")764tar.extractall()765tar.close()766```767768Как извлечь подмножество tar-архива с помощью [`TarFile.extractall()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.extractall), используя функцию-генератор вместо списка:769770```python771import os772import tarfile773774def py_files(members):775 for tarinfo in members:776 if os.path.splitext(tarinfo.name)[1] == ".py":777 yield tarinfo778779tar = tarfile.open("sample.tar.gz")780tar.extractall(members=py_files(tar))781tar.close()782```783784Как создать несжатый tar-архив из списка имён файлов:785786```python787import tarfile788tar = tarfile.open("sample.tar", "w")789for name in ["foo", "bar", "quux"]:790 tar.add(name)791tar.close()792```793794Тот же пример с использованием оператора [`with`](https://python-all.ru/3.9/reference/compound_stmts.html#with):795796```python797import tarfile798with tarfile.open("sample.tar", "w") as tar:799 for name in ["foo", "bar", "quux"]:800 tar.add(name)801```802803Как прочитать tar-архив, сжатый gzip, и вывести информацию о некоторых элементах:804805```python806import tarfile807tar = tarfile.open("sample.tar.gz", "r:gz")808for tarinfo in tar:809 print(tarinfo.name, "is", tarinfo.size, "bytes in size and is ", end="")810 if tarinfo.isreg():811 print("a regular file.")812 elif tarinfo.isdir():813 print("a directory.")814 else:815 print("something else.")816tar.close()817```818819Как создать архив и сбросить информацию о пользователе, используя параметр *фильтр* в [`TarFile.add()`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile.add):820821```python822import tarfile823def reset(tarinfo):824 tarinfo.uid = tarinfo.gid = 0825 tarinfo.uname = tarinfo.gname = "root"826 return tarinfo827tar = tarfile.open("sample.tar.gz", "w:gz")828tar.add("foo", filter=reset)829tar.close()830```831832## Поддерживаемые форматы tar833834Существует три формата tar, которые можно создать с помощью модуля [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile):835836- Формат POSIX.1-1988 ustar ([`USTAR_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.USTAR_FORMAT)). Он поддерживает имена файлов длиной не более 256 символов и имена ссылок – до 100 символов. Максимальный размер файла – 8 ГиБ. Это старый и ограниченный, но широко поддерживаемый формат.837- Формат GNU tar ([`GNU_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.GNU_FORMAT)). Он поддерживает длинные имена файлов и ссылок, файлы размером более 8 ГиБ и разрежённые файлы. Это де-факто стандарт в системах GNU/Linux. [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile) полностью поддерживает расширения GNU tar для длинных имён; поддержка разрежённых файлов – только для чтения.838- Формат POSIX.1-2001 pax ([`PAX_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.PAX_FORMAT)). Это наиболее гибкий формат, практически без ограничений. Он поддерживает длинные имена файлов и ссылок, большие файлы и сохраняет пути переносимым способом. Современные реализации tar, включая GNU tar, bsdtar/libarchive и star, полностью поддерживают расширенные возможности *pax*; некоторые старые или неподдерживаемые библиотеки могут не поддерживать, но должны обрабатывать архивы *pax* так, как если бы они были в универсально поддерживаемом формате *ustar*. Это текущий формат по умолчанию для новых архивов.839840 Он расширяет существующий формат *ustar* дополнительными заголовками для информации, которую иначе нельзя сохранить. Существует две разновидности заголовков pax: расширенные заголовки влияют только на последующий заголовок файла, глобальные заголовки действительны для всего архива и влияют на все последующие файлы. Все данные в заголовке pax кодируются в *UTF-8* по соображениям переносимости.841842Существуют ещё некоторые варианты формата tar, которые можно читать, но не создавать:843844- Древний формат V7. Это первый формат tar из Unix Seventh Edition, хранящий только обычные файлы и каталоги. Имена не должны быть длиннее 100 символов, информация об имени пользователя/группы отсутствует. Некоторые архивы имеют неправильные контрольные суммы заголовков в случае полей с не-ASCII символами.845- Расширенный формат SunOS tar. Этот формат является вариантом формата POSIX.1-2001 pax, но несовместим с ним.846847## Проблемы Unicode848849Формат tar изначально был задуман для создания резервных копий на ленточных накопителях с основным упором на сохранение информации о файловой системе. Сегодня tar-архивы обычно используются для распространения файлов и обмена архивами по сетям. Одна проблема исходного формата (который является основой всех других форматов) заключается в том, что нет концепции поддержки разных кодировок символов. Например, обычный tar-архив, созданный в системе с *UTF-8*, не может быть корректно прочитан в системе с *Latin-1*, если он содержит символы, отличные от *ASCII*. Текстовые метаданные (например, имена файлов, имена ссылок, имена пользователей/групп) будут повреждены. К сожалению, нет способа автоматически определить кодировку архива. Формат pax был разработан для решения этой проблемы. Он хранит не-ASCII метаданные, используя универсальную кодировку символов *UTF-8*.850851Детали преобразования символов в [`tarfile`](https://python-all.ru/3.9/library/tarfile.html#module-tarfile) управляются ключевыми аргументами *encoding* и *errors* класса [`TarFile`](https://python-all.ru/3.9/library/tarfile.html#tarfile.TarFile).852853*encoding* определяет кодировку символов, используемую для метаданных в архиве. Значение по умолчанию – [`sys.getfilesystemencoding()`](https://python-all.ru/3.9/library/sys.html#sys.getfilesystemencoding) или `'ascii'` в качестве запасного варианта. В зависимости от того, читается или записывается архив, метаданные должны быть либо декодированы, либо закодированы. Если *encoding* не установлена соответствующим образом, это преобразование может завершиться ошибкой.854855Аргумент *errors* определяет, как обрабатываются символы, которые невозможно преобразовать. Возможные значения перечислены в разделе [Обработчики ошибок](https://python-all.ru/3.9/library/codecs.html#error-handlers). Схема по умолчанию – `'surrogateescape'`, которую Python также использует для своих системных вызовов, см. [Имена файлов, аргументы командной строки и переменные окружения](https://python-all.ru/3.9/library/os.html#os-filenames).856857Для архивов [`PAX_FORMAT`](https://python-all.ru/3.9/library/tarfile.html#tarfile.PAX_FORMAT) (по умолчанию) *encoding* обычно не требуется, потому что все метаданные хранятся с использованием *UTF-8*. *encoding* используется только в редких случаях, когда декодируются бинарные заголовки pax или когда хранятся строки с суррогатными символами.858