`tarfile.md`

963 строк · 89.4 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3/library/tarfile.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `tarfile` – Чтение и запись файлов tar-архивов89**Исходный код:** [Lib/tarfile.py](https://python-all.ru/src/3.14/Lib/tarfile.py)1011---1213Модуль `tarfile` позволяет читать и записывать tar-архивы, в том числе сжатые gzip, bz2 и lzma. Используйте модуль [`zipfile`](https://python-all.ru/3/library/zipfile.html#module-zipfile) для чтения и записи файлов `.zip` или функции более высокого уровня из [shutil](https://python-all.ru/3/library/shutil.html#archiving-operations).1415Некоторые факты и цифры:1617- читает и записывает архивы [`gzip`](https://python-all.ru/3/library/gzip.html#module-gzip), [`bz2`](https://python-all.ru/3/library/bz2.html#module-bz2), [`compression.zstd`](https://python-all.ru/3/library/compression.zstd.html#module-compression.zstd) и [`lzma`](https://python-all.ru/3/library/lzma.html#module-lzma), если соответствующие модули доступны.1819  Если каких-либо из этих [дополнительных модулей](https://python-all.ru/3/glossary.html#term-optional-module) нет в вашей копии CPython, обратитесь к документации от распространителя (то есть того, кто предоставил вам Python). Если вы распространитель, см. [Требования к дополнительным модулям](https://python-all.ru/3/using/configure.html#optional-module-requirements).20- поддержка чтения/записи формата POSIX.1-1988 (ustar).21- поддержка чтения/записи формата GNU tar, включая расширения *longname* и *longlink*, поддержка только чтения всех вариантов расширения *sparse*, включая восстановление разрежённых файлов.22- поддержка чтения/записи формата POSIX.1-2001 (pax).23- работает с директориями, обычными файлами, жёсткими ссылками, символическими ссылками, каналами FIFO, символьными и блочными устройствами, а также может получать и восстанавливать информацию о файлах, такую как временная метка, права доступа и владелец.2425Изменено в версии 3.3: Добавлена поддержка сжатия [`lzma`](https://python-all.ru/3/library/lzma.html#module-lzma).2627Изменено в версии 3.12: Архивы извлекаются с использованием [фильтра](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-filter), что позволяет либо ограничить неожиданные/опасные возможности, либо признать их ожидаемыми и полностью доверять архиву.2829Изменено в версии 3.14: Фильтр извлечения по умолчанию установлен на [`data`](https://python-all.ru/3/library/tarfile.html#tarfile.data_filter), что запрещает некоторые опасные возможности, такие как ссылки на абсолютные пути или пути за пределами целевой директории. Ранее стратегия фильтрации была эквивалентна [`fully_trusted`](https://python-all.ru/3/library/tarfile.html#tarfile.fully_trusted_filter).3031Изменено в версии 3.14: Добавлена поддержка сжатия Zstandard с использованием [`compression.zstd`](https://python-all.ru/3/library/compression.zstd.html#module-compression.zstd).3233#### `tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)`3435Возвращает объект [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile) для имени пути *name*. Подробную информацию об объектах `TarFile` и допустимых именованных аргументах см. в разделе [Объекты TarFile](https://python-all.ru/3/library/tarfile.html#tarfile-objects).3637*mode* должен быть строкой вида `'filemode[:compression]'`, по умолчанию равен `'r'`. Вот полный список комбинаций режимов:3839| Режим | Действие |40| --- | --- |41| `'r'` или `'r:*'` | Открыть для чтения с прозрачным сжатием (рекомендуется). |42| `'r:'` | Открыть для чтения исключительно без сжатия. |43| `'r:gz'` | Открыть для чтения со сжатием gzip. |44| `'r:bz2'` | Открыть для чтения со сжатием bzip2. |45| `'r:xz'` | Открыть для чтения со сжатием lzma. |46| `'r:zst'` | Открыть для чтения со сжатием Zstandard. |47| `'x'` или `'x:'` | Создать tar-файл исключительно без сжатия. Вызывает исключение [`FileExistsError`](https://python-all.ru/3/library/exceptions.html#FileExistsError), если файл уже существует. |48| `'x:gz'` | Создать tar-файл со сжатием gzip. Вызывает исключение [`FileExistsError`](https://python-all.ru/3/library/exceptions.html#FileExistsError), если файл уже существует. |49| `'x:bz2'` | Создать tar-файл со сжатием bzip2. Вызывает исключение [`FileExistsError`](https://python-all.ru/3/library/exceptions.html#FileExistsError), если файл уже существует. |50| `'x:xz'` | Создать tar-файл со сжатием lzma. Вызывает исключение [`FileExistsError`](https://python-all.ru/3/library/exceptions.html#FileExistsError), если файл уже существует. |51| `'x:zst'` | Создать tar-файл со сжатием Zstandard. Вызывает исключение [`FileExistsError`](https://python-all.ru/3/library/exceptions.html#FileExistsError), если файл уже существует. |52| `'a'` или `'a:'` | Открыть для добавления без сжатия. Файл создаётся, если он не существует. |53| `'w'` или `'w:'` | Открывается для записи без сжатия. |54| `'w:gz'` | Открывается для записи со сжатием gzip. |55| `'w:bz2'` | Открывается для записи со сжатием bzip2. |56| `'w:xz'` | Открывается для записи со сжатием lzma. |57| `'w:zst'` | Открывается для записи со сжатием Zstandard. |5859Обратите внимание, что `'a:gz'`, `'a:bz2'` или `'a:xz'` невозможны. Если *режим* не подходит для открытия определённого (сжатого) файла для чтения, возбуждается [`ReadError`](https://python-all.ru/3/library/tarfile.html#tarfile.ReadError). Используйте *режим* `'r'`, чтобы избежать этого. Если метод сжатия не поддерживается, возбуждается [`CompressionError`](https://python-all.ru/3/library/tarfile.html#tarfile.CompressionError).6061Если указан *fileobj*, он используется вместо [файлового объекта](https://python-all.ru/3/glossary.html#term-file-object), открытого в бинарном режиме для *имени*. Предполагается, что он находится на позиции 0.6263Для режимов `'w:gz'`, `'x:gz'`, `'w|gz'`, `'w:bz2'`, `'x:bz2'`, `'w|bz2'`, `tarfile.open()` принимает именованный аргумент *compresslevel* (по умолчанию `9`) для указания уровня сжатия файла.6465Для режимов `'w:xz'`, `'x:xz'` и `'w|xz'`, `tarfile.open()` принимает именованный аргумент *preset* для указания уровня сжатия файла.6667Для режимов `'w:zst'`, `'x:zst'` и `'w|zst'`, `tarfile.open()` принимает именованный аргумент *level* для указания уровня сжатия файла. Также можно передать именованный аргумент *options*, задающий дополнительные параметры сжатия Zstandard, описанные в [`CompressionParameter`](https://python-all.ru/3/library/compression.zstd.html#compression.zstd.CompressionParameter). Именованный аргумент *zstd\_dict* можно использовать для передачи [`ZstdDict`](https://python-all.ru/3/library/compression.zstd.html#compression.zstd.ZstdDict), словаря Zstandard, применяемого для улучшения сжатия небольших объёмов данных.6869Для специальных целей существует второй формат для *mode*: `'filemode|[compression]'`. `tarfile.open()` вернёт объект [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile), который обрабатывает данные как поток блоков. Произвольный доступ к файлу не осуществляется. Если передан *fileobj*, им может быть любой объект, имеющий метод [`read()`](https://python-all.ru/3/library/io.html#io.RawIOBase.read) или [`write()`](https://python-all.ru/3/library/io.html#io.RawIOBase.write) (в зависимости от *режима*), работающий с байтами. *bufsize* задаёт размер блока, по умолчанию `20 * 512` байт. Используйте этот вариант в сочетании, например, с `sys.stdin.buffer`, сокетным [файловым объектом](https://python-all.ru/3/glossary.html#term-file-object) или ленточным устройством. Однако такой объект `TarFile` ограничен тем, что не допускает произвольного доступа; см. [Примеры](https://python-all.ru/3/library/tarfile.html#tar-examples). Текущие возможные режимы:7071| Режим | Действие |72| --- | --- |73| `'r\|*'` | Открывает *поток данных* tar-блоков для чтения с прозрачным сжатием. |74| `'r\|'` | Открывает *поток данных* несжатых tar-блоков для чтения. |75| `'r\|gz'` | Открывает сжатый gzip *поток данных* для чтения. |76| `'r\|bz2'` | Открывает сжатый bzip2 *поток данных* для чтения. |77| `'r\|xz'` | Открывает сжатый lzma *поток данных* для чтения. |78| `'r\|zst'` | Открывает сжатый Zstandard *поток данных* для чтения. |79| `'w\|'` | Открывает несжатый *поток данных* для записи. |80| `'w\|gz'` | Открывает сжатый gzip *поток данных* для записи. |81| `'w\|bz2'` | Открывает сжатый bzip2 *поток данных* для записи. |82| `'w\|xz'` | Открывает сжатый lzma *поток данных* для записи. |83| `'w\|zst'` | Открывает сжатый Zstandard *поток данных* для записи. |8485Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание).8687Изменено в версии 3.6: Параметр *name* теперь принимает [путеподобный объект](https://python-all.ru/3/glossary.html#term-path-like-object).8889Изменено в версии 3.12: Именованный аргумент *compresslevel* теперь также работает для потоков данных.9091Изменено в версии 3.14: Именованный аргумент *preset* теперь также работает для потоков данных.9293#### `class tarfile.TarFile`9495Класс для чтения и записи tar-архивов. Не используйте этот класс напрямую: вместо него используйте [`tarfile.open()`](https://python-all.ru/3/library/tarfile.html#tarfile.open). См. [Объекты TarFile](https://python-all.ru/3/library/tarfile.html#tarfile-objects).9697#### `tarfile.is_tarfile(name)`9899Возвращает [`True`](https://python-all.ru/3/library/constants.html#True), если *name* является tar-архивом, который может прочитать модуль `tarfile`. *name* может быть [`str`](https://python-all.ru/3/library/stdtypes.html#str), файлом или файлоподобным объектом.100101Изменено в версии 3.9: Добавлена поддержка файлов и файлоподобных объектов.102103Модуль `tarfile` определяет следующие исключения:104105#### `exception tarfile.TarError`106107Базовый класс для всех исключений `tarfile`.108109#### `exception tarfile.ReadError`110111Возникает при открытии tar-архива, который не может быть обработан модулем `tarfile` или является некорректным.112113#### `exception tarfile.CompressionError`114115Возникает, когда метод сжатия не поддерживается или данные не удаётся корректно декодировать.116117#### `exception tarfile.StreamError`118119Возникает при ограничениях, типичных для объектов, работающих в режиме потока [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile).120121#### `exception tarfile.ExtractError`122123Возникает при *нефатальных* ошибках при использовании [`TarFile.extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract), но только если [`TarFile.errorlevel`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.errorlevel)`== 2`.124125#### `exception tarfile.HeaderError`126127Возникает при вызове [`TarInfo.frombuf()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.frombuf), если полученный буфер некорректен.128129#### `exception tarfile.FilterError`130131Базовый класс для элементов, [отклонённых](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-refuse) фильтрами.132133#### `tarinfo`134135Информация об элементе, который фильтр отказался извлекать, в виде [TarInfo](https://python-all.ru/3/library/tarfile.html#tarinfo-objects).136137#### `exception tarfile.AbsolutePathError`138139Возникает при отказе извлекать элемент с абсолютным путём.140141#### `exception tarfile.OutsideDestinationError`142143Возникает при отказе извлекать элемент за пределами целевого каталога.144145#### `exception tarfile.SpecialFileError`146147Возникает при отказе извлекать специальный файл (например, устройство или канал).148149#### `exception tarfile.AbsoluteLinkError`150151Возникает при отказе извлекать символическую ссылку с абсолютным путём.152153#### `exception tarfile.LinkOutsideDestinationError`154155Возникает при отказе извлекать символическую ссылку, указывающую за пределы целевого каталога.156157#### `exception tarfile.LinkFallbackError`158159Возникает при отказе эмулировать ссылку (жёсткую или символическую) путём извлечения другого элемента архива, если этот элемент был бы отклонён расположением фильтра. Исключение, вызванное для отклонения заменяющего элемента, доступно как `BaseException.__context__`.160161Добавлено в версии 3.14.162163На уровне модуля доступны следующие константы:164165#### `tarfile.ENCODING`166167Кодировка символов по умолчанию: `'utf-8'` в Windows, значение, возвращаемое [`sys.getfilesystemencoding()`](https://python-all.ru/3/library/sys.html#sys.getfilesystemencoding) в остальных случаях.168169#### `tarfile.REGTYPE`170171#### `tarfile.AREGTYPE`172173Обычный файл [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).174175#### `tarfile.LNKTYPE`176177Ссылка (внутри tar-файла) [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).178179#### `tarfile.SYMTYPE`180181Символическая ссылка [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).182183#### `tarfile.CHRTYPE`184185Символьное устройство [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).186187#### `tarfile.BLKTYPE`188189Блочное устройство [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).190191#### `tarfile.DIRTYPE`192193Каталог [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).194195#### `tarfile.FIFOTYPE`196197FIFO-устройство [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).198199#### `tarfile.CONTTYPE`200201Непрерывный файл [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).202203#### `tarfile.GNUTYPE_LONGNAME`204205Длинное имя GNU tar [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).206207#### `tarfile.GNUTYPE_LONGLINK`208209Длинная ссылка GNU tar [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).210211#### `tarfile.GNUTYPE_SPARSE`212213Разрежённый файл GNU tar [`type`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.type).214215Каждая из следующих констант определяет формат tar-архива, который модуль `tarfile` может создавать. Подробнее см. раздел [Поддерживаемые форматы tar](https://python-all.ru/3/library/tarfile.html#tar-formats) для получения подробностей.216217#### `tarfile.USTAR_FORMAT`218219Формат POSIX.1-1988 (ustar).220221#### `tarfile.GNU_FORMAT`222223Формат GNU tar.224225#### `tarfile.PAX_FORMAT`226227Формат POSIX.1-2001 (pax).228229#### `tarfile.DEFAULT_FORMAT`230231Формат по умолчанию для создания архивов. В настоящее время это [`PAX_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.PAX_FORMAT).232233Изменено в версии 3.8: Формат по умолчанию для новых архивов был изменён на [`PAX_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.PAX_FORMAT) с [`GNU_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.GNU_FORMAT).234235> **См. также**236>237> **Модуль [`zipfile`](https://python-all.ru/3/library/zipfile.html#module-zipfile)**238>239> Документация стандартного модуля [`zipfile`](https://python-all.ru/3/library/zipfile.html#module-zipfile).240>241> **[Операции архивирования](https://python-all.ru/3/library/shutil.html#archiving-operations)**242>243> Документация средств архивирования высокого уровня, предоставляемых стандартным модулем [`shutil`](https://python-all.ru/3/library/shutil.html#module-shutil).244>245> **[Руководство GNU tar, базовый формат tar](https://python-all.ru/3/library/tarfile.html)**246>247> Документация для файлов архивов tar, включая расширения GNU tar.248249## Объекты TarFile250251Объект [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile) предоставляет интерфейс к архиву tar. Архив tar представляет собой последовательность блоков. Элемент архива (хранимый файл) состоит из заголовочного блока, за которым следуют блоки данных. Файл можно сохранить в архив tar несколько раз. Каждый элемент архива представляется объектом [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo), подробнее см. [Объекты TarInfo](https://python-all.ru/3/library/tarfile.html#tarinfo-objects).252253Объект [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile) можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3/reference/compound_stmts.html#with). Он будет автоматически закрыт по завершении блока. Обратите внимание: в случае исключения архив, открытый для записи, не будет финализирован; будет закрыт только внутренний файловый объект. Пример использования см. в разделе [Примеры](https://python-all.ru/3/library/tarfile.html#tar-examples).254255Добавлено в версии 3.2: Добавлена поддержка протокола контекстного менеджмента.256257#### `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, stream=False)`258259Все последующие аргументы необязательны и также могут быть доступны как атрибуты экземпляра.260261*name* – это путь к архиву. *name* может быть [объектом, подобным пути](https://python-all.ru/3/glossary.html#term-path-like-object). Его можно опустить, если указан *fileobj*. В этом случае используется атрибут файлового объекта `name`, если он существует.262263*mode* может быть `'r'` для чтения из существующего архива, `'a'` для добавления данных в существующий файл, `'w'` для создания нового файла с перезаписью существующего или `'x'` для создания нового файла только в том случае, если он ещё не существует.264265Если указан *fileobj*, он используется для чтения или записи данных. Если это можно определить, *mode* переопределяется режимом *fileobj*. *fileobj* будет использоваться с позиции 0.266267> **Примечание**268>269> *fileobj* не закрывается при закрытии `TarFile`.270271*format* управляет форматом архива для записи. Он должен быть одной из констант [`USTAR_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.USTAR_FORMAT), [`GNU_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.GNU_FORMAT) или [`PAX_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.PAX_FORMAT), определённых на уровне модуля. При чтении формат будет определён автоматически, даже если в одном архиве присутствуют разные форматы.272273Аргумент *tarinfo* можно использовать для замены класса по умолчанию [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) на другой.274275Если *dereference* равно [`False`](https://python-all.ru/3/library/constants.html#False), в архив добавляются символические и жёсткие ссылки. Если [`True`](https://python-all.ru/3/library/constants.html#True), в архив добавляется содержимое целевых файлов. Это не влияет на системы, не поддерживающие символические ссылки.276277Если *ignore\_zeros* равно [`False`](https://python-all.ru/3/library/constants.html#False), пустой блок считается концом архива. Если [`True`](https://python-all.ru/3/library/constants.html#True), пустые (и недействительные) блоки пропускаются, и предпринимается попытка получить как можно больше элементов. Это полезно только для чтения объединённых или повреждённых архивов.278279*debug* может быть установлен от `0` (нет отладочных сообщений) до `3` (все отладочные сообщения). Сообщения записываются в `sys.stderr`.280281*errorlevel* управляет обработкой ошибок извлечения, см. [`the corresponding attribute`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.errorlevel).282283Аргументы *encoding* и *errors* определяют кодировку символов, используемую для чтения или записи архива, и способ обработки ошибок преобразования. Настройки по умолчанию подходят для большинства пользователей. Подробную информацию см. в разделе [Проблемы Unicode](https://python-all.ru/3/library/tarfile.html#tar-unicode).284285Аргумент *pax\_headers* – необязательный словарь строк, который будет добавлен как глобальный заголовок pax, если *format* равно [`PAX_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.PAX_FORMAT).286287Если *поток данных* установлен в [`True`](https://python-all.ru/3/library/constants.html#True), то при чтении архива информация о файлах в архиве не кэшируется, экономя память.288289Изменено в версии 3.2: Используется `'surrogateescape'` как значение по умолчанию для аргумента *errors*.290291Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание).292293Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3/glossary.html#term-path-like-object).294295Изменено в версии 3.13: Добавлен параметр *поток данных*.296297#### `classmethod TarFile.open(...)`298299Альтернативный конструктор. Функция [`tarfile.open()`](https://python-all.ru/3/library/tarfile.html#tarfile.open) на самом деле является сокращением для этого метода класса.300301#### `TarFile.getmember(name)`302303Возвращает объект [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) для элемента *name*. Если *name* не найден в архиве, возбуждается [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError).304305> **Примечание**306>307> Если элемент встречается в архиве более одного раза, последнее его вхождение считается самой актуальной версией.308309#### `TarFile.getmembers()`310311Возвращает элементы архива в виде списка объектов [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo). Порядок списка соответствует порядку элементов в архиве.312313#### `TarFile.getnames()`314315Возвращает элементы в виде списка их имён. Порядок списка соответствует порядку списка, возвращаемого [`getmembers()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.getmembers).316317#### `TarFile.list(verbose=True, *, members=None)`318319Выводит оглавление в `sys.stdout`. Если *verbose* равно [`False`](https://python-all.ru/3/library/constants.html#False), печатаются только имена элементов. Если же [`True`](https://python-all.ru/3/library/constants.html#True), выводятся данные, аналогичные **ls -l**. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.getmembers).320321Изменено в версии 3.5: Добавлен параметр *members*.322323#### `TarFile.next()`324325Возвращает следующий элемент архива в виде объекта [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo), когда [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile) открыт для чтения. Если больше нет элементов, возвращает [`None`](https://python-all.ru/3/library/constants.html#None).326327#### `TarFile.extractall(path='.', members=None, *, numeric_owner=False, filter=None)`328329Извлекает все элементы из архива в текущую рабочую директорию или в директорию *path*. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.getmembers). Сведения о директории (владелец, время изменения, права доступа) устанавливаются после извлечения всех элементов. Это сделано для обхода двух проблем: время изменения директории сбрасывается при каждом создании в ней файла, и если права директории не разрешают запись, извлечение в неё файлов завершится ошибкой.330331Если *numeric\_owner* равно [`True`](https://python-all.ru/3/library/constants.html#True), для установки владельца и группы извлечённых файлов используются числовые uid и gid из tar-файла. В противном случае используются именованные значения из tar-файла.332333Аргумент *filter* определяет, как `members` изменяются или отклоняются перед извлечением. Подробнее см. в разделе [Фильтры извлечения](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-filter). Рекомендуется задавать его явно только в тех случаях, когда требуются специфические возможности *tar*, или в качестве `filter='data'` для поддержки версий Python с менее безопасным значением по умолчанию (3.13 и ниже).334335> **Предупреждение**336>337> Никогда не извлекайте архивы из ненадёжных источников без предварительной проверки.338>339> Начиная с Python 3.14, значение по умолчанию ([`data`](https://python-all.ru/3/library/tarfile.html#tarfile.data_filter)) предотвращает наиболее опасные проблемы безопасности. Однако оно не предотвращает *все* непреднамеренные или небезопасные действия. Подробнее читайте в разделе [Фильтры извлечения](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-filter).340341Изменено в версии 3.5: Добавлен параметр *numeric\_owner*.342343Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3/glossary.html#term-path-like-object).344345Изменено в версии 3.12: Добавлен параметр *filter*.346347Изменено в версии 3.14: Параметр *filter* теперь по умолчанию равен `'data'`.348349#### `TarFile.extract(member, path='', set_attrs=True, *, numeric_owner=False, filter=None)`350351Извлекает элемент из архива в текущую рабочую директорию, используя его полное имя. Информация о файле извлекается максимально точно. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo). Можно указать другую директорию с помощью *path*. *path* может быть [объектом, подобным пути](https://python-all.ru/3/glossary.html#term-path-like-object). Атрибуты файла (владелец, mtime, права доступа) устанавливаются, если *set\_attrs* не равно false.352353Аргументы *numeric\_owner* и *filter* такие же, как для [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall).354355> **Примечание**356>357> Метод `extract()` не решает ряд проблем извлечения. В большинстве случаев стоит рассмотреть использование метода [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall).358359> **Предупреждение**360>361> Никогда не извлекайте архивы из ненадёжных источников без предварительной проверки. Подробнее см. предупреждение для [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall).362363Изменено в версии 3.2: Добавлен параметр *set\_attrs*.364365Изменено в версии 3.5: Добавлен параметр *numeric\_owner*.366367Изменено в версии 3.6: Параметр *path* теперь принимает [объект, подобный пути](https://python-all.ru/3/glossary.html#term-path-like-object).368369Изменено в версии 3.12: Добавлен параметр *filter*.370371#### `TarFile.extractfile(member)`372373Извлекает элемент из архива в виде файлового объекта. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo). Если *member* – обычный файл или ссылка, возвращается объект [`io.BufferedReader`](https://python-all.ru/3/library/io.html#io.BufferedReader). Для всех остальных существующих элементов возвращается [`None`](https://python-all.ru/3/library/constants.html#None). Если *member* не найден в архиве, вызывается [`KeyError`](https://python-all.ru/3/library/exceptions.html#KeyError).374375Изменено в версии 3.3: Возвращается объект [`io.BufferedReader`](https://python-all.ru/3/library/io.html#io.BufferedReader).376377Изменено в версии 3.13: Возвращаемый объект [`io.BufferedReader`](https://python-all.ru/3/library/io.html#io.BufferedReader) имеет атрибут `mode` который всегда равен `'rb'`.378379#### `TarFile.errorlevel: int`380381Если *errorlevel* равен `0`, ошибки игнорируются при использовании [`TarFile.extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) и [`TarFile.extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall). Тем не менее, они отображаются как сообщения об ошибках в отладочном выводе, когда *debug* больше 0. Если `1` (по умолчанию), все *фатальные* ошибки вызываются как исключения [`OSError`](https://python-all.ru/3/library/exceptions.html#OSError) или [`FilterError`](https://python-all.ru/3/library/tarfile.html#tarfile.FilterError). Если `2`, все *нефатальные* ошибки также вызываются как исключения [`TarError`](https://python-all.ru/3/library/tarfile.html#tarfile.TarError).382383Некоторые исключения, например, вызванные неправильными типами аргументов или повреждением данных, всегда вызываются.384385Пользовательские [фильтры извлечения](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-filter) должны вызывать [`FilterError`](https://python-all.ru/3/library/tarfile.html#tarfile.FilterError) для *фатальных* ошибок и [`ExtractError`](https://python-all.ru/3/library/tarfile.html#tarfile.ExtractError) для *нефатальных*.386387Обратите внимание, что при возникновении исключения архив может быть извлечён частично. Ответственность за очистку лежит на пользователе.388389#### `TarFile.extraction_filter`390391Добавлено в версии 3.12.392393[Фильтр извлечения](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-filter), используемый по умолчанию для аргумента *filter* методов [`extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall).394395Атрибут может быть `None` или вызываемым объектом. Строковые имена для этого атрибута не допускаются, в отличие от аргумента *filter* для [`extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract).396397Если `extraction_filter` равен `None` (по умолчанию), методы извлечения будут по умолчанию использовать фильтр [`data`](https://python-all.ru/3/library/tarfile.html#tarfile.data_filter).398399Атрибут может быть установлен для экземпляров или переопределён в подклассах. Также возможно установить его для самого класса `TarFile`, чтобы задать глобальное значение по умолчанию; однако, поскольку это влияет на все случаи использования *tarfile*, лучшей практикой будет делать это только в приложениях верхнего уровня или [`site configuration`](https://python-all.ru/3/library/site.html#module-site). Чтобы задать глобальное значение по умолчанию таким образом, функцию фильтра необходимо обернуть в [`staticmethod()`](https://python-all.ru/3/library/functions.html#staticmethod), чтобы предотвратить внедрение аргумента `self`.400401Изменено в версии 3.14: Фильтр по умолчанию установлен на [`data`](https://python-all.ru/3/library/tarfile.html#tarfile.data_filter), что запрещает некоторые опасные возможности, такие как ссылки на абсолютные пути или пути за пределами целевого каталога. Ранее значение по умолчанию было эквивалентно [`fully_trusted`](https://python-all.ru/3/library/tarfile.html#tarfile.fully_trusted_filter).402403#### `TarFile.add(name, arcname=None, recursive=True, *, filter=None)`404405Добавляет файл *name* в архив. *name* может быть любым типом файла (каталог, FIFO, символическая ссылка и т.д.). Если задан, *arcname* указывает альтернативное имя файла в архиве. Каталоги добавляются рекурсивно по умолчанию. Этого можно избежать, установив *recursive* в [`False`](https://python-all.ru/3/library/constants.html#False). Рекурсия добавляет записи в отсортированном порядке. Если задан *filter*, он должен быть функцией, которая принимает аргумент объекта [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) и возвращает изменённый объект `TarInfo`. Если же она возвращает [`None`](https://python-all.ru/3/library/constants.html#None), объект `TarInfo` будет исключён из архива. Пример см. в [Примерах](https://python-all.ru/3/library/tarfile.html#tar-examples).406407Изменено в версии 3.2: Добавлен параметр *filter*.408409Изменено в версии 3.7: Рекурсия добавляет записи в отсортированном порядке.410411#### `TarFile.addfile(tarinfo, fileobj=None)`412413Добавляет объект [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) *tarinfo* в архив. Если *tarinfo* представляет обычный файл ненулевого размера, аргумент *fileobj* должен быть [двоичным файлом](https://python-all.ru/3/glossary.html#term-binary-file), и из него читается `tarinfo.size` байт, которые добавляются в архив. Можно создавать объекты `TarInfo` напрямую или с помощью [`gettarinfo()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.gettarinfo).414415Изменено в версии 3.13: *fileobj* должен быть указан для обычных файлов ненулевого размера.416417#### `TarFile.gettarinfo(name=None, arcname=None, fileobj=None)`418419Создаёт объект [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) из результата [`os.stat()`](https://python-all.ru/3/library/os.html#os.stat) или эквивалентного для существующего файла. Файл задаётся либо именем *name*, либо указывается как [файловый объект](https://python-all.ru/3/glossary.html#term-file-object) *fileobj* с файловым дескриптором. *name* может быть [объектом, подобным пути](https://python-all.ru/3/glossary.html#term-path-like-object). Если задан, *arcname* указывает альтернативное имя файла в архиве; в противном случае имя берётся из атрибута [`name`](https://python-all.ru/3/library/io.html#io.FileIO.name) объекта *fileobj* или из аргумента *name*. Имя должно быть текстовой строкой.420421Можно изменить некоторые атрибуты объекта [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) перед его добавлением с помощью [`addfile()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.addfile). Если файловый объект не является обычным файловым объектом, расположенным в начале файла, такие атрибуты, как [`size`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.size), могут потребовать изменения. Это относится к таким объектам, как [`GzipFile`](https://python-all.ru/3/library/gzip.html#gzip.GzipFile). Атрибут [`name`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.name) также может быть изменён, и в этом случае *arcname* может быть фиктивной строкой.422423Изменено в версии 3.6: Параметр *name* принимает [объект, подобный пути](https://python-all.ru/3/glossary.html#term-path-like-object).424425#### `TarFile.close()`426427Закрывает [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile). В режиме записи в архив добавляются два завершающих нулевых блока.428429#### `TarFile.pax_headers: dict`430431Словарь, содержащий пары ключ-значение глобальных заголовков pax.432433## Объекты TarInfo434435Объект [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) представляет один элемент в [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile). Помимо хранения всех необходимых атрибутов файла (таких как тип, размер, время, права доступа, владелец и т.д.), он предоставляет некоторые полезные методы для определения его типа. Он *не* содержит сами данные файла.436437Объекты [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) возвращаются методами [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile): [`getmember()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.getmember), [`getmembers()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.getmembers) и [`gettarinfo()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.gettarinfo).438439Изменение объектов, возвращённых методами [`getmember()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.getmember) или [`getmembers()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.getmembers), повлияет на все последующие операции с архивом. В случаях, когда это нежелательно, можно использовать [`copy.copy()`](https://python-all.ru/3/library/copy.html#module-copy) или вызвать метод [`replace()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.replace), чтобы создать изменённую копию за один шаг.440441Некоторые атрибуты могут быть установлены в `None`, чтобы указать, что часть метаданных не используется или неизвестна. Разные методы [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) обрабатывают `None` по-разному:442443- Методы [`extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall) будут игнорировать соответствующие метаданные, оставляя их установленными по умолчанию.444- [`addfile()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.addfile) завершится ошибкой.445- [`list()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.list) выведет строку-заполнитель.446447#### `class tarfile.TarInfo(name='')`448449Создаёт объект `TarInfo`.450451#### `classmethod TarInfo.frombuf(buf, encoding, errors)`452453Создаёт и возвращает объект [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) из строкового буфера *buf*.454455Вызывает [`HeaderError`](https://python-all.ru/3/library/tarfile.html#tarfile.HeaderError), если буфер некорректен.456457#### `classmethod TarInfo.fromtarfile(tarfile)`458459Читает следующий элемент из объекта [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile) *tarfile* и возвращает его в виде объекта [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo).460461#### `TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')`462463Создаёт строковый буфер из объекта [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo). Подробнее об аргументах см. конструктор класса [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile).464465Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`.466467Объект `TarInfo` имеет следующие открытые атрибуты данных:468469#### `TarInfo.name: str`470471Имя элемента архива.472473#### `TarInfo.size: int`474475Размер в байтах.476477#### `TarInfo.mtime: int | float`478479Время последнего изменения в секундах с [начала эпохи](https://python-all.ru/3/library/time.html#epoch), как в [`os.stat_result.st_mtime`](https://python-all.ru/3/library/os.html#os.stat_result.st_mtime).480481Изменено в версии 3.12: Можно установить в `None` для [`extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall), что приведет к пропуску применения этого атрибута при извлечении.482483#### `TarInfo.mode: int`484485Биты прав доступа, как для [`os.chmod()`](https://python-all.ru/3/library/os.html#os.chmod).486487Изменено в версии 3.12: Можно установить в `None` для [`extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall), что приведет к пропуску применения этого атрибута при извлечении.488489#### `TarInfo.type`490491Тип файла. Обычно *type* – это одна из следующих констант: [`REGTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.REGTYPE), [`AREGTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.AREGTYPE), [`LNKTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.LNKTYPE), [`SYMTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.SYMTYPE), [`DIRTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.DIRTYPE), [`FIFOTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.FIFOTYPE), [`CONTTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.CONTTYPE), [`CHRTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.CHRTYPE), [`BLKTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.BLKTYPE), [`GNUTYPE_SPARSE`](https://python-all.ru/3/library/tarfile.html#tarfile.GNUTYPE_SPARSE). Чтобы более удобно определить тип объекта [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo), используйте методы `is*()`, описанные ниже.492493#### `TarInfo.linkname: str`494495Имя целевого файла, которое присутствует только в объектах [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) типов [`LNKTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.LNKTYPE) и [`SYMTYPE`](https://python-all.ru/3/library/tarfile.html#tarfile.SYMTYPE).496497Для символических ссылок (`SYMTYPE`) значение *linkname* указывается относительно каталога, содержащего ссылку. Для жёстких ссылок (`LNKTYPE`) значение *linkname* указывается относительно корня архива.498499#### `TarInfo.uid: int`500501Идентификатор пользователя, который изначально сохранил этот элемент.502503Изменено в версии 3.12: Можно установить в `None` для [`extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall), что приведет к пропуску применения этого атрибута при извлечении.504505#### `TarInfo.gid: int`506507Идентификатор группы пользователя, который изначально сохранил этот элемент.508509Изменено в версии 3.12: Можно установить в `None` для [`extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall), что приведёт к пропуску применения этого атрибута при извлечении.510511#### `TarInfo.uname: str`512513Имя пользователя.514515Изменено в версии 3.12: Можно установить в `None` для [`extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall), что приведёт к пропуску применения этого атрибута при извлечении.516517#### `TarInfo.gname: str`518519Имя группы.520521Изменено в версии 3.12: Можно установить в `None` для [`extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) и [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall), что приведёт к пропуску применения этого атрибута при извлечении.522523#### `TarInfo.chksum: int`524525Контрольная сумма заголовка.526527#### `TarInfo.devmajor: int`528529Старший номер устройства.530531#### `TarInfo.devminor: int`532533Младший номер устройства.534535#### `TarInfo.offset: int`536537Заголовок tar начинается здесь.538539#### `TarInfo.offset_data: int`540541Данные файла начинаются здесь.542543#### `TarInfo.sparse`544545Информация о разреженном элементе.546547#### `TarInfo.pax_headers: dict`548549Словарь, содержащий пары ключ-значение связанного расширенного заголовка pax.550551#### `TarInfo.replace(name=..., mtime=..., mode=..., linkname=..., uid=..., gid=..., uname=..., gname=..., deep=True)`552553Добавлено в версии 3.12.554555Возвращает *новую* копию объекта `TarInfo` с указанными изменёнными атрибутами. Например, чтобы вернуть `TarInfo` с именем группы, установленным в `'staff'`, используйте:556557```python558new_tarinfo = old_tarinfo.replace(gname='staff')559```560561По умолчанию создаётся глубокая копия. Если *deep* равен false, копия поверхностная, то есть `pax_headers` и любые пользовательские атрибуты являются общими с исходным объектом `TarInfo`.562563Объект [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) также предоставляет несколько удобных запросных методов:564565#### `TarInfo.isfile()`566567Возвращает [`True`](https://python-all.ru/3/library/constants.html#True), если объект [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo) является обычным файлом.568569#### `TarInfo.isreg()`570571То же, что и [`isfile()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.isfile).572573#### `TarInfo.isdir()`574575Возвращает [`True`](https://python-all.ru/3/library/constants.html#True), если это каталог.576577#### `TarInfo.issym()`578579Возвращает [`True`](https://python-all.ru/3/library/constants.html#True), если это символическая ссылка.580581#### `TarInfo.islnk()`582583Возвращает [`True`](https://python-all.ru/3/library/constants.html#True), если это жёсткая ссылка.584585#### `TarInfo.ischr()`586587Возвращает [`True`](https://python-all.ru/3/library/constants.html#True), если это символьное устройство.588589#### `TarInfo.isblk()`590591Возвращает [`True`](https://python-all.ru/3/library/constants.html#True), если это блочное устройство.592593#### `TarInfo.isfifo()`594595Возвращает [`True`](https://python-all.ru/3/library/constants.html#True), если это FIFO.596597#### `TarInfo.isdev()`598599Возвращает [`True`](https://python-all.ru/3/library/constants.html#True), если это символьное устройство, блочное устройство или FIFO.600601## Фильтры извлечения602603Добавлено в версии 3.12.604605Формат *tar* предназначен для сохранения всех деталей файловых систем UNIX-подобных ОС, что делает его очень мощным. К сожалению, эти возможности позволяют легко создавать tar-файлы, которые при извлечении могут иметь непреднамеренные – а возможно и вредоносные – эффекты. Например, извлечение tar-файла может перезаписать произвольные файлы различными способами (например, с использованием абсолютных путей, компонентов пути `..` или символических ссылок, влияющих на последующие элементы).606607В большинстве случаев полная функциональность не требуется. Поэтому *tarfile* поддерживает фильтры извлечения: механизм ограничения функциональности, что позволяет смягчить некоторые проблемы безопасности.608609> **Предупреждение**610>611> Ни один из доступных фильтров не блокирует *все* опасные функции архивов. Никогда не извлекайте архивы из непроверенных источников без предварительной проверки. См. также [Подсказки для дальнейшей проверки](https://python-all.ru/3/library/tarfile.html#tarfile-further-verification).612613> **См. также**614>615> **[**PEP 706**](https://python-all.ru/3/library/tarfile.html)**616>617> Содержит дополнительную мотивацию и обоснование дизайна.618619Аргумент *filter* для [`TarFile.extract()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extract) или [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall) может быть:620621- строка `'fully_trusted'`: соблюдать все метаданные, указанные в архиве. Следует использовать, если пользователь полностью доверяет архиву или реализует собственную сложную проверку.622- строка `'tar'`: соблюдать большинство специфических для *tar* возможностей (т.е. возможностей файловых систем UNIX-подобных ОС), но блокировать те, которые могут быть неожиданными или вредоносными. Подробнее см. [`tar_filter()`](https://python-all.ru/3/library/tarfile.html#tarfile.tar_filter).623- строка `'data'`: игнорировать или блокировать большинство специфических для UNIX-подобных файловых систем возможностей. Предназначен для извлечения кроссплатформенных архивов. Подробнее см. [`data_filter()`](https://python-all.ru/3/library/tarfile.html#tarfile.data_filter).624- `None` (по умолчанию): использовать [`TarFile.extraction_filter`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extraction_filter).625626  Если он тоже `None` (по умолчанию), будет использован фильтр `'data'`.627628  > Изменено в версии 3.14: Фильтр по умолчанию установлен на [`data`](https://python-all.ru/3/library/tarfile.html#tarfile.data_filter). Ранее значение по умолчанию было эквивалентно [`fully_trusted`](https://python-all.ru/3/library/tarfile.html#tarfile.fully_trusted_filter).629- Вызываемый объект, который будет вызываться для каждого извлекаемого элемента с объектом [TarInfo](https://python-all.ru/3/library/tarfile.html#tarinfo-objects), описывающим элемент и путь назначения, куда извлекается архив (т.е. один и тот же путь используется для всех элементов):630631  ```python632  filter(member: TarInfo, path: str, /) -> TarInfo | None633  ```634635  Вызываемый объект вызывается непосредственно перед извлечением каждого элемента, поэтому он может учитывать текущее состояние диска. Он может:636637  - вернуть объект [`TarInfo`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo), который будет использоваться вместо метаданных в архиве, или638  - вернуть `None`, в этом случае элемент будет пропущен, или639  - вызвать исключение для прерывания операции или пропуска элемента, в зависимости от [`errorlevel`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.errorlevel). Обратите внимание, что при прерывании извлечения [`extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall) может оставить архив частично извлечённым. Он не пытается выполнить очистку.640641### Именованные фильтры по умолчанию642643Предопределённые именованные фильтры доступны как функции, поэтому их можно повторно использовать в пользовательских фильтрах:644645#### `tarfile.fully_trusted_filter(member, path)`646647Возвращает *элемент* без изменений.648649Это реализует фильтр `'fully_trusted'`.650651#### `tarfile.tar_filter(member, path)`652653Реализует фильтр `'tar'`.654655- Удаляет начальные слеши (`/` и [`os.sep`](https://python-all.ru/3/library/os.html#os.sep)) из имён файлов.656- [Отказывается](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы с абсолютными путями (если имя является абсолютным даже после удаления слешей, например `C:/foo` в Windows). Это вызывает [`AbsolutePathError`](https://python-all.ru/3/library/tarfile.html#tarfile.AbsolutePathError).657- [Отказывается](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы, абсолютный путь которых (после разрешения симлинков) оказался бы за пределами целевой директории. Это вызывает [`OutsideDestinationError`](https://python-all.ru/3/library/tarfile.html#tarfile.OutsideDestinationError).658- Сбрасывает биты высоких режимов (setuid, setgid, sticky) и биты записи для группы и остальных ([`S_IWGRP`](https://python-all.ru/3/library/stat.html#stat.S_IWGRP) | [`S_IWOTH`](https://python-all.ru/3/library/stat.html#stat.S_IWOTH)).659660Возвращает изменённый элемент `TarInfo`.661662#### `tarfile.data_filter(member, path)`663664Реализует фильтр `'data'`. В дополнение к тому, что делает `tar_filter`:665666- Нормализует цели ссылок ([`TarInfo.linkname`](https://python-all.ru/3/library/tarfile.html#tarfile.TarInfo.linkname)) с помощью [`os.path.normpath()`](https://python-all.ru/3/library/os.path.html#os.path.normpath). Обратите внимание, что это удаляет внутренние компоненты `..`, что может изменить смысл ссылки, если путь в `TarInfo.linkname` проходит через символические ссылки.667- [Отказывается](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-refuse) извлекать ссылки (жёсткие или символические), которые указывают на абсолютные пути или ведут за пределы целевой директории.668669  Это вызывает [`AbsoluteLinkError`](https://python-all.ru/3/library/tarfile.html#tarfile.AbsoluteLinkError) или [`LinkOutsideDestinationError`](https://python-all.ru/3/library/tarfile.html#tarfile.LinkOutsideDestinationError).670671  Обратите внимание, что такие файлы отклоняются даже на платформах, не поддерживающих символические ссылки.672- [Отказывается](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-refuse) извлекать файлы устройств (включая каналы). Это вызывает [`SpecialFileError`](https://python-all.ru/3/library/tarfile.html#tarfile.SpecialFileError).673- Для обычных файлов, включая жёсткие ссылки:674675  - Устанавливает права на чтение и запись для владельца ([`S_IRUSR`](https://python-all.ru/3/library/stat.html#stat.S_IRUSR) | [`S_IWUSR`](https://python-all.ru/3/library/stat.html#stat.S_IWUSR)).676  - Удаляет права на выполнение для группы и остальных ([`S_IXGRP`](https://python-all.ru/3/library/stat.html#stat.S_IXGRP) | [`S_IXOTH`](https://python-all.ru/3/library/stat.html#stat.S_IXOTH)), если владелец ими не обладает ([`S_IXUSR`](https://python-all.ru/3/library/stat.html#stat.S_IXUSR)).677- Для остальных файлов (каталогов) устанавливает `mode` в `None`, чтобы методы извлечения пропускали применение битов разрешений.678- Устанавливает информацию о пользователе и группе (`uid`, `gid`, `uname`, `gname`) в `None`, чтобы методы извлечения пропускали её установку.679680Возвращает изменённый элемент `TarInfo`.681682Обратите внимание, что этот фильтр не блокирует *все* опасные возможности архива. Подробнее см. [Рекомендации по дополнительной проверке](https://python-all.ru/3/library/tarfile.html#tarfile-further-verification).683684Изменено в версии 3.14: Цели ссылок теперь нормализуются.685686### Ошибки фильтра687688Когда фильтр отказывается извлекать файл, он возбуждает соответствующее исключение, подкласс [`FilterError`](https://python-all.ru/3/library/tarfile.html#tarfile.FilterError). Это прервёт извлечение, если [`TarFile.errorlevel`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.errorlevel) равно 1 или больше. При `errorlevel=0` ошибка будет зарегистрирована, а элемент будет пропущен, но извлечение продолжится.689690### Рекомендации по дополнительной проверке691692Даже с `filter='data'`, *tarfile* не подходит для извлечения недоверенных файлов без предварительной проверки. Среди прочих проблем, предопределённые фильтры не предотвращают атаки типа «отказ в обслуживании». Пользователям следует проводить дополнительные проверки.693694Вот неполный список аспектов, которые стоит учесть:695696- Извлекайте в [`new temporary directory`](https://python-all.ru/3/library/tempfile.html#tempfile.mkdtemp), чтобы предотвратить, например, использование существующих ссылок, и упростить очистку после неудачного извлечения.697- Запретите символические ссылки, если эта функциональность не требуется.698- При работе с недоверенными данными используйте внешние (например, на уровне ОС) ограничения на использование диска, памяти и процессора.699- Проверяет имена файлов по разрешённому списку символов (для фильтрации управляющих символов, похожих символов, разделителей путей других ОС и т.д.).700- Проверяет, что имена файлов имеют ожидаемые расширения (чтобы исключить файлы, запускающиеся при двойном щелчке, или файлы без расширения, например специальные имена устройств Windows).701- Ограничивает количество извлечённых файлов, общий объём извлечённых данных, длину имён файлов (включая длину символических ссылок) и размер отдельных файлов.702- Проверяет наличие файлов, которые будут затенены на файловых системах без учёта регистра.703704Также обратите внимание:705706- Tar-файлы могут содержать несколько версий одного и того же файла. Ожидается, что более поздние версии перезапишут любые предыдущие. Эта возможность критически важна для обновления ленточных архивов, но может быть злонамеренно использована.707- *tarfile* не защищает от проблем с «активными» данными, например, когда злоумышленник манипулирует целевым (или исходным) каталогом во время извлечения (или архивирования).708709### Поддержка старых версий Python710711Фильтры извлечения были добавлены в Python 3.12, но могут быть перенесены на старые версии в качестве обновлений безопасности. Чтобы проверить, доступна ли эта возможность, используйте, например, `hasattr(tarfile, 'data_filter')`, а не проверку версии Python.712713Следующие примеры показывают, как поддерживать версии Python с этой возможностью и без неё. Обратите внимание, что установка `extraction_filter` повлияет на все последующие операции.714715- Полностью доверенный архив:716717  ```python718  my_tarfile.extraction_filter = (lambda member, path: member)719  my_tarfile.extractall()720  ```721- Используйте фильтр `'data'`, если он доступен, иначе вернитесь к поведению Python 3.11 (`'fully_trusted'`), если эта возможность недоступна:722723  ```python724  my_tarfile.extraction_filter = getattr(tarfile, 'data_filter',725                                         (lambda member, path: member))726  my_tarfile.extractall()727  ```728- Используйте фильтр `'data'`; *завершить ошибкой*, если он недоступен:729730  ```python731  my_tarfile.extractall(filter=tarfile.data_filter)732  ```733734  или:735736  ```python737  my_tarfile.extraction_filter = tarfile.data_filter738  my_tarfile.extractall()739  ```740- Используйте фильтр `'data'`; *предупредить*, если он недоступен:741742  ```python743  if hasattr(tarfile, 'data_filter'):744      my_tarfile.extractall(filter='data')745  else:746      # удалить, когда больше не нужно747      warn_the_user('Extracting may be unsafe; consider updating Python')748      my_tarfile.extractall()749  ```750751### Пример фильтра извлечения с состоянием752753Хотя методы извлечения *tarfile* принимают простой вызываемый объект *filter*, пользовательские фильтры могут быть более сложными объектами с внутренним состоянием. Может быть полезно реализовать их в виде контекстных менеджеров, чтобы использовать следующим образом:754755```python756with StatefulFilter() as filter_func:757    tar.extractall(path, filter=filter_func)758```759760Такой фильтр можно написать, например, так:761762```python763class StatefulFilter:764    def __init__(self):765        self.file_count = 0766767    def __enter__(self):768        return self769770    def __call__(self, member, path):771        self.file_count += 1772        return member773774    def __exit__(self, *exc_info):775        print(f'{self.file_count} files extracted')776```777778## Интерфейс командной строки779780Добавлено в версии 3.4.781782Модуль `tarfile` предоставляет простой интерфейс командной строки для работы с tar-архивами.783784Если вы хотите создать новый tar-архив, укажите его имя после опции [`-c`](https://python-all.ru/3/library/tarfile.html#cmdoption-tarfile-c), а затем перечислите имена файлов, которые должны быть включены:785786```console787$ python -m tarfile -c monty.tar  spam.txt eggs.txt788```789790Можно также передать каталог:791792```console793$ python -m tarfile -c monty.tar life-of-brian_1979/794```795796Если вы хотите извлечь tar-архив в текущий каталог, используйте опцию [`-e`](https://python-all.ru/3/library/tarfile.html#cmdoption-tarfile-e):797798```console799$ python -m tarfile -e monty.tar800```801802Вы также можете извлечь tar-архив в другой каталог, передав его имя:803804```console805$ python -m tarfile -e monty.tar  other-dir/806```807808Чтобы получить список файлов в tar-архиве, используйте опцию [`-l`](https://python-all.ru/3/library/tarfile.html#cmdoption-tarfile-l):809810```console811$ python -m tarfile -l monty.tar812```813814### Параметры командной строки815816#### `-l <tarfile>`817818#### `--list <tarfile>`819820Выводит список файлов в tar-архиве.821822#### `-c <tarfile> <source1> ... <sourceN>`823824#### `--create <tarfile> <source1> ... <sourceN>`825826Создаёт tar-архив из исходных файлов.827828#### `-e <tarfile> [<output_dir>]`829830#### `--extract <tarfile> [<output_dir>]`831832Извлекает tar-архив в текущий каталог, если *output\_dir* не указан.833834#### `-t <tarfile>`835836#### `--test <tarfile>`837838Проверяет, является ли tar-файл допустимым.839840#### `-v, --verbose`841842Подробный вывод.843844#### `--filter <filtername>`845846Указывает *фильтр* для `--extract`. Подробнее см. [Фильтры извлечения](https://python-all.ru/3/library/tarfile.html#tarfile-extraction-filter). Принимаются только строковые имена (то есть `fully_trusted`, `tar`, и `data`).847848## Примеры849850### Примеры чтения851852Как извлечь полный tar-архив в текущий рабочий каталог:853854```python855import tarfile856tar = tarfile.open("sample.tar.gz")857tar.extractall(filter='data')858tar.close()859```860861Как извлечь подмножество tar-архива с помощью [`TarFile.extractall()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.extractall), используя функцию-генератор вместо списка:862863```python864import os865import tarfile866867def py_files(members):868    for tarinfo in members:869        if os.path.splitext(tarinfo.name)[1] == ".py":870            yield tarinfo871872tar = tarfile.open("sample.tar.gz")873tar.extractall(members=py_files(tar))874tar.close()875```876877Как прочитать tar-архив, сжатый gzip, и вывести информацию о некоторых элементах:878879```python880import tarfile881tar = tarfile.open("sample.tar.gz", "r:gz")882for tarinfo in tar:883    print(tarinfo.name, "is", tarinfo.size, "bytes in size and is ", end="")884    if tarinfo.isreg():885        print("a regular file.")886    elif tarinfo.isdir():887        print("a directory.")888    else:889        print("something else.")890tar.close()891```892893### Примеры записи894895Как создать несжатый tar-архив из списка имён файлов:896897```python898import tarfile899tar = tarfile.open("sample.tar", "w")900for name in ["foo", "bar", "quux"]:901    tar.add(name)902tar.close()903```904905Тот же пример с использованием оператора [`with`](https://python-all.ru/3/reference/compound_stmts.html#with):906907```python908import tarfile909with tarfile.open("sample.tar", "w") as tar:910    for name in ["foo", "bar", "quux"]:911        tar.add(name)912```913914Как создать архив и записать его в stdout, используя [`sys.stdout.buffer`](https://python-all.ru/3/library/sys.html#sys.stdout) в параметре *fileobj* в [`TarFile.add()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.add):915916```python917import sys918import tarfile919with tarfile.open("sample.tar.gz", "w|gz", fileobj=sys.stdout.buffer) as tar:920    for name in ["foo", "bar", "quux"]:921        tar.add(name)922```923924Как создать архив и сбросить информацию о пользователе, используя параметр *фильтр* в [`TarFile.add()`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile.add):925926```python927import tarfile928def reset(tarinfo):929    tarinfo.uid = tarinfo.gid = 0930    tarinfo.uname = tarinfo.gname = "root"931    return tarinfo932tar = tarfile.open("sample.tar.gz", "w:gz")933tar.add("foo", filter=reset)934tar.close()935```936937## Поддерживаемые форматы tar938939Существует три формата tar, которые можно создать с помощью модуля `tarfile`:940941- Формат POSIX.1-1988 ustar ([`USTAR_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.USTAR_FORMAT)). Он поддерживает имена файлов длиной не более 256 символов и имена ссылок – до 100 символов. Максимальный размер файла – 8 ГиБ. Это старый и ограниченный, но широко поддерживаемый формат.942- Формат GNU tar ([`GNU_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.GNU_FORMAT)). Он поддерживает длинные имена файлов и ссылок, файлы размером более 8 ГиБ и разрежённые файлы. Это де-факто стандарт в системах GNU/Linux. `tarfile` полностью поддерживает расширения GNU tar для длинных имён; поддержка разрежённых файлов – только для чтения.943- Формат POSIX.1-2001 pax ([`PAX_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.PAX_FORMAT)). Это самый гибкий формат, практически без ограничений. Он поддерживает длинные имена файлов и ссылок, большие файлы и хранит пути переносимым способом. Современные реализации tar, включая GNU tar, bsdtar/libarchive и star, полностью поддерживают расширенные возможности *pax*; некоторые старые или неподдерживаемые библиотеки могут не поддерживать, но должны обрабатывать архивы *pax* так, как если бы они были в универсально поддерживаемом формате *ustar*. Это текущий формат по умолчанию для новых архивов.944945  Он расширяет существующий формат *ustar* дополнительными заголовками для информации, которую иначе нельзя сохранить. Существует две разновидности заголовков pax: расширенные заголовки влияют только на последующий заголовок файла, глобальные заголовки действительны для всего архива и влияют на все последующие файлы. Все данные в заголовке pax кодируются в *UTF-8* по соображениям переносимости.946947Существуют ещё некоторые варианты формата tar, которые можно читать, но не создавать:948949- Древний формат V7. Это первый формат tar из Unix Seventh Edition, хранящий только обычные файлы и каталоги. Имена не должны быть длиннее 100 символов, информация об имени пользователя/группы отсутствует. Некоторые архивы имеют неправильные контрольные суммы заголовков в случае полей с не-ASCII символами.950- Расширенный формат SunOS tar. Этот формат является вариантом формата POSIX.1-2001 pax, но несовместим с ним.951952## Проблемы Unicode953954Формат tar изначально был задуман для создания резервных копий на ленточных накопителях с основным упором на сохранение информации о файловой системе. Сегодня tar-архивы обычно используются для распространения файлов и обмена архивами по сетям. Одна проблема исходного формата (который является основой всех других форматов) заключается в том, что нет концепции поддержки разных кодировок символов. Например, обычный tar-архив, созданный в системе с *UTF-8*, не может быть корректно прочитан в системе с *Latin-1*, если он содержит символы, отличные от *ASCII*. Текстовые метаданные (например, имена файлов, имена ссылок, имена пользователей/групп) будут повреждены. К сожалению, нет способа автоматически определить кодировку архива. Формат pax был разработан для решения этой проблемы. Он хранит не-ASCII метаданные, используя универсальную кодировку символов *UTF-8*.955956Детали преобразования символов в `tarfile` управляются ключевыми аргументами *encoding* и *errors* класса [`TarFile`](https://python-all.ru/3/library/tarfile.html#tarfile.TarFile).957958*encoding* определяет кодировку символов, используемую для метаданных в архиве. Значение по умолчанию – [`sys.getfilesystemencoding()`](https://python-all.ru/3/library/sys.html#sys.getfilesystemencoding) или `'ascii'` в качестве запасного варианта. В зависимости от того, читается или записывается архив, метаданные должны быть либо декодированы, либо закодированы. Если *encoding* не установлена соответствующим образом, это преобразование может завершиться ошибкой.959960Аргумент *errors* определяет, как обрабатываются символы, которые невозможно преобразовать. Возможные значения перечислены в разделе [Обработчики ошибок](https://python-all.ru/3/library/codecs.html#error-handlers). Схема по умолчанию – `'surrogateescape'`, которую Python также использует для своих системных вызовов, см. [Имена файлов, аргументы командной строки и переменные окружения](https://python-all.ru/3/library/os.html#os-filenames).961962Для архивов [`PAX_FORMAT`](https://python-all.ru/3/library/tarfile.html#tarfile.PAX_FORMAT) (по умолчанию) *encoding* обычно не требуется, потому что все метаданные хранятся с использованием *UTF-8*. *encoding* используется только в редких случаях, когда декодируются бинарные заголовки pax или когда хранятся строки с суррогатными символами.963