> **Источник:** https://python-all.ru/3.11/library/tarfile.html > > «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor. --- # [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) – Чтение и запись файлов tar-архивов **Исходный код:** [Lib/tarfile.py](https://python-all.ru/src/3.11/Lib/tarfile.py) --- Модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) позволяет читать и записывать tar-архивы, в том числе сжатые gzip, bz2 и lzma. Используйте модуль [`zipfile`](https://python-all.ru/3.11/library/zipfile.html#module-zipfile) для чтения и записи файлов `.zip` или функции более высокого уровня из [shutil](https://python-all.ru/3.11/library/shutil.html#archiving-operations). Некоторые факты и цифры: - читает и записывает сжатые архивы [`gzip`](https://python-all.ru/3.11/library/gzip.html#module-gzip), [`bz2`](https://python-all.ru/3.11/library/bz2.html#module-bz2) и [`lzma`](https://python-all.ru/3.11/library/lzma.html#module-lzma) если соответствующие модули доступны. - поддержка чтения/записи формата POSIX.1-1988 (ustar). - поддержка чтения/записи формата GNU tar, включая расширения *longname* и *longlink*, поддержка только чтения всех вариантов расширения *sparse*, включая восстановление разрежённых файлов. - поддержка чтения/записи формата POSIX.1-2001 (pax). - работает с директориями, обычными файлами, жёсткими ссылками, символическими ссылками, каналами FIFO, символьными и блочными устройствами, а также может получать и восстанавливать информацию о файлах, такую как временная метка, права доступа и владелец. Изменено в версии 3.3: Добавлена поддержка сжатия [`lzma`](https://python-all.ru/3.11/library/lzma.html#module-lzma). #### `tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)` Возвращает объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) для имени пути *name*. Подробную информацию об объектах [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) и допустимых именованных аргументах см. в разделе [Объекты TarFile](https://python-all.ru/3.11/library/tarfile.html#tarfile-objects). *mode* должен быть строкой вида `'filemode[:compression]'`, по умолчанию равен `'r'`. Вот полный список комбинаций режимов: | Режим | Действие | | --- | --- | | `'r' or 'r:*'` | Открыть для чтения с прозрачным сжатием (рекомендуется). | | `'r:'` | Открыть для чтения исключительно без сжатия. | | `'r:gz'` | Открыть для чтения со сжатием gzip. | | `'r:bz2'` | Открыть для чтения со сжатием bzip2. | | `'r:xz'` | Открыть для чтения со сжатием lzma. | | `'x'` или `'x:'` | Создать tar-файл исключительно без сжатия. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.11/library/exceptions.html#FileExistsError), если файл уже существует. | | `'x:gz'` | Создать tar-файл со сжатием gzip. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.11/library/exceptions.html#FileExistsError), если файл уже существует. | | `'x:bz2'` | Создать tar-файл со сжатием bzip2. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.11/library/exceptions.html#FileExistsError), если файл уже существует. | | `'x:xz'` | Создать tar-файл со сжатием lzma. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.11/library/exceptions.html#FileExistsError), если файл уже существует. | | `'a' or 'a:'` | Открыть для добавления без сжатия. Файл создаётся, если он не существует. | | `'w' or 'w:'` | Открывается для записи без сжатия. | | `'w:gz'` | Открывается для записи со сжатием gzip. | | `'w:bz2'` | Открывается для записи со сжатием bzip2. | | `'w:xz'` | Открывается для записи со сжатием lzma. | Обратите внимание, что `'a:gz'`, `'a:bz2'` или `'a:xz'` невозможны. Если *режим* не подходит для открытия определённого (сжатого) файла для чтения, возбуждается [`ReadError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.ReadError). Используйте *режим* `'r'`, чтобы избежать этого. Если метод сжатия не поддерживается, возбуждается [`CompressionError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.CompressionError). Если указан *fileobj*, он используется вместо [файлового объекта](https://python-all.ru/3.11/glossary.html#term-file-object), открытого в бинарном режиме для *имени*. Предполагается, что он находится на позиции 0. Для режимов `'w:gz'`, `'r:gz'`, `'w:bz2'`, `'r:bz2'`, `'x:gz'`, `'x:bz2'`, [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open) принимает именованный аргумент *compresslevel* (по умолчанию `9`) для указания уровня сжатия файла. Для режимов `'w:xz'` и `'x:xz'` [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open) принимает именованный аргумент *preset* для указания уровня сжатия файла. Для специальных целей существует второй формат для *mode*: `'filemode|[compression]'`. [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open) вернёт объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile), который обрабатывает данные как поток блоков. Произвольный доступ к файлу не осуществляется. Если передан *fileobj*, им может быть любой объект, имеющий метод [`read()`](https://python-all.ru/3.11/library/io.html#io.RawIOBase.read) или [`write()`](https://python-all.ru/3.11/library/io.html#io.RawIOBase.write) (в зависимости от *режима*), работающий с байтами. *bufsize* задаёт размер блока, по умолчанию `20 * 512` байт. Используйте этот вариант в сочетании, например, с `sys.stdin.buffer`, сокетным [файловым объектом](https://python-all.ru/3.11/glossary.html#term-file-object) или ленточным устройством. Однако такой объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) ограничен тем, что не допускает произвольного доступа; см. [Примеры](https://python-all.ru/3.11/library/tarfile.html#tar-examples). Текущие возможные режимы: | Режим | Действие | | --- | --- | | `'r\|*'` | Открывает *поток данных* tar-блоков для чтения с прозрачным сжатием. | | `'r\|'` | Открывает *поток данных* несжатых tar-блоков для чтения. | | `'r\|gz'` | Открывает сжатый gzip *поток данных* для чтения. | | `'r\|bz2'` | Открывает сжатый bzip2 *поток данных* для чтения. | | `'r\|xz'` | Открывает сжатый lzma *поток данных* для чтения. | | `'w\|'` | Открывает несжатый *поток данных* для записи. | | `'w\|gz'` | Открывает сжатый gzip *поток данных* для записи. | | `'w\|bz2'` | Открывает сжатый bzip2 *поток данных* для записи. | | `'w\|xz'` | Открывает сжатый lzma *поток данных* для записи. | Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание). Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). #### `class tarfile.TarFile` Класс для чтения и записи tar-архивов. Не используйте этот класс напрямую: вместо него используйте [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open). См. [Объекты TarFile](https://python-all.ru/3.11/library/tarfile.html#tarfile-objects). #### `tarfile.is_tarfile(name)` Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если *name* является tar-архивом, который может прочитать модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile). *name* может быть [`str`](https://python-all.ru/3.11/library/stdtypes.html#str), файлом или файлоподобным объектом. Изменено в версии 3.9: Добавлена поддержка файлов и файлоподобных объектов. Модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) определяет следующие исключения: #### `exception tarfile.TarError` Базовый класс для всех исключений [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile). #### `exception tarfile.ReadError` Возникает при открытии tar-архива, который не может быть обработан модулем [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) или является некорректным. #### `exception tarfile.CompressionError` Возникает, когда метод сжатия не поддерживается или данные не удаётся корректно декодировать. #### `exception tarfile.StreamError` Возникает при ограничениях, типичных для объектов, работающих в режиме потока [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile). #### `exception tarfile.ExtractError` Возникает при *нефатальных* ошибках при использовании [`TarFile.extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract), но только если [`TarFile.errorlevel`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.errorlevel)`== 2`. #### `exception tarfile.HeaderError` Возникает при вызове [`TarInfo.frombuf()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.frombuf), если полученный буфер некорректен. #### `exception tarfile.FilterError` Базовый класс для элементов, [отклонённых](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) фильтрами. #### `tarinfo` Информация об элементе, который фильтр отказался извлекать, в виде [TarInfo](https://python-all.ru/3.11/library/tarfile.html#tarinfo-objects). #### `exception tarfile.AbsolutePathError` Возникает при отказе извлекать элемент с абсолютным путём. #### `exception tarfile.OutsideDestinationError` Возникает при отказе извлекать элемент за пределами целевого каталога. #### `exception tarfile.SpecialFileError` Возникает при отказе извлекать специальный файл (например, устройство или канал). #### `exception tarfile.AbsoluteLinkError` Возникает при отказе извлекать символическую ссылку с абсолютным путём. #### `exception tarfile.LinkOutsideDestinationError` Возникает при отказе извлекать символическую ссылку, указывающую за пределы целевого каталога. #### `exception tarfile.LinkFallbackError` Возникает при отказе эмулировать ссылку (жёсткую или символическую) путём извлечения другого элемента архива, если этот элемент был бы отклонён расположением фильтра. Исключение, вызванное для отклонения заменяющего элемента, доступно как `BaseException.__context__`. Новое в версии 3.11.13. На уровне модуля доступны следующие константы: #### `tarfile.ENCODING` Кодировка символов по умолчанию: `'utf-8'` в Windows, значение, возвращаемое [`sys.getfilesystemencoding()`](https://python-all.ru/3.11/library/sys.html#sys.getfilesystemencoding) в остальных случаях. #### `tarfile.REGTYPE` #### `tarfile.AREGTYPE` Обычный файл [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.LNKTYPE` Ссылка (внутри tar-файла) [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.SYMTYPE` Символическая ссылка [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.CHRTYPE` Символьное устройство [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.BLKTYPE` Блочное устройство [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.DIRTYPE` Каталог [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.FIFOTYPE` FIFO-устройство [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.CONTTYPE` Непрерывный файл [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.GNUTYPE_LONGNAME` Длинное имя GNU tar [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.GNUTYPE_LONGLINK` Длинная ссылка GNU tar [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). #### `tarfile.GNUTYPE_SPARSE` Разрежённый файл GNU tar [`type`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.type). Каждая из следующих констант определяет формат tar-архива, который модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) может создавать. Подробнее см. раздел [Поддерживаемые форматы tar](https://python-all.ru/3.11/library/tarfile.html#tar-formats) для получения подробностей. #### `tarfile.USTAR_FORMAT` Формат POSIX.1-1988 (ustar). #### `tarfile.GNU_FORMAT` Формат GNU tar. #### `tarfile.PAX_FORMAT` Формат POSIX.1-2001 (pax). #### `tarfile.DEFAULT_FORMAT` Формат по умолчанию для создания архивов. В настоящее время это [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT). Изменено в версии 3.8: Формат по умолчанию для новых архивов был изменён на [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT) с [`GNU_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.GNU_FORMAT). > **См. также** > > **Модуль [`zipfile`](https://python-all.ru/3.11/library/zipfile.html#module-zipfile)** > > Документация стандартного модуля [`zipfile`](https://python-all.ru/3.11/library/zipfile.html#module-zipfile). > > **[Операции архивирования](https://python-all.ru/3.11/library/shutil.html#archiving-operations)** > > Документация средств архивирования высокого уровня, предоставляемых стандартным модулем [`shutil`](https://python-all.ru/3.11/library/shutil.html#module-shutil). > > **[Руководство GNU tar, базовый формат tar](https://python-all.ru/3.11/library/tarfile.html)** > > Документация для файлов архивов tar, включая расширения GNU tar. ## Объекты TarFile Объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) предоставляет интерфейс к архиву tar. Архив tar представляет собой последовательность блоков. Элемент архива (хранимый файл) состоит из заголовочного блока, за которым следуют блоки данных. Файл можно сохранить в архив tar несколько раз. Каждый элемент архива представляется объектом [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo), подробнее см. [Объекты TarInfo](https://python-all.ru/3.11/library/tarfile.html#tarinfo-objects). Объект [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3.11/reference/compound_stmts.html#with). Он будет автоматически закрыт по завершении блока. Обратите внимание: в случае исключения архив, открытый для записи, не будет финализирован; будет закрыт только внутренний файловый объект. Пример использования см. в разделе [Примеры](https://python-all.ru/3.11/library/tarfile.html#tar-examples). Новое в версии 3.2: Добавлена поддержка протокола менеджера контекста. #### `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)` Все последующие аргументы необязательны и также могут быть доступны как атрибуты экземпляра. *name* – это путь к архиву. *name* может быть [объектом, подобным пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). Его можно опустить, если указан *fileobj*. В этом случае используется атрибут файлового объекта `name`, если он существует. *mode* может быть `'r'` для чтения из существующего архива, `'a'` для добавления данных в существующий файл, `'w'` для создания нового файла с перезаписью существующего или `'x'` для создания нового файла только в том случае, если он ещё не существует. Если указан *fileobj*, он используется для чтения или записи данных. Если это можно определить, *mode* переопределяется режимом *fileobj*. *fileobj* будет использоваться с позиции 0. > **Примечание** > > *fileobj* не закрывается при закрытии [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile). *format* управляет форматом архива для записи. Он должен быть одной из констант [`USTAR_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.USTAR_FORMAT), [`GNU_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.GNU_FORMAT) или [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT), определённых на уровне модуля. При чтении формат будет определён автоматически, даже если в одном архиве присутствуют разные форматы. Аргумент *tarinfo* можно использовать для замены класса по умолчанию [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) на другой. Если *dereference* равно [`False`](https://python-all.ru/3.11/library/constants.html#False), в архив добавляются символические и жёсткие ссылки. Если [`True`](https://python-all.ru/3.11/library/constants.html#True), в архив добавляется содержимое целевых файлов. Это не влияет на системы, не поддерживающие символические ссылки. Если *ignore\_zeros* равно [`False`](https://python-all.ru/3.11/library/constants.html#False), пустой блок считается концом архива. Если [`True`](https://python-all.ru/3.11/library/constants.html#True), пустые (и недействительные) блоки пропускаются, и предпринимается попытка получить как можно больше элементов. Это полезно только для чтения объединённых или повреждённых архивов. *debug* может быть установлен от `0` (нет отладочных сообщений) до `3` (все отладочные сообщения). Сообщения записываются в `sys.stderr`. *errorlevel* управляет обработкой ошибок извлечения, см. [`the corresponding attribute`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.errorlevel). Аргументы *encoding* и *errors* определяют кодировку символов, используемую для чтения или записи архива, и способ обработки ошибок преобразования. Настройки по умолчанию подходят для большинства пользователей. Подробную информацию см. в разделе [Проблемы Unicode](https://python-all.ru/3.11/library/tarfile.html#tar-unicode). Аргумент *pax\_headers* – необязательный словарь строк, который будет добавлен как глобальный заголовок pax, если *format* равно [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT). Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`. Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание). Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). #### `classmethod TarFile.open(...)` Альтернативный конструктор. Функция [`tarfile.open()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.open) на самом деле является сокращением для этого метода класса. #### `TarFile.getmember(name)` Возвращает объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) для элемента *name*. Если *name* не найден в архиве, возбуждается [`KeyError`](https://python-all.ru/3.11/library/exceptions.html#KeyError). > **Примечание** > > Если элемент встречается в архиве более одного раза, последнее его вхождение считается самой актуальной версией. #### `TarFile.getmembers()` Возвращает элементы архива в виде списка объектов [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Порядок списка соответствует порядку элементов в архиве. #### `TarFile.getnames()` Возвращает элементы в виде списка их имён. Порядок списка соответствует порядку списка, возвращаемого [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers). #### `TarFile.list(verbose=True, *, members=None)` Выводит оглавление в `sys.stdout`. Если *verbose* равно [`False`](https://python-all.ru/3.11/library/constants.html#False), печатаются только имена элементов. Если же [`True`](https://python-all.ru/3.11/library/constants.html#True), выводятся данные, аналогичные **ls -l**. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers). Изменено в версии 3.5: Добавлен параметр *members*. #### `TarFile.next()` Возвращает следующий элемент архива в виде объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo), когда [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) открыт для чтения. Если больше нет элементов, возвращает [`None`](https://python-all.ru/3.11/library/constants.html#None). #### `TarFile.extractall(path='.', members=None, *, numeric_owner=False, filter=None)` Извлекает все элементы из архива в текущую рабочую директорию или в директорию *path*. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers). Сведения о директории (владелец, время изменения, права доступа) устанавливаются после извлечения всех элементов. Это сделано для обхода двух проблем: время изменения директории сбрасывается при каждом создании в ней файла, и если права директории не разрешают запись, извлечение в неё файлов завершится ошибкой. Если *numeric\_owner* равно [`True`](https://python-all.ru/3.11/library/constants.html#True), для установки владельца и группы извлечённых файлов используются числовые uid и gid из tar-файла. В противном случае используются именованные значения из tar-файла. Аргумент *filter*, добавленный в Python 3.11.4, определяет, как `members` изменяются или отклоняются перед извлечением. Подробнее см. [Фильтры извлечения](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter). Рекомендуется явно задавать этот аргумент в зависимости от того, какие возможности *tar* необходимо поддерживать. > **Предупреждение** > > Никогда не извлекайте архивы из ненадёжных источников без предварительной проверки. Возможно создание файлов за пределами *path*, например, элементов с абсолютными именами, начинающимися с `"/"`, или с именами, содержащими две точки `".."`. > > Установите `filter='data'`, чтобы предотвратить наиболее опасные проблемы безопасности, и прочитайте раздел [Extraction filters](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter) для подробностей. Изменено в версии 3.5: Добавлен параметр *numeric\_owner*. Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). Изменено в версии 3.11.4: Добавлен параметр *filter*. #### `TarFile.extract(member, path='', set_attrs=True, *, numeric_owner=False, filter=None)` Извлекает элемент из архива в текущую рабочую директорию, используя его полное имя. Информация о файле извлекается максимально точно. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Можно указать другую директорию с помощью *path*. *path* может быть [объектом, подобным пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). Атрибуты файла (владелец, mtime, права доступа) устанавливаются, если *set\_attrs* не равно false. Аргументы *numeric\_owner* и *filter* такие же, как для [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall). > **Примечание** > > Метод [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) не решает ряд проблем извлечения. В большинстве случаев стоит рассмотреть использование метода [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall). > **Предупреждение** > > См. предупреждение для [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall). > > Установите `filter='data'`, чтобы предотвратить наиболее опасные проблемы безопасности, и прочитайте раздел [Extraction filters](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter) для подробностей. Изменено в версии 3.2: Добавлен параметр *set\_attrs*. Изменено в версии 3.5: Добавлен параметр *numeric\_owner*. Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). Изменено в версии 3.11.4: Добавлен параметр *filter*. #### `TarFile.extractfile(member)` Извлекает элемент из архива в виде файлового объекта. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Если *member* – обычный файл или ссылка, возвращается объект [`io.BufferedReader`](https://python-all.ru/3.11/library/io.html#io.BufferedReader). Для всех остальных существующих элементов возвращается [`None`](https://python-all.ru/3.11/library/constants.html#None). Если *member* не найден в архиве, вызывается [`KeyError`](https://python-all.ru/3.11/library/exceptions.html#KeyError). Изменено в версии 3.3: Возвращается объект [`io.BufferedReader`](https://python-all.ru/3.11/library/io.html#io.BufferedReader). #### `TarFile.errorlevel: int` Если *errorlevel* равен `0`, ошибки игнорируются при использовании [`TarFile.extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`TarFile.extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall). Тем не менее, они отображаются как сообщения об ошибках в отладочном выводе, когда *debug* больше 0. Если `1` (по умолчанию), все *фатальные* ошибки вызываются как исключения [`OSError`](https://python-all.ru/3.11/library/exceptions.html#OSError) или [`FilterError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.FilterError). Если `2`, все *нефатальные* ошибки также вызываются как исключения [`TarError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarError). Некоторые исключения, например, вызванные неправильными типами аргументов или повреждением данных, всегда вызываются. Пользовательские [фильтры извлечения](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter) должны вызывать [`FilterError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.FilterError) для *фатальных* ошибок и [`ExtractError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.ExtractError) для *нефатальных*. Обратите внимание, что при возникновении исключения архив может быть извлечён частично. Ответственность за очистку лежит на пользователе. #### `TarFile.extraction_filter` Новое в версии 3.11.4. [Фильтр извлечения](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter), используемый по умолчанию для аргумента *filter* методов [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall). Атрибут может быть `None` или вызываемым объектом. Строковые имена для этого атрибута не допускаются, в отличие от аргумента *filter* для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract). Если `extraction_filter` равен `None` (значение по умолчанию), вызов метода извлечения без аргумента *filter* приведёт к использованию фильтра [`fully_trusted`](https://python-all.ru/3.11/library/tarfile.html#tarfile.fully_trusted_filter) для совместимости с предыдущими версиями Python. В Python 3.12+ оставление `extraction_filter=None` вызовет `DeprecationWarning`. Начиная с Python 3.14, если оставить `extraction_filter=None`, методы извлечения по умолчанию будут использовать фильтр [`data`](https://python-all.ru/3.11/library/tarfile.html#tarfile.data_filter). Атрибут может быть установлен для экземпляров или переопределён в подклассах. Также возможно установить его для самого класса `TarFile`, чтобы задать глобальное значение по умолчанию; однако, поскольку это влияет на все случаи использования *tarfile*, лучшей практикой будет делать это только в приложениях верхнего уровня или [`site configuration`](https://python-all.ru/3.11/library/site.html#module-site). Чтобы задать глобальное значение по умолчанию таким образом, функцию фильтра необходимо обернуть в [`staticmethod()`](https://python-all.ru/3.11/library/functions.html#staticmethod), чтобы предотвратить внедрение аргумента `self`. #### `TarFile.add(name, arcname=None, recursive=True, *, filter=None)` Добавляет файл *name* в архив. *name* может быть любым типом файла (каталог, FIFO, символическая ссылка и т.д.). Если задан, *arcname* указывает альтернативное имя файла в архиве. Каталоги добавляются рекурсивно по умолчанию. Этого можно избежать, установив *recursive* в [`False`](https://python-all.ru/3.11/library/constants.html#False). Рекурсия добавляет записи в отсортированном порядке. Если задан *filter*, он должен быть функцией, которая принимает аргумент объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) и возвращает изменённый объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Если же она возвращает [`None`](https://python-all.ru/3.11/library/constants.html#None), объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) будет исключён из архива. Пример см. в [Примерах](https://python-all.ru/3.11/library/tarfile.html#tar-examples). Изменено в версии 3.2: Добавлен параметр *filter*. Изменено в версии 3.7: Рекурсия добавляет записи в отсортированном порядке. #### `TarFile.addfile(tarinfo, fileobj=None)` Добавляет объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) *tarinfo* в архив. Если указан *fileobj*, он должен быть [двоичным файлом](https://python-all.ru/3.11/glossary.html#term-binary-file), из которого читаются `tarinfo.size` байтов и добавляются в архив. Можно создавать объекты [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) напрямую или с помощью [`gettarinfo()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.gettarinfo). #### `TarFile.gettarinfo(name=None, arcname=None, fileobj=None)` Создаёт объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) из результата [`os.stat()`](https://python-all.ru/3.11/library/os.html#os.stat) или эквивалентного для существующего файла. Файл задаётся либо именем *name*, либо указывается как [файловый объект](https://python-all.ru/3.11/glossary.html#term-file-object) *fileobj* с файловым дескриптором. *name* может быть [объектом, подобным пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). Если задан, *arcname* указывает альтернативное имя файла в архиве; в противном случае имя берётся из атрибута [`name`](https://python-all.ru/3.11/library/io.html#io.FileIO.name) объекта *fileobj* или из аргумента *name*. Имя должно быть текстовой строкой. Можно изменить некоторые атрибуты объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) перед его добавлением с помощью [`addfile()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.addfile). Если файловый объект не является обычным файловым объектом, расположенным в начале файла, такие атрибуты, как [`size`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.size), могут потребовать изменения. Это относится к таким объектам, как [`GzipFile`](https://python-all.ru/3.11/library/gzip.html#gzip.GzipFile). Атрибут [`name`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.name) также может быть изменён, и в этом случае *arcname* может быть фиктивной строкой. Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3.11/glossary.html#term-path-like-object). #### `TarFile.close()` Закрывает [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile). В режиме записи в архив добавляются два завершающих нулевых блока. #### `TarFile.pax_headers: dict` Словарь, содержащий пары ключ-значение глобальных заголовков pax. ## Объекты TarInfo Объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) представляет один элемент в [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile). Помимо хранения всех необходимых атрибутов файла (таких как тип, размер, время, права доступа, владелец и т.д.), он предоставляет некоторые полезные методы для определения его типа. Он *не* содержит сами данные файла. Объекты [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) возвращаются методами [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile): [`getmember()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmember), [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers) и [`gettarinfo()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.gettarinfo). Изменение объектов, возвращённых методами [`getmember()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmember) или [`getmembers()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.getmembers), повлияет на все последующие операции с архивом. В случаях, когда это нежелательно, можно использовать [`copy.copy()`](https://python-all.ru/3.11/library/copy.html#module-copy) или вызвать метод [`replace()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.replace), чтобы создать изменённую копию за один шаг. Некоторые атрибуты могут быть установлены в `None`, чтобы указать, что часть метаданных не используется или неизвестна. Разные методы [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) обрабатывают `None` по-разному: - Методы [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall) будут игнорировать соответствующие метаданные, оставляя их установленными по умолчанию. - [`addfile()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.addfile) завершится ошибкой. - [`list()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.list) выведет строку-заполнитель. Изменено в версии 3.11.4: Добавлены [`replace()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.replace) и обработка `None`. #### `class tarfile.TarInfo(name='')` Создаёт объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). #### `classmethod TarInfo.frombuf(buf, encoding, errors)` Создаёт и возвращает объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) из строкового буфера *buf*. Вызывает [`HeaderError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.HeaderError), если буфер некорректен. #### `classmethod TarInfo.fromtarfile(tarfile)` Читает следующий элемент из объекта [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile) *tarfile* и возвращает его в виде объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). #### `TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')` Создаёт строковый буфер из объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo). Подробнее об аргументах см. конструктор класса [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile). Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`. Объект `TarInfo` имеет следующие открытые атрибуты данных: #### `TarInfo.name: str` Имя элемента архива. #### `TarInfo.size: int` Размер в байтах. #### `TarInfo.mtime: int | float` Время последнего изменения в секундах с [начала эпохи](https://python-all.ru/3.11/library/time.html#epoch), как в [`os.stat_result.st_mtime`](https://python-all.ru/3.11/library/os.html#os.stat_result.st_mtime). Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута. #### `TarInfo.mode: int` Биты прав доступа, как для [`os.chmod()`](https://python-all.ru/3.11/library/os.html#os.chmod). Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута. #### `TarInfo.type` Тип файла. Обычно *type* – это одна из следующих констант: [`REGTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.REGTYPE), [`AREGTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.AREGTYPE), [`LNKTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.LNKTYPE), [`SYMTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.SYMTYPE), [`DIRTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.DIRTYPE), [`FIFOTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.FIFOTYPE), [`CONTTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.CONTTYPE), [`CHRTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.CHRTYPE), [`BLKTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.BLKTYPE), [`GNUTYPE_SPARSE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.GNUTYPE_SPARSE). Чтобы более удобно определить тип объекта [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo), используйте методы `is*()`, описанные ниже. #### `TarInfo.linkname: str` Имя целевого файла, которое присутствует только в объектах [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) типов [`LNKTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.LNKTYPE) и [`SYMTYPE`](https://python-all.ru/3.11/library/tarfile.html#tarfile.SYMTYPE). Для символических ссылок (`SYMTYPE`) значение *linkname* указывается относительно каталога, содержащего ссылку. Для жёстких ссылок (`LNKTYPE`) значение *linkname* указывается относительно корня архива. #### `TarInfo.uid: int` Идентификатор пользователя, который изначально сохранил этот элемент. Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута. #### `TarInfo.gid: int` Идентификатор группы пользователя, который изначально сохранил этот элемент. Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута. #### `TarInfo.uname: str` Имя пользователя. Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута. #### `TarInfo.gname: str` Имя группы. Изменено в версии 3.11.4: Можно установить в `None` для [`extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), что приводит к пропуску применения этого атрибута. #### `TarInfo.chksum: int` Контрольная сумма заголовка. #### `TarInfo.devmajor: int` Старший номер устройства. #### `TarInfo.devminor: int` Младший номер устройства. #### `TarInfo.offset: int` Заголовок tar начинается здесь. #### `TarInfo.offset_data: int` Данные файла начинаются здесь. #### `TarInfo.sparse` Информация о разреженном элементе. #### `TarInfo.pax_headers: dict` Словарь, содержащий пары ключ-значение связанного расширенного заголовка pax. #### `TarInfo.replace(name=..., mtime=..., mode=..., linkname=..., uid=..., gid=..., uname=..., gname=..., deep=True)` Новое в версии 3.11.4. Возвращает *новую* копию объекта `TarInfo` с указанными изменёнными атрибутами. Например, чтобы вернуть `TarInfo` с именем группы, установленным в `'staff'`, используйте: ```python new_tarinfo = old_tarinfo.replace(gname='staff') ``` По умолчанию создаётся глубокая копия. Если *deep* равен false, копия поверхностная, то есть `pax_headers` и любые пользовательские атрибуты являются общими с исходным объектом `TarInfo`. Объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) также предоставляет несколько удобных запросных методов: #### `TarInfo.isfile()` Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo) является обычным файлом. #### `TarInfo.isreg()` То же, что и [`isfile()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.isfile). #### `TarInfo.isdir()` Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это каталог. #### `TarInfo.issym()` Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это символическая ссылка. #### `TarInfo.islnk()` Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это жёсткая ссылка. #### `TarInfo.ischr()` Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это символьное устройство. #### `TarInfo.isblk()` Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это блочное устройство. #### `TarInfo.isfifo()` Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это FIFO. #### `TarInfo.isdev()` Возвращает [`True`](https://python-all.ru/3.11/library/constants.html#True), если это символьное устройство, блочное устройство или FIFO. ## Фильтры извлечения Новое в версии 3.11.4. Формат *tar* предназначен для сохранения всех деталей файловых систем UNIX-подобных ОС, что делает его очень мощным. К сожалению, эти возможности позволяют легко создавать tar-файлы, которые при извлечении могут иметь непреднамеренные – а возможно и вредоносные – эффекты. Например, извлечение tar-файла может перезаписать произвольные файлы различными способами (например, с использованием абсолютных путей, компонентов пути `..` или символических ссылок, влияющих на последующие элементы). В большинстве случаев полная функциональность не требуется. Поэтому *tarfile* поддерживает фильтры извлечения: механизм ограничения функциональности, что позволяет смягчить некоторые проблемы безопасности. > **См. также** > > **[**PEP 706**](https://python-all.ru/3.11/library/tarfile.html)** > > Содержит дополнительную мотивацию и обоснование дизайна. Аргумент *filter* для [`TarFile.extract()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extract) или [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall) может быть: - строка `'fully_trusted'`: соблюдать все метаданные, указанные в архиве. Следует использовать, если пользователь полностью доверяет архиву или реализует собственную сложную проверку. - строка `'tar'`: соблюдать большинство специфических для *tar* возможностей (т.е. возможностей файловых систем UNIX-подобных ОС), но блокировать те, которые могут быть неожиданными или вредоносными. Подробнее см. [`tar_filter()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.tar_filter). - строка `'data'`: игнорировать или блокировать большинство специфических для UNIX-подобных файловых систем возможностей. Предназначен для извлечения кроссплатформенных архивов. Подробнее см. [`data_filter()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.data_filter). - `None` (по умолчанию): использовать [`TarFile.extraction_filter`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extraction_filter). Если это также `None` (значение по умолчанию), будет использован фильтр `'fully_trusted'` (для совместимости с более ранними версиями Python). В Python 3.12 значение по умолчанию будет выдавать `DeprecationWarning`. В Python 3.14 фильтр `'data'` станет фильтром по умолчанию. Переключиться можно раньше; см. [`TarFile.extraction_filter`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extraction_filter). - Вызываемый объект, который будет вызываться для каждого извлекаемого элемента с объектом [TarInfo](https://python-all.ru/3.11/library/tarfile.html#tarinfo-objects), описывающим элемент и путь назначения, куда извлекается архив (т.е. один и тот же путь используется для всех элементов): ```python filter(member: TarInfo, path: str, /) -> TarInfo | None ``` Вызываемый объект вызывается непосредственно перед извлечением каждого элемента, поэтому он может учитывать текущее состояние диска. Он может: - вернуть объект [`TarInfo`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo), который будет использоваться вместо метаданных в архиве, или - вернуть `None`, в этом случае элемент будет пропущен, или - вызвать исключение для прерывания операции или пропуска элемента, в зависимости от [`errorlevel`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.errorlevel). Обратите внимание, что при прерывании извлечения [`extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall) может оставить архив частично извлечённым. Он не пытается выполнить очистку. ### Именованные фильтры по умолчанию Предопределённые именованные фильтры доступны как функции, поэтому их можно повторно использовать в пользовательских фильтрах: #### `tarfile.fully_trusted_filter(member, path)` Возвращает *элемент* без изменений. Это реализует фильтр `'fully_trusted'`. #### `tarfile.tar_filter(member, path)` Реализует фильтр `'tar'`. - Удаляет начальные слеши (`/` и [`os.sep`](https://python-all.ru/3.11/library/os.html#os.sep)) из имён файлов. - [Отказывается](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы с абсолютными путями (если имя является абсолютным даже после удаления слешей, например `C:/foo` в Windows). Это вызывает [`AbsolutePathError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.AbsolutePathError). - [Отказывается](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы, абсолютный путь которых (после разрешения симлинков) оказался бы за пределами целевой директории. Это вызывает [`OutsideDestinationError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.OutsideDestinationError). - Сбрасывает биты высоких режимов (setuid, setgid, sticky) и биты записи для группы и остальных ([`S_IWGRP`](https://python-all.ru/3.11/library/stat.html#stat.S_IWGRP) | [`S_IWOTH`](https://python-all.ru/3.11/library/stat.html#stat.S_IWOTH)). Возвращает изменённый элемент `TarInfo`. #### `tarfile.data_filter(member, path)` Реализует фильтр `'data'`. В дополнение к тому, что делает `tar_filter`: - Нормализует цели ссылок ([`TarInfo.linkname`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarInfo.linkname)) с помощью [`os.path.normpath()`](https://python-all.ru/3.11/library/os.path.html#os.path.normpath). Обратите внимание, что это удаляет внутренние компоненты `..`, что может изменить смысл ссылки, если путь в `TarInfo.linkname` проходит через символические ссылки. - [Отказывается](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) извлекать ссылки (жёсткие или символические), которые указывают на абсолютные пути или ведут за пределы целевой директории. Это вызывает [`AbsoluteLinkError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.AbsoluteLinkError) или [`LinkOutsideDestinationError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.LinkOutsideDestinationError). Обратите внимание, что такие файлы отклоняются даже на платформах, не поддерживающих символические ссылки. - [Отказывается](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы устройств (включая каналы). Это вызывает [`SpecialFileError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.SpecialFileError). - Для обычных файлов, включая жёсткие ссылки: - Устанавливает права на чтение и запись для владельца ([`S_IRUSR`](https://python-all.ru/3.11/library/stat.html#stat.S_IRUSR) | [`S_IWUSR`](https://python-all.ru/3.11/library/stat.html#stat.S_IWUSR)). - Удаляет права на выполнение для группы и остальных ([`S_IXGRP`](https://python-all.ru/3.11/library/stat.html#stat.S_IXGRP) | [`S_IXOTH`](https://python-all.ru/3.11/library/stat.html#stat.S_IXOTH)), если владелец ими не обладает ([`S_IXUSR`](https://python-all.ru/3.11/library/stat.html#stat.S_IXUSR)). - Для остальных файлов (каталогов) устанавливает `mode` в `None`, чтобы методы извлечения пропускали применение битов разрешений. - Устанавливает информацию о пользователе и группе (`uid`, `gid`, `uname`, `gname`) в `None`, чтобы методы извлечения пропускали её установку. Возвращает изменённый элемент `TarInfo`. Изменено в версии 3.11.13: Теперь цели ссылок нормализованы. ### Ошибки фильтра Когда фильтр отказывается извлекать файл, он возбуждает соответствующее исключение, подкласс [`FilterError`](https://python-all.ru/3.11/library/tarfile.html#tarfile.FilterError). Это прервёт извлечение, если [`TarFile.errorlevel`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.errorlevel) равно 1 или больше. При `errorlevel=0` ошибка будет зарегистрирована, а элемент будет пропущен, но извлечение продолжится. ### Рекомендации по дополнительной проверке Даже с `filter='data'`, *tarfile* не подходит для извлечения недоверенных файлов без предварительной проверки. Среди прочих проблем, предопределённые фильтры не предотвращают атаки типа «отказ в обслуживании». Пользователям следует проводить дополнительные проверки. Вот неполный список аспектов, которые стоит учесть: - Извлекайте в [`new temporary directory`](https://python-all.ru/3.11/library/tempfile.html#tempfile.mkdtemp), чтобы предотвратить, например, использование существующих ссылок, и упростить очистку после неудачного извлечения. - Запретите символические ссылки, если эта функциональность не требуется. - При работе с недоверенными данными используйте внешние (например, на уровне ОС) ограничения на использование диска, памяти и процессора. - Проверяет имена файлов по списку разрешённых символов (для фильтрации управляющих символов, омоглифов, разделителей пути из других систем и т.д.). - Проверяет, что имена файлов имеют ожидаемые расширения (чтобы предотвратить файлы, которые выполняются при «двойном клике», или файлы без расширения, такие как специальные имена устройств Windows). - Ограничивает количество извлечённых файлов, общий объём извлечённых данных, длину имён файлов (включая длину символических ссылок) и размер отдельных файлов. - Проверяет наличие файлов, которые будут затенены на файловых системах без учёта регистра. Также обратите внимание: - Tar-файлы могут содержать несколько версий одного и того же файла. Ожидается, что более поздние версии перезапишут любые предыдущие. Эта возможность критически важна для обновления ленточных архивов, но может быть злонамеренно использована. - *tarfile* не защищает от проблем с «активными» данными, например, когда злоумышленник манипулирует целевым (или исходным) каталогом во время извлечения (или архивирования). ### Поддержка старых версий Python Фильтры извлечения были добавлены в Python 3.12 и перенесены в более старые версии в качестве обновлений безопасности. Чтобы проверить, доступна ли эта возможность, используйте, например, `hasattr(tarfile, 'data_filter')`, а не проверку версии Python. Следующие примеры показывают, как поддерживать версии Python с этой возможностью и без неё. Обратите внимание, что установка `extraction_filter` повлияет на все последующие операции. - Полностью доверенный архив: ```python my_tarfile.extraction_filter = (lambda member, path: member) my_tarfile.extractall() ``` - Используйте фильтр `'data'`, если он доступен, иначе вернитесь к поведению Python 3.11 (`'fully_trusted'`), если эта возможность недоступна: ```python my_tarfile.extraction_filter = getattr(tarfile, 'data_filter', (lambda member, path: member)) my_tarfile.extractall() ``` - Используйте фильтр `'data'`; *завершить ошибкой*, если он недоступен: ```python my_tarfile.extractall(filter=tarfile.data_filter) ``` или: ```python my_tarfile.extraction_filter = tarfile.data_filter my_tarfile.extractall() ``` - Используйте фильтр `'data'`; *предупредить*, если он недоступен: ```python if hasattr(tarfile, 'data_filter'): my_tarfile.extractall(filter='data') else: # удалить, когда больше не нужно warn_the_user('Extracting may be unsafe; consider updating Python') my_tarfile.extractall() ``` ### Пример фильтра извлечения с состоянием Хотя методы извлечения *tarfile* принимают простой вызываемый объект *filter*, пользовательские фильтры могут быть более сложными объектами с внутренним состоянием. Может быть полезно реализовать их в виде контекстных менеджеров, чтобы использовать следующим образом: ```python with StatefulFilter() as filter_func: tar.extractall(path, filter=filter_func) ``` Такой фильтр можно написать, например, так: ```python class StatefulFilter: def __init__(self): self.file_count = 0 def __enter__(self): return self def __call__(self, member, path): self.file_count += 1 return member def __exit__(self, *exc_info): print(f'{self.file_count} files extracted') ``` ## Интерфейс командной строки Новое в версии 3.4. Модуль [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) предоставляет простой интерфейс командной строки для работы с tar-архивами. Если вы хотите создать новый tar-архив, укажите его имя после опции [`-c`](https://python-all.ru/3.11/library/tarfile.html#cmdoption-tarfile-c), а затем перечислите имена файлов, которые должны быть включены: ```console $ python -m tarfile -c monty.tar spam.txt eggs.txt ``` Можно также передать каталог: ```console $ python -m tarfile -c monty.tar life-of-brian_1979/ ``` Если вы хотите извлечь tar-архив в текущий каталог, используйте опцию [`-e`](https://python-all.ru/3.11/library/tarfile.html#cmdoption-tarfile-e): ```console $ python -m tarfile -e monty.tar ``` Вы также можете извлечь tar-архив в другой каталог, передав его имя: ```console $ python -m tarfile -e monty.tar other-dir/ ``` Чтобы получить список файлов в tar-архиве, используйте опцию [`-l`](https://python-all.ru/3.11/library/tarfile.html#cmdoption-tarfile-l): ```console $ python -m tarfile -l monty.tar ``` ### Параметры командной строки #### `-l ` #### `--list ` Выводит список файлов в tar-архиве. #### `-c ... ` #### `--create ... ` Создаёт tar-архив из исходных файлов. #### `-e []` #### `--extract []` Извлекает tar-архив в текущий каталог, если *output\_dir* не указан. #### `-t ` #### `--test ` Проверяет, является ли tar-файл допустимым. #### `-v, --verbose` Подробный вывод. #### `--filter ` Указывает *фильтр* для `--extract`. Подробнее см. [Фильтры извлечения](https://python-all.ru/3.11/library/tarfile.html#tarfile-extraction-filter). Принимаются только строковые имена (то есть `fully_trusted`, `tar`, и `data`). Новое в версии 3.11.4. ## Примеры Как извлечь полный tar-архив в текущий рабочий каталог: ```python import tarfile tar = tarfile.open("sample.tar.gz") tar.extractall() tar.close() ``` Как извлечь подмножество tar-архива с помощью [`TarFile.extractall()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.extractall), используя функцию-генератор вместо списка: ```python import os import tarfile def py_files(members): for tarinfo in members: if os.path.splitext(tarinfo.name)[1] == ".py": yield tarinfo tar = tarfile.open("sample.tar.gz") tar.extractall(members=py_files(tar)) tar.close() ``` Как создать несжатый tar-архив из списка имён файлов: ```python import tarfile tar = tarfile.open("sample.tar", "w") for name in ["foo", "bar", "quux"]: tar.add(name) tar.close() ``` Тот же пример с использованием оператора [`with`](https://python-all.ru/3.11/reference/compound_stmts.html#with): ```python import tarfile with tarfile.open("sample.tar", "w") as tar: for name in ["foo", "bar", "quux"]: tar.add(name) ``` Как прочитать tar-архив, сжатый gzip, и вывести информацию о некоторых элементах: ```python import tarfile tar = tarfile.open("sample.tar.gz", "r:gz") for tarinfo in tar: print(tarinfo.name, "is", tarinfo.size, "bytes in size and is ", end="") if tarinfo.isreg(): print("a regular file.") elif tarinfo.isdir(): print("a directory.") else: print("something else.") tar.close() ``` Как создать архив и сбросить информацию о пользователе, используя параметр *фильтр* в [`TarFile.add()`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile.add): ```python import tarfile def reset(tarinfo): tarinfo.uid = tarinfo.gid = 0 tarinfo.uname = tarinfo.gname = "root" return tarinfo tar = tarfile.open("sample.tar.gz", "w:gz") tar.add("foo", filter=reset) tar.close() ``` ## Поддерживаемые форматы tar Существует три формата tar, которые можно создать с помощью модуля [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile): - Формат POSIX.1-1988 ustar ([`USTAR_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.USTAR_FORMAT)). Он поддерживает имена файлов длиной не более 256 символов и имена ссылок – до 100 символов. Максимальный размер файла – 8 ГиБ. Это старый и ограниченный, но широко поддерживаемый формат. - Формат GNU tar ([`GNU_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.GNU_FORMAT)). Он поддерживает длинные имена файлов и ссылок, файлы размером более 8 ГиБ и разрежённые файлы. Это де-факто стандарт в системах GNU/Linux. [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) полностью поддерживает расширения GNU tar для длинных имён; поддержка разрежённых файлов – только для чтения. - Формат POSIX.1-2001 pax ([`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT)). Это самый гибкий формат, практически без ограничений. Он поддерживает длинные имена файлов и ссылок, большие файлы и хранит пути переносимым способом. Современные реализации tar, включая GNU tar, bsdtar/libarchive и star, полностью поддерживают расширенные возможности *pax*; некоторые старые или неподдерживаемые библиотеки могут не поддерживать, но должны обрабатывать архивы *pax* так, как если бы они были в универсально поддерживаемом формате *ustar*. Это текущий формат по умолчанию для новых архивов. Он расширяет существующий формат *ustar* дополнительными заголовками для информации, которую иначе нельзя сохранить. Существует две разновидности заголовков pax: расширенные заголовки влияют только на последующий заголовок файла, глобальные заголовки действительны для всего архива и влияют на все последующие файлы. Все данные в заголовке pax кодируются в *UTF-8* по соображениям переносимости. Существуют ещё некоторые варианты формата tar, которые можно читать, но не создавать: - Древний формат V7. Это первый формат tar из Unix Seventh Edition, хранящий только обычные файлы и каталоги. Имена не должны быть длиннее 100 символов, информация об имени пользователя/группы отсутствует. Некоторые архивы имеют неправильные контрольные суммы заголовков в случае полей с не-ASCII символами. - Расширенный формат SunOS tar. Этот формат является вариантом формата POSIX.1-2001 pax, но несовместим с ним. ## Проблемы Unicode Формат tar изначально был задуман для создания резервных копий на ленточных накопителях с основным упором на сохранение информации о файловой системе. Сегодня tar-архивы обычно используются для распространения файлов и обмена архивами по сетям. Одна проблема исходного формата (который является основой всех других форматов) заключается в том, что нет концепции поддержки разных кодировок символов. Например, обычный tar-архив, созданный в системе с *UTF-8*, не может быть корректно прочитан в системе с *Latin-1*, если он содержит символы, отличные от *ASCII*. Текстовые метаданные (например, имена файлов, имена ссылок, имена пользователей/групп) будут повреждены. К сожалению, нет способа автоматически определить кодировку архива. Формат pax был разработан для решения этой проблемы. Он хранит не-ASCII метаданные, используя универсальную кодировку символов *UTF-8*. Детали преобразования символов в [`tarfile`](https://python-all.ru/3.11/library/tarfile.html#module-tarfile) управляются ключевыми аргументами *encoding* и *errors* класса [`TarFile`](https://python-all.ru/3.11/library/tarfile.html#tarfile.TarFile). *encoding* определяет кодировку символов, используемую для метаданных в архиве. Значение по умолчанию – [`sys.getfilesystemencoding()`](https://python-all.ru/3.11/library/sys.html#sys.getfilesystemencoding) или `'ascii'` в качестве запасного варианта. В зависимости от того, читается или записывается архив, метаданные должны быть либо декодированы, либо закодированы. Если *encoding* не установлена соответствующим образом, это преобразование может завершиться ошибкой. Аргумент *errors* определяет, как обрабатываются символы, которые невозможно преобразовать. Возможные значения перечислены в разделе [Обработчики ошибок](https://python-all.ru/3.11/library/codecs.html#error-handlers). Схема по умолчанию – `'surrogateescape'`, которую Python также использует для своих системных вызовов, см. [Имена файлов, аргументы командной строки и переменные окружения](https://python-all.ru/3.11/library/os.html#os-filenames). Для архивов [`PAX_FORMAT`](https://python-all.ru/3.11/library/tarfile.html#tarfile.PAX_FORMAT) (по умолчанию) *encoding* обычно не требуется, потому что все метаданные хранятся с использованием *UTF-8*. *encoding* используется только в редких случаях, когда декодируются бинарные заголовки pax или когда хранятся строки с суррогатными символами.