`tarfile.md`

844 строк · 79.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.8/library/tarfile.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile) – Чтение и запись файлов tar-архивов89**Исходный код:** [Lib/tarfile.py](https://python-all.ru/src/3.8/Lib/tarfile.py)1011---1213Модуль [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile) позволяет читать и записывать tar-архивы, в том числе сжатые gzip, bz2 и lzma. Используйте модуль [`zipfile`](https://python-all.ru/3.8/library/zipfile.html#module-zipfile) для чтения и записи файлов `.zip` или функции более высокого уровня из [shutil](https://python-all.ru/3.8/library/shutil.html#archiving-operations).1415Некоторые факты и цифры:1617- читает и записывает сжатые архивы [`gzip`](https://python-all.ru/3.8/library/gzip.html#module-gzip), [`bz2`](https://python-all.ru/3.8/library/bz2.html#module-bz2) и [`lzma`](https://python-all.ru/3.8/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.8/library/lzma.html#module-lzma).2425#### `tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)`2627Возвращает объект [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile) для имени пути *name*. Подробную информацию об объектах [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile) и допустимых именованных аргументах см. в разделе [Объекты TarFile](https://python-all.ru/3.8/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.8/library/exceptions.html#FileExistsError), если файл уже существует. |39| `'x:gz'` | Создаёт tar-файл со сжатием gzip. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.8/library/exceptions.html#FileExistsError), если файл уже существует. |40| `'x:bz2'` | Создаёт tar-файл со сжатием bzip2. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.8/library/exceptions.html#FileExistsError), если файл уже существует. |41| `'x:xz'` | Создаёт tar-файл со сжатием lzma. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.8/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.8/library/tarfile.html#tarfile.ReadError). Используйте *режим* `'r'`, чтобы избежать этого. Если метод сжатия не поддерживается, возбуждается [`CompressionError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.CompressionError).4950Если указан *fileobj*, он используется вместо [файлового объекта](https://python-all.ru/3.8/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.8/library/tarfile.html#tarfile.open) принимает именованный аргумент *compresslevel* (по умолчанию `9`) для указания уровня сжатия файла.5354Для специальных целей существует второй формат для *mode*: `'filemode|[compression]'`. [`tarfile.open()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.open) вернёт объект [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile), который обрабатывает данные как поток блоков. Поиск по файлу с произвольным доступом не выполняется. Если задан *fileobj*, это может быть любой объект с методами `read()` или `write()` (в зависимости от *mode*). *bufsize* задаёт размер блока; по умолчанию `20 * 512` байт. Используйте этот вариант в сочетании, например, с `sys.stdin`, сокетным [файловым объектом](https://python-all.ru/3.8/glossary.html#term-file-object) или ленточным устройством. Однако такой объект [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile) ограничен тем, что не допускает произвольный доступ – см. [Примеры](https://python-all.ru/3.8/library/tarfile.html#tar-examples). Возможные режимы на текущий момент:5556| Режим | Действие |57| --- | --- |58| `'r\|*'` | Открывает *поток данных* tar-блоков для чтения с прозрачным сжатием. |59| `'r\|'` | Открывает *поток данных* несжатых tar-блоков для чтения. |60| `'r\|gz'` | Открывает сжатый gzip *поток данных* для чтения. |61| `'r\|bz2'` | Открывает сжатый bzip2 *поток данных* для чтения. |62| `'r\|xz'` | Открывает сжатый lzma *поток данных* для чтения. |63| `'w\|'` | Открывает несжатый *поток данных* для записи. |64| `'w\|gz'` | Открывает сжатый gzip *поток данных* для записи. |65| `'w\|bz2'` | Открывает сжатый bzip2 *поток данных* для записи. |66| `'w\|xz'` | Открывает сжатый lzma *поток данных* для записи. |6768Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание).6970Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.8/glossary.html#term-path-like-object).7172#### `class tarfile.TarFile`7374Класс для чтения и записи tar-архивов. Не используйте этот класс напрямую: вместо него используйте [`tarfile.open()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.open). См. [Объекты TarFile](https://python-all.ru/3.8/library/tarfile.html#tarfile-objects).7576#### `tarfile.is_tarfile(name)`7778Возвращает [`True`](https://python-all.ru/3.8/library/constants.html#True), если *name* является tar-архивом, который может прочитать модуль [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile).7980Модуль [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile) определяет следующие исключения:8182#### `exception tarfile.TarError`8384Базовый класс для всех исключений [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile).8586#### `exception tarfile.ReadError`8788Возникает при открытии tar-архива, который не может быть обработан модулем [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile) или является некорректным.8990#### `exception tarfile.CompressionError`9192Возникает, когда метод сжатия не поддерживается или данные не удаётся корректно декодировать.9394#### `exception tarfile.StreamError`9596Возникает при ограничениях, типичных для объектов, работающих в режиме потока [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile).9798#### `exception tarfile.ExtractError`99100Возникает при *нефатальных* ошибках при использовании [`TarFile.extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract), но только если [`TarFile.errorlevel`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.errorlevel)`== 2`.101102#### `exception tarfile.HeaderError`103104Возникает при вызове [`TarInfo.frombuf()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo.frombuf), если полученный буфер некорректен.105106#### `exception tarfile.FilterError`107108Базовый класс для элементов, [отклонённых](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-refuse) фильтрами.109110#### `tarinfo`111112Информация об элементе, который фильтр отказался извлекать, в виде [TarInfo](https://python-all.ru/3.8/library/tarfile.html#tarinfo-objects).113114#### `exception tarfile.AbsolutePathError`115116Возникает при отказе извлекать элемент с абсолютным путём.117118#### `exception tarfile.OutsideDestinationError`119120Возникает при отказе извлекать элемент за пределами целевого каталога.121122#### `exception tarfile.SpecialFileError`123124Возникает при отказе извлекать специальный файл (например, устройство или канал).125126#### `exception tarfile.AbsoluteLinkError`127128Возникает при отказе извлекать символическую ссылку с абсолютным путём.129130#### `exception tarfile.LinkOutsideDestinationError`131132Возникает при отказе извлекать символическую ссылку, указывающую за пределы целевого каталога.133134На уровне модуля доступны следующие константы:135136#### `tarfile.ENCODING`137138Кодировка символов по умолчанию: `'utf-8'` в Windows, значение, возвращаемое [`sys.getfilesystemencoding()`](https://python-all.ru/3.8/library/sys.html#sys.getfilesystemencoding) в остальных случаях.139140Каждая из следующих констант определяет формат tar-архива, который модуль [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile) может создавать. Подробнее см. раздел [Поддерживаемые форматы tar](https://python-all.ru/3.8/library/tarfile.html#tar-formats) для получения подробностей.141142#### `tarfile.USTAR_FORMAT`143144Формат POSIX.1-1988 (ustar).145146#### `tarfile.GNU_FORMAT`147148Формат GNU tar.149150#### `tarfile.PAX_FORMAT`151152Формат POSIX.1-2001 (pax).153154#### `tarfile.DEFAULT_FORMAT`155156Формат по умолчанию для создания архивов. В настоящее время это [`PAX_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.PAX_FORMAT).157158Изменено в версии 3.8: Формат по умолчанию для новых архивов был изменён на [`PAX_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.PAX_FORMAT) с [`GNU_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.GNU_FORMAT).159160> **См. также**161>162> **Модуль [`zipfile`](https://python-all.ru/3.8/library/zipfile.html#module-zipfile)**163>164> Документация стандартного модуля [`zipfile`](https://python-all.ru/3.8/library/zipfile.html#module-zipfile).165>166> **[Операции архивирования](https://python-all.ru/3.8/library/shutil.html#archiving-operations)**167>168> Документация средств архивирования высокого уровня, предоставляемых стандартным модулем [`shutil`](https://python-all.ru/3.8/library/shutil.html#module-shutil).169>170> **[Руководство GNU tar, базовый формат tar](https://python-all.ru/3.8/library/tarfile.html)**171>172> Документация для файлов архивов tar, включая расширения GNU tar.173174## Объекты TarFile175176Объект [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile) предоставляет интерфейс к архиву tar. Архив tar представляет собой последовательность блоков. Элемент архива (хранимый файл) состоит из заголовочного блока, за которым следуют блоки данных. Файл можно сохранить в архив tar несколько раз. Каждый элемент архива представляется объектом [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo), подробнее см. [Объекты TarInfo](https://python-all.ru/3.8/library/tarfile.html#tarinfo-objects).177178Объект [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile) можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3.8/reference/compound_stmts.html#with). Он будет автоматически закрыт по завершении блока. Обратите внимание: в случае исключения архив, открытый для записи, не будет финализирован; будет закрыт только внутренний файловый объект. Пример использования см. в разделе [Примеры](https://python-all.ru/3.8/library/tarfile.html#tar-examples).179180Новое в версии 3.2: Добавлена поддержка протокола менеджера контекста.181182#### `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)`183184Все последующие аргументы необязательны и также могут быть доступны как атрибуты экземпляра.185186*name* – это путь к архиву. *name* может быть [объектом, подобным пути](https://python-all.ru/3.8/glossary.html#term-path-like-object). Его можно опустить, если указан *fileobj*. В этом случае используется атрибут файлового объекта `name`, если он существует.187188*mode* может быть `'r'` для чтения из существующего архива, `'a'` для добавления данных в существующий файл, `'w'` для создания нового файла с перезаписью существующего или `'x'` для создания нового файла только в том случае, если он ещё не существует.189190Если указан *fileobj*, он используется для чтения или записи данных. Если это можно определить, *mode* переопределяется режимом *fileobj*. *fileobj* будет использоваться с позиции 0.191192> **Примечание**193>194> *fileobj* не закрывается при закрытии [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile).195196*format* управляет форматом архива для записи. Он должен быть одной из констант [`USTAR_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.USTAR_FORMAT), [`GNU_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.GNU_FORMAT) или [`PAX_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.PAX_FORMAT), определённых на уровне модуля. При чтении формат будет определён автоматически, даже если в одном архиве присутствуют разные форматы.197198Аргумент *tarinfo* можно использовать для замены класса по умолчанию [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) на другой.199200Если *dereference* равно [`False`](https://python-all.ru/3.8/library/constants.html#False), в архив добавляются символические и жёсткие ссылки. Если [`True`](https://python-all.ru/3.8/library/constants.html#True), в архив добавляется содержимое целевых файлов. Это не влияет на системы, не поддерживающие символические ссылки.201202Если *ignore\_zeros* равно [`False`](https://python-all.ru/3.8/library/constants.html#False), пустой блок считается концом архива. Если [`True`](https://python-all.ru/3.8/library/constants.html#True), пустые (и недействительные) блоки пропускаются, и предпринимается попытка получить как можно больше элементов. Это полезно только для чтения объединённых или повреждённых архивов.203204*debug* может быть установлен от `0` (нет отладочных сообщений) до `3` (все отладочные сообщения). Сообщения записываются в `sys.stderr`.205206*errorlevel* управляет обработкой ошибок извлечения, см. `the corresponding attribute`.207208Аргументы *encoding* и *errors* определяют кодировку символов, используемую для чтения или записи архива, и способ обработки ошибок преобразования. Настройки по умолчанию подходят для большинства пользователей. Подробную информацию см. в разделе [Проблемы Unicode](https://python-all.ru/3.8/library/tarfile.html#tar-unicode).209210Аргумент *pax\_headers* – необязательный словарь строк, который будет добавлен как глобальный заголовок pax, если *format* равно [`PAX_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.PAX_FORMAT).211212Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`.213214Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание).215216Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.8/glossary.html#term-path-like-object).217218#### `classmethod TarFile.open(...)`219220Альтернативный конструктор. Функция [`tarfile.open()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.open) на самом деле является сокращением для этого метода класса.221222#### `TarFile.getmember(name)`223224Возвращает объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) для элемента *name*. Если *name* не найден в архиве, возбуждается [`KeyError`](https://python-all.ru/3.8/library/exceptions.html#KeyError).225226> **Примечание**227>228> Если элемент встречается в архиве более одного раза, последнее его вхождение считается самой актуальной версией.229230#### `TarFile.getmembers()`231232Возвращает элементы архива в виде списка объектов [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo). Порядок списка соответствует порядку элементов в архиве.233234#### `TarFile.getnames()`235236Возвращает элементы в виде списка их имён. Порядок списка соответствует порядку списка, возвращаемого [`getmembers()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.getmembers).237238#### `TarFile.list(verbose=True, *, members=None)`239240Выводит оглавление в `sys.stdout`. Если *verbose* равно [`False`](https://python-all.ru/3.8/library/constants.html#False), печатаются только имена элементов. Если же [`True`](https://python-all.ru/3.8/library/constants.html#True), выводятся данные, аналогичные **ls -l**. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.getmembers).241242Изменено в версии 3.5: Добавлен параметр *members*.243244#### `TarFile.next()`245246Возвращает следующий элемент архива в виде объекта [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo), когда [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile) открыт для чтения. Если больше нет элементов, возвращает [`None`](https://python-all.ru/3.8/library/constants.html#None).247248#### `TarFile.extractall(path=".", members=None, *, numeric_owner=False, filter=None)`249250Извлекает все элементы из архива в текущую рабочую директорию или в директорию *path*. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.getmembers). Сведения о директории (владелец, время изменения, права доступа) устанавливаются после извлечения всех элементов. Это сделано для обхода двух проблем: время изменения директории сбрасывается при каждом создании в ней файла, и если права директории не разрешают запись, извлечение в неё файлов завершится ошибкой.251252Если *numeric\_owner* равно [`True`](https://python-all.ru/3.8/library/constants.html#True), для установки владельца и группы извлечённых файлов используются числовые uid и gid из tar-файла. В противном случае используются именованные значения из tar-файла.253254Аргумент *filter*, добавленный в Python 3.8.17, определяет, как `members` изменяются или отклоняются перед извлечением. Подробнее см. [Фильтры извлечения](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-filter). Рекомендуется явно задавать этот аргумент в зависимости от того, какие возможности *tar* необходимо поддерживать.255256> **Предупреждение**257>258> Никогда не извлекайте архивы из ненадёжных источников без предварительной проверки. Возможно создание файлов за пределами *path*, например, элементов с абсолютными именами, начинающимися с `"/"`, или с именами, содержащими две точки `".."`.259>260> Установите `filter='data'`, чтобы предотвратить наиболее опасные проблемы безопасности, и прочитайте раздел [Extraction filters](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-filter) для подробностей.261262Изменено в версии 3.5: Добавлен параметр *numeric\_owner*.263264Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3.8/glossary.html#term-path-like-object).265266Изменено в версии 3.8.17: Добавлен параметр *filter*.267268#### `TarFile.extract(member, path="", set_attrs=True, *, numeric_owner=False, filter=None)`269270Извлекает элемент из архива в текущую рабочую директорию, используя его полное имя. Информация о файле извлекается максимально точно. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo). Можно указать другую директорию с помощью *path*. *path* может быть [объектом, подобным пути](https://python-all.ru/3.8/glossary.html#term-path-like-object). Атрибуты файла (владелец, mtime, права доступа) устанавливаются, если *set\_attrs* не равно false.271272Аргументы *numeric\_owner* и *filter* такие же, как для [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall).273274> **Примечание**275>276> Метод [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) не решает ряд проблем извлечения. В большинстве случаев стоит рассмотреть использование метода [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall).277278> **Предупреждение**279>280> См. предупреждение для [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall).281>282> Установите `filter='data'`, чтобы предотвратить наиболее опасные проблемы безопасности, и прочитайте раздел [Extraction filters](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-filter) для подробностей.283284Изменено в версии 3.2: Добавлен параметр *set\_attrs*.285286Изменено в версии 3.5: Добавлен параметр *numeric\_owner*.287288Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3.8/glossary.html#term-path-like-object).289290Изменено в версии 3.8.17: Добавлен параметр *filter*.291292#### `TarFile.extractfile(member)`293294Извлекает элемент архива в виде файлового объекта. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo). Если *member* является обычным файлом или ссылкой, возвращается объект [`io.BufferedReader`](https://python-all.ru/3.8/library/io.html#io.BufferedReader). В противном случае возвращается [`None`](https://python-all.ru/3.8/library/constants.html#None).295296Изменено в версии 3.3: Возвращается объект [`io.BufferedReader`](https://python-all.ru/3.8/library/io.html#io.BufferedReader).297298#### `TarFile.errorlevel: int`299300Если *errorlevel* равен `0`, ошибки игнорируются при использовании [`TarFile.extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) и [`TarFile.extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall). Тем не менее, они отображаются как сообщения об ошибках в отладочном выводе, когда *debug* больше 0. Если `1` (по умолчанию), все *фатальные* ошибки вызываются как исключения [`OSError`](https://python-all.ru/3.8/library/exceptions.html#OSError) или [`FilterError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.FilterError). Если `2`, все *нефатальные* ошибки также вызываются как исключения [`TarError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarError).301302Некоторые исключения, например, вызванные неправильными типами аргументов или повреждением данных, всегда вызываются.303304Пользовательские [фильтры извлечения](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-filter) должны вызывать [`FilterError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.FilterError) для *фатальных* ошибок и [`ExtractError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.ExtractError) для *нефатальных*.305306Обратите внимание, что при возникновении исключения архив может быть извлечён частично. Ответственность за очистку лежит на пользователе.307308#### `TarFile.extraction_filter`309310Новое в версии 3.8.17.311312[Фильтр извлечения](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-filter), используемый по умолчанию для аргумента *filter* методов [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall).313314Атрибут может быть `None` или вызываемым объектом. Строковые имена для этого атрибута не допускаются, в отличие от аргумента *filter* для [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract).315316Если `extraction_filter` равен `None` (значение по умолчанию), вызов метода извлечения без аргумента *filter* приведёт к использованию фильтра [`fully_trusted`](https://python-all.ru/3.8/library/tarfile.html#tarfile.fully_trusted_filter) для совместимости с предыдущими версиями Python.317318В Python 3.12+ оставление `extraction_filter=None` вызовет `DeprecationWarning`.319320Начиная с Python 3.14, если оставить `extraction_filter=None`, методы извлечения по умолчанию будут использовать фильтр [`data`](https://python-all.ru/3.8/library/tarfile.html#tarfile.data_filter).321322Атрибут может быть установлен для экземпляров или переопределён в подклассах. Также возможно установить его для самого класса `TarFile`, чтобы задать глобальное значение по умолчанию; однако, поскольку это влияет на все случаи использования *tarfile*, лучшей практикой будет делать это только в приложениях верхнего уровня или [`site configuration`](https://python-all.ru/3.8/library/site.html#module-site). Чтобы задать глобальное значение по умолчанию таким образом, функцию фильтра необходимо обернуть в [`staticmethod()`](https://python-all.ru/3.8/library/functions.html#staticmethod), чтобы предотвратить внедрение аргумента `self`.323324#### `TarFile.add(name, arcname=None, recursive=True, *, filter=None)`325326Добавляет файл *name* в архив. *name* может быть любым типом файла (каталог, FIFO, символическая ссылка и т.д.). Если задан, *arcname* указывает альтернативное имя файла в архиве. Каталоги добавляются рекурсивно по умолчанию. Этого можно избежать, установив *recursive* в [`False`](https://python-all.ru/3.8/library/constants.html#False). Рекурсия добавляет записи в отсортированном порядке. Если задан *filter*, он должен быть функцией, которая принимает аргумент объекта [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) и возвращает изменённый объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo). Если же она возвращает [`None`](https://python-all.ru/3.8/library/constants.html#None), объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) будет исключён из архива. Пример см. в [Примерах](https://python-all.ru/3.8/library/tarfile.html#tar-examples).327328Изменено в версии 3.2: Добавлен параметр *filter*.329330Изменено в версии 3.7: Рекурсия добавляет записи в отсортированном порядке.331332#### `TarFile.addfile(tarinfo, fileobj=None)`333334Добавляет объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) *tarinfo* в архив. Если указан *fileobj*, он должен быть [двоичным файлом](https://python-all.ru/3.8/glossary.html#term-binary-file), из которого читаются `tarinfo.size` байтов и добавляются в архив. Можно создавать объекты [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) напрямую или с помощью [`gettarinfo()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.gettarinfo).335336#### `TarFile.gettarinfo(name=None, arcname=None, fileobj=None)`337338Создаёт объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) из результата [`os.stat()`](https://python-all.ru/3.8/library/os.html#os.stat) или эквивалентного для существующего файла. Файл задаётся либо именем *name*, либо указывается как [файловый объект](https://python-all.ru/3.8/glossary.html#term-file-object) *fileobj* с файловым дескриптором. *name* может быть [объектом, подобным пути](https://python-all.ru/3.8/glossary.html#term-path-like-object). Если задан, *arcname* указывает альтернативное имя файла в архиве; в противном случае имя берётся из атрибута [`name`](https://python-all.ru/3.8/library/io.html#io.FileIO.name) объекта *fileobj* или из аргумента *name*. Имя должно быть текстовой строкой.339340Можно изменить некоторые атрибуты объекта [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) перед его добавлением с помощью [`addfile()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.addfile). Если файловый объект не является обычным файловым объектом, расположенным в начале файла, такие атрибуты, как [`size`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo.size), могут потребовать изменения. Это относится к таким объектам, как [`GzipFile`](https://python-all.ru/3.8/library/gzip.html#gzip.GzipFile). Атрибут [`name`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo.name) также может быть изменён, и в этом случае *arcname* может быть фиктивной строкой.341342Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.8/glossary.html#term-path-like-object).343344#### `TarFile.close()`345346Закрывает [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile). В режиме записи в архив добавляются два завершающих нулевых блока.347348#### `TarFile.pax_headers`349350Словарь, содержащий пары ключ-значение глобальных заголовков pax.351352## Объекты TarInfo353354Объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) представляет один элемент в [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile). Помимо хранения всех необходимых атрибутов файла (таких как тип, размер, время, права доступа, владелец и т.д.), он предоставляет некоторые полезные методы для определения его типа. Он *не* содержит сами данные файла.355356Объекты [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) возвращаются методами [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile): [`getmember()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.getmember), [`getmembers()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.getmembers) и [`gettarinfo()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.gettarinfo).357358Изменение объектов, возвращённых методами `getmember()` или `getmembers()`, повлияет на все последующие операции с архивом. В случаях, когда это нежелательно, можно использовать [`copy.copy()`](https://python-all.ru/3.8/library/copy.html#module-copy) или вызвать метод `replace()`, чтобы создать изменённую копию за один шаг.359360Некоторые атрибуты могут быть установлены в `None`, чтобы указать, что часть метаданных не используется или неизвестна. Разные методы [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) обрабатывают `None` по-разному:361362- Методы [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall) будут игнорировать соответствующие метаданные, оставляя их установленными по умолчанию.363- [`addfile()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.addfile) завершится ошибкой.364- [`list()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.list) выведет строку-заполнитель.365366Изменено в версии 3.8.17: Добавлены `replace()` и обработка `None`.367368#### `class tarfile.TarInfo(name="")`369370Создаёт объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo).371372#### `classmethod TarInfo.frombuf(buf, encoding, errors)`373374Создаёт и возвращает объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) из строкового буфера *buf*.375376Вызывает [`HeaderError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.HeaderError), если буфер некорректен.377378#### `classmethod TarInfo.fromtarfile(tarfile)`379380Читает следующий элемент из объекта [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile) *tarfile* и возвращает его в виде объекта [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo).381382#### `TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')`383384Создаёт строковый буфер из объекта [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo). Подробнее об аргументах см. конструктор класса [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile).385386Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`.387388Объект `TarInfo` имеет следующие открытые атрибуты данных:389390#### `TarInfo.name: str`391392Имя элемента архива.393394#### `TarInfo.size: int`395396Размер в байтах.397398#### `TarInfo.mtime: int | float`399400Время последнего изменения в секундах с [начала эпохи](https://python-all.ru/3.8/library/time.html#epoch), как в [`os.stat_result.st_mtime`](https://python-all.ru/3.8/library/os.html#os.stat_result.st_mtime).401402Изменено в версии 3.8.17: Может быть установлено в `None` для [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута при извлечении.403404#### `TarInfo.mode: int`405406Биты прав доступа, как для [`os.chmod()`](https://python-all.ru/3.8/library/os.html#os.chmod).407408Изменено в версии 3.8.17: Может быть установлено в `None` для [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута при извлечении.409410#### `TarInfo.type`411412Тип файла. Обычно *type* – это одна из следующих констант: `REGTYPE`, `AREGTYPE`, `LNKTYPE`, `SYMTYPE`, `DIRTYPE`, `FIFOTYPE`, `CONTTYPE`, `CHRTYPE`, `BLKTYPE`, `GNUTYPE_SPARSE`. Чтобы более удобно определить тип объекта [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo), используйте методы `is*()`, описанные ниже.413414#### `TarInfo.linkname: str`415416Имя целевого файла, которое присутствует только в объектах [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) типов `LNKTYPE` и `SYMTYPE`.417418Для символических ссылок (`SYMTYPE`) значение *linkname* указывается относительно каталога, содержащего ссылку. Для жёстких ссылок (`LNKTYPE`) значение *linkname* указывается относительно корня архива.419420#### `TarInfo.uid: int`421422Идентификатор пользователя, который изначально сохранил этот элемент.423424Изменено в версии 3.8.17: Может быть установлено в `None` для [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута при извлечении.425426#### `TarInfo.gid: int`427428Идентификатор группы пользователя, который изначально сохранил этот элемент.429430Изменено в версии 3.8.17: Может быть установлено в `None` для [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall), в результате чего извлечение будет пропускать применение этого атрибута.431432#### `TarInfo.uname: str`433434Имя пользователя.435436Изменено в версии 3.8.17: Может быть установлено в `None` для [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall), в результате чего извлечение будет пропускать применение этого атрибута.437438#### `TarInfo.gname: str`439440Имя группы.441442Изменено в версии 3.8.17: Может быть установлено в `None` для [`extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall), в результате чего извлечение будет пропускать применение этого атрибута.443444#### `TarInfo.pax_headers: dict`445446Словарь, содержащий пары ключ-значение связанного расширенного заголовка pax.447448#### `TarInfo.replace(name=..., mtime=..., mode=..., linkname=...,`449450#### `uid=..., gid=..., uname=..., gname=...,`451452#### `deep=True)`453454Новое в версии 3.8.17.455456Возвращает *новую* копию объекта `TarInfo` с указанными изменёнными атрибутами. Например, чтобы вернуть `TarInfo` с именем группы, установленным в `'staff'`, используйте:457458```python459new_tarinfo = old_tarinfo.replace(gname='staff')460```461462По умолчанию создаётся глубокая копия. Если *deep* равен false, копия поверхностная, то есть `pax_headers` и любые пользовательские атрибуты являются общими с исходным объектом `TarInfo`.463464Объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo) также предоставляет несколько удобных запросных методов:465466#### `TarInfo.isfile()`467468Возвращает [`True`](https://python-all.ru/3.8/library/constants.html#True), если объект `Tarinfo` является обычным файлом.469470#### `TarInfo.isreg()`471472То же, что и [`isfile()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo.isfile).473474#### `TarInfo.isdir()`475476Возвращает [`True`](https://python-all.ru/3.8/library/constants.html#True), если это каталог.477478#### `TarInfo.issym()`479480Возвращает [`True`](https://python-all.ru/3.8/library/constants.html#True), если это символическая ссылка.481482#### `TarInfo.islnk()`483484Возвращает [`True`](https://python-all.ru/3.8/library/constants.html#True), если это жёсткая ссылка.485486#### `TarInfo.ischr()`487488Возвращает [`True`](https://python-all.ru/3.8/library/constants.html#True), если это символьное устройство.489490#### `TarInfo.isblk()`491492Возвращает [`True`](https://python-all.ru/3.8/library/constants.html#True), если это блочное устройство.493494#### `TarInfo.isfifo()`495496Возвращает [`True`](https://python-all.ru/3.8/library/constants.html#True), если это FIFO.497498#### `TarInfo.isdev()`499500Возвращает [`True`](https://python-all.ru/3.8/library/constants.html#True), если это символьное устройство, блочное устройство или FIFO.501502## Фильтры извлечения503504Новое в версии 3.8.17.505506Формат *tar* предназначен для сохранения всех деталей файловых систем UNIX-подобных ОС, что делает его очень мощным. К сожалению, эти возможности позволяют легко создавать tar-файлы, которые при извлечении могут иметь непреднамеренные – а возможно и вредоносные – эффекты. Например, извлечение tar-файла может перезаписать произвольные файлы различными способами (например, с использованием абсолютных путей, компонентов пути `..` или символических ссылок, влияющих на последующие элементы).507508В большинстве случаев полная функциональность не требуется. Поэтому *tarfile* поддерживает фильтры извлечения: механизм ограничения функциональности, что позволяет смягчить некоторые проблемы безопасности.509510> **См. также**511>512> **[**PEP 706**](https://python-all.ru/3.8/library/tarfile.html)**513>514> Содержит дополнительную мотивацию и обоснование дизайна.515516Аргумент *filter* для [`TarFile.extract()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extract) или [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall) может быть:517518- строка `'fully_trusted'`: соблюдать все метаданные, указанные в архиве. Следует использовать, если пользователь полностью доверяет архиву или реализует собственную сложную проверку.519- строка `'tar'`: соблюдать большинство специфических для *tar* возможностей (т.е. возможностей файловых систем UNIX-подобных ОС), но блокировать те, которые могут быть неожиданными или вредоносными. Подробнее см. [`tar_filter()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.tar_filter).520- строка `'data'`: игнорировать или блокировать большинство специфических для UNIX-подобных файловых систем возможностей. Предназначен для извлечения кроссплатформенных архивов. Подробнее см. [`data_filter()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.data_filter).521- `None` (по умолчанию): использовать [`TarFile.extraction_filter`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extraction_filter).522523  Если это также `None` (значение по умолчанию), будет использован фильтр `'fully_trusted'` (для совместимости с более ранними версиями Python).524525  В Python 3.12 значение по умолчанию будет выдавать `DeprecationWarning`.526527  В Python 3.14 фильтр `'data'` станет фильтром по умолчанию. Переключиться можно раньше; см. [`TarFile.extraction_filter`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extraction_filter).528- Вызываемый объект, который будет вызываться для каждого извлекаемого элемента с объектом [TarInfo](https://python-all.ru/3.8/library/tarfile.html#tarinfo-objects), описывающим элемент и путь назначения, куда извлекается архив (т.е. один и тот же путь используется для всех элементов):529530  ```python531  filter(/, member: TarInfo, path: str) -> TarInfo | None532  ```533534  Вызываемый объект вызывается непосредственно перед извлечением каждого элемента, поэтому он может учитывать текущее состояние диска. Он может:535536  - вернуть объект [`TarInfo`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarInfo), который будет использоваться вместо метаданных в архиве, или537  - вернуть `None`, в этом случае элемент будет пропущен, или538  - вызвать исключение для прерывания операции или пропуска элемента, в зависимости от [`errorlevel`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.errorlevel). Обратите внимание, что при прерывании извлечения [`extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall) может оставить архив частично извлечённым. Он не пытается выполнить очистку.539540### Именованные фильтры по умолчанию541542Предопределённые именованные фильтры доступны как функции, поэтому их можно повторно использовать в пользовательских фильтрах:543544#### `tarfile.fully_trusted_filter(/, member, path)`545546Возвращает *элемент* без изменений.547548Это реализует фильтр `'fully_trusted'`.549550#### `tarfile.tar_filter(/, member, path)`551552Реализует фильтр `'tar'`.553554- Удаляет начальные слеши (`/` и [`os.sep`](https://python-all.ru/3.8/library/os.html#os.sep)) из имён файлов.555- [Отказывается](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы с абсолютными путями (если имя является абсолютным даже после удаления слешей, например `C:/foo` в Windows). Это вызывает [`AbsolutePathError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.AbsolutePathError).556- [Отказывается](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы, абсолютный путь которых (после разрешения симлинков) оказался бы за пределами целевой директории. Это вызывает [`OutsideDestinationError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.OutsideDestinationError).557- Очищает биты высоких режимов (setuid, setgid, sticky) и биты записи для группы и остальных (`S_IWOTH`).558559Возвращает изменённый элемент `TarInfo`.560561#### `tarfile.data_filter(/, member, path)`562563Реализует фильтр `'data'`. В дополнение к тому, что делает `tar_filter`:564565- [Отказывается](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-refuse) извлекать ссылки (жёсткие или символические), которые указывают на абсолютные пути или ведут за пределы целевой директории.566567  Это вызывает [`AbsoluteLinkError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.AbsoluteLinkError) или [`LinkOutsideDestinationError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.LinkOutsideDestinationError).568569  Обратите внимание, что такие файлы отклоняются даже на платформах, не поддерживающих символические ссылки.570- [Отказывается](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы устройств (включая каналы). Это вызывает [`SpecialFileError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.SpecialFileError).571- Для обычных файлов, включая жёсткие ссылки:572573  - Устанавливает права на чтение и запись для владельца (`S_IWUSR`).574  - Удаляет право на выполнение для группы и остальных (`S_IXOTH`) если владелец не имеет его ([`S_IXUSR`](https://python-all.ru/3.8/library/stat.html#stat.S_IXUSR)).575- Для остальных файлов (каталогов) устанавливает `mode` в `None`, чтобы методы извлечения пропускали применение битов разрешений.576- Устанавливает информацию о пользователе и группе (`uid`, `gid`, `uname`, `gname`) в `None`, чтобы методы извлечения пропускали её установку.577578Возвращает изменённый элемент `TarInfo`.579580### Ошибки фильтра581582Когда фильтр отказывается извлекать файл, он возбуждает соответствующее исключение, подкласс [`FilterError`](https://python-all.ru/3.8/library/tarfile.html#tarfile.FilterError). Это прервёт извлечение, если [`TarFile.errorlevel`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.errorlevel) равно 1 или больше. При `errorlevel=0` ошибка будет зарегистрирована, а элемент будет пропущен, но извлечение продолжится.583584### Рекомендации по дополнительной проверке585586Даже с `filter='data'`, *tarfile* не подходит для извлечения недоверенных файлов без предварительной проверки. Среди прочих проблем, предопределённые фильтры не предотвращают атаки типа «отказ в обслуживании». Пользователям следует проводить дополнительные проверки.587588Вот неполный список аспектов, которые стоит учесть:589590- Извлекайте в [`new temporary directory`](https://python-all.ru/3.8/library/tempfile.html#tempfile.mkdtemp), чтобы предотвратить, например, использование существующих ссылок, и упростить очистку после неудачного извлечения.591- При работе с недоверенными данными используйте внешние (например, на уровне ОС) ограничения на использование диска, памяти и процессора.592- Проверяет имена файлов по списку разрешённых символов (для фильтрации управляющих символов, омоглифов, разделителей пути из других систем и т.д.).593- Проверяет, что имена файлов имеют ожидаемые расширения (чтобы предотвратить файлы, которые выполняются при «двойном клике», или файлы без расширения, такие как специальные имена устройств Windows).594- Ограничивает количество извлечённых файлов, общий объём извлечённых данных, длину имён файлов (включая длину символических ссылок) и размер отдельных файлов.595- Проверяет наличие файлов, которые будут затенены на файловых системах без учёта регистра.596597Также обратите внимание:598599- Tar-файлы могут содержать несколько версий одного и того же файла. Ожидается, что более поздние версии перезапишут любые предыдущие. Эта возможность критически важна для обновления ленточных архивов, но может быть злонамеренно использована.600- *tarfile* не защищает от проблем с «активными» данными, например, когда злоумышленник манипулирует целевым (или исходным) каталогом во время извлечения (или архивирования).601602### Поддержка старых версий Python603604Фильтры извлечения были добавлены в Python 3.12 и перенесены в более старые версии в качестве обновлений безопасности. Чтобы проверить, доступна ли эта возможность, используйте, например, `hasattr(tarfile, 'data_filter')`, а не проверку версии Python.605606Следующие примеры показывают, как поддерживать версии Python с этой возможностью и без неё. Обратите внимание, что установка `extraction_filter` повлияет на все последующие операции.607608- Полностью доверенный архив:609610  ```python611  my_tarfile.extraction_filter = (lambda member, path: member)612  my_tarfile.extractall()613  ```614- Используйте фильтр `'data'`, если он доступен, иначе вернитесь к поведению Python 3.11 (`'fully_trusted'`), если эта возможность недоступна:615616  ```python617  my_tarfile.extraction_filter = getattr(tarfile, 'data_filter',618                                         (lambda member, path: member))619  my_tarfile.extractall()620  ```621- Используйте фильтр `'data'`; *завершить ошибкой*, если он недоступен:622623  ```python624  my_tarfile.extractall(filter=tarfile.data_filter)625  ```626627  или:628629  ```python630  my_tarfile.extraction_filter = tarfile.data_filter631  my_tarfile.extractall()632  ```633- Используйте фильтр `'data'`; *предупредить*, если он недоступен:634635  ```python636  if hasattr(tarfile, 'data_filter'):637      my_tarfile.extractall(filter='data')638  else:639      # удалить, когда больше не нужно640      warn_the_user('Extracting may be unsafe; consider updating Python')641      my_tarfile.extractall()642  ```643644### Пример фильтра извлечения с состоянием645646Хотя методы извлечения *tarfile* принимают простой вызываемый объект *filter*, пользовательские фильтры могут быть более сложными объектами с внутренним состоянием. Может быть полезно реализовать их в виде контекстных менеджеров, чтобы использовать следующим образом:647648```python649with StatefulFilter() as filter_func:650    tar.extractall(path, filter=filter_func)651```652653Такой фильтр можно написать, например, так:654655```python656class StatefulFilter:657    def __init__(self):658        self.file_count = 0659660    def __enter__(self):661        return self662663    def __call__(self, member, path):664        self.file_count += 1665        return member666667    def __exit__(self, *exc_info):668        print(f'{self.file_count} files extracted')669```670671## Интерфейс командной строки672673Новое в версии 3.4.674675Модуль [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile) предоставляет простой интерфейс командной строки для работы с tar-архивами.676677Если вы хотите создать новый tar-архив, укажите его имя после опции [`-c`](https://python-all.ru/3.8/library/tarfile.html#cmdoption-tarfile-c), а затем перечислите имена файлов, которые должны быть включены:678679```console680$ python -m tarfile -c monty.tar  spam.txt eggs.txt681```682683Можно также передать каталог:684685```console686$ python -m tarfile -c monty.tar life-of-brian_1979/687```688689Если вы хотите извлечь tar-архив в текущий каталог, используйте опцию [`-e`](https://python-all.ru/3.8/library/tarfile.html#cmdoption-tarfile-e):690691```console692$ python -m tarfile -e monty.tar693```694695Вы также можете извлечь tar-архив в другой каталог, передав его имя:696697```console698$ python -m tarfile -e monty.tar  other-dir/699```700701Чтобы получить список файлов в tar-архиве, используйте опцию [`-l`](https://python-all.ru/3.8/library/tarfile.html#cmdoption-tarfile-l):702703```console704$ python -m tarfile -l monty.tar705```706707### Параметры командной строки708709#### `-l <tarfile>`710711#### `--list <tarfile>`712713Выводит список файлов в tar-архиве.714715#### `-c <tarfile> <source1> ... <sourceN>`716717#### `--create <tarfile> <source1> ... <sourceN>`718719Создаёт tar-архив из исходных файлов.720721#### `-e <tarfile> [<output_dir>]`722723#### `--extract <tarfile> [<output_dir>]`724725Извлекает tar-архив в текущий каталог, если *output\_dir* не указан.726727#### `-t <tarfile>`728729#### `--test <tarfile>`730731Проверяет, является ли tar-файл допустимым.732733#### `-v, --verbose`734735Подробный вывод.736737#### `--filter <filtername>`738739Указывает *фильтр* для `--extract`. Подробнее см. [Фильтры извлечения](https://python-all.ru/3.8/library/tarfile.html#tarfile-extraction-filter). Принимаются только строковые имена (то есть `fully_trusted`, `tar`, и `data`).740741Новое в версии 3.8.17.742743## Примеры744745Как извлечь полный tar-архив в текущий рабочий каталог:746747```python748import tarfile749tar = tarfile.open("sample.tar.gz")750tar.extractall()751tar.close()752```753754Как извлечь подмножество tar-архива с помощью [`TarFile.extractall()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.extractall), используя функцию-генератор вместо списка:755756```python757import os758import tarfile759760def py_files(members):761    for tarinfo in members:762        if os.path.splitext(tarinfo.name)[1] == ".py":763            yield tarinfo764765tar = tarfile.open("sample.tar.gz")766tar.extractall(members=py_files(tar))767tar.close()768```769770Как создать несжатый tar-архив из списка имён файлов:771772```python773import tarfile774tar = tarfile.open("sample.tar", "w")775for name in ["foo", "bar", "quux"]:776    tar.add(name)777tar.close()778```779780Тот же пример с использованием оператора [`with`](https://python-all.ru/3.8/reference/compound_stmts.html#with):781782```python783import tarfile784with tarfile.open("sample.tar", "w") as tar:785    for name in ["foo", "bar", "quux"]:786        tar.add(name)787```788789Как прочитать tar-архив, сжатый gzip, и вывести информацию о некоторых элементах:790791```python792import tarfile793tar = tarfile.open("sample.tar.gz", "r:gz")794for tarinfo in tar:795    print(tarinfo.name, "is", tarinfo.size, "bytes in size and is ", end="")796    if tarinfo.isreg():797        print("a regular file.")798    elif tarinfo.isdir():799        print("a directory.")800    else:801        print("something else.")802tar.close()803```804805Как создать архив и сбросить информацию о пользователе, используя параметр *фильтр* в [`TarFile.add()`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile.add):806807```python808import tarfile809def reset(tarinfo):810    tarinfo.uid = tarinfo.gid = 0811    tarinfo.uname = tarinfo.gname = "root"812    return tarinfo813tar = tarfile.open("sample.tar.gz", "w:gz")814tar.add("foo", filter=reset)815tar.close()816```817818## Поддерживаемые форматы tar819820Существует три формата tar, которые можно создать с помощью модуля [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile):821822- Формат POSIX.1-1988 ustar ([`USTAR_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.USTAR_FORMAT)). Он поддерживает имена файлов длиной не более 256 символов и имена ссылок – до 100 символов. Максимальный размер файла – 8 ГиБ. Это старый и ограниченный, но широко поддерживаемый формат.823- Формат GNU tar ([`GNU_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.GNU_FORMAT)). Он поддерживает длинные имена файлов и ссылок, файлы размером более 8 ГиБ и разрежённые файлы. Это де-факто стандарт в системах GNU/Linux. [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile) полностью поддерживает расширения GNU tar для длинных имён; поддержка разрежённых файлов – только для чтения.824- Формат POSIX.1-2001 pax ([`PAX_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.PAX_FORMAT)). Это наиболее гибкий формат, практически без ограничений. Он поддерживает длинные имена файлов и ссылок, большие файлы и сохраняет пути переносимым способом. Современные реализации tar, включая GNU tar, bsdtar/libarchive и star, полностью поддерживают расширенные возможности *pax*; некоторые старые или неподдерживаемые библиотеки могут не поддерживать, но должны обрабатывать архивы *pax* так, как если бы они были в универсально поддерживаемом формате *ustar*. Это текущий формат по умолчанию для новых архивов.825826  Он расширяет существующий формат *ustar* дополнительными заголовками для информации, которую иначе нельзя сохранить. Существует две разновидности заголовков pax: расширенные заголовки влияют только на последующий заголовок файла, глобальные заголовки действительны для всего архива и влияют на все последующие файлы. Все данные в заголовке pax кодируются в *UTF-8* по соображениям переносимости.827828Существуют ещё некоторые варианты формата tar, которые можно читать, но не создавать:829830- Древний формат V7. Это первый формат tar из Unix Seventh Edition, хранящий только обычные файлы и каталоги. Имена не должны быть длиннее 100 символов, информация об имени пользователя/группы отсутствует. Некоторые архивы имеют неправильные контрольные суммы заголовков в случае полей с не-ASCII символами.831- Расширенный формат SunOS tar. Этот формат является вариантом формата POSIX.1-2001 pax, но несовместим с ним.832833## Проблемы Unicode834835Формат tar изначально был задуман для создания резервных копий на ленточных накопителях с основным упором на сохранение информации о файловой системе. Сегодня tar-архивы обычно используются для распространения файлов и обмена архивами по сетям. Одна проблема исходного формата (который является основой всех других форматов) заключается в том, что нет концепции поддержки разных кодировок символов. Например, обычный tar-архив, созданный в системе с *UTF-8*, не может быть корректно прочитан в системе с *Latin-1*, если он содержит символы, отличные от *ASCII*. Текстовые метаданные (например, имена файлов, имена ссылок, имена пользователей/групп) будут повреждены. К сожалению, нет способа автоматически определить кодировку архива. Формат pax был разработан для решения этой проблемы. Он хранит не-ASCII метаданные, используя универсальную кодировку символов *UTF-8*.836837Детали преобразования символов в [`tarfile`](https://python-all.ru/3.8/library/tarfile.html#module-tarfile) управляются ключевыми аргументами *encoding* и *errors* класса [`TarFile`](https://python-all.ru/3.8/library/tarfile.html#tarfile.TarFile).838839*encoding* определяет кодировку символов, используемую для метаданных в архиве. Значение по умолчанию – [`sys.getfilesystemencoding()`](https://python-all.ru/3.8/library/sys.html#sys.getfilesystemencoding) или `'ascii'` в качестве запасного варианта. В зависимости от того, читается или записывается архив, метаданные должны быть либо декодированы, либо закодированы. Если *encoding* не установлена соответствующим образом, это преобразование может завершиться ошибкой.840841Аргумент *errors* определяет, как обрабатываются символы, которые невозможно преобразовать. Возможные значения перечислены в разделе [Обработчики ошибок](https://python-all.ru/3.8/library/codecs.html#error-handlers). Схема по умолчанию – `'surrogateescape'`, которую Python также использует для своих системных вызовов, см. [Имена файлов, аргументы командной строки и переменные окружения](https://python-all.ru/3.8/library/os.html#os-filenames).842843Для архивов [`PAX_FORMAT`](https://python-all.ru/3.8/library/tarfile.html#tarfile.PAX_FORMAT) (по умолчанию) *encoding* обычно не требуется, потому что все метаданные хранятся с использованием *UTF-8*. *encoding* используется только в редких случаях, когда декодируются бинарные заголовки pax или когда хранятся строки с суррогатными символами.844