> **Источник:** https://python-all.ru/3.4/library/tarfile.html > > «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor. --- # 13.6. [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile) – Чтение и запись tar-архивов **Исходный код:** [Lib/tarfile.py](https://python-all.ru/src/3.4/Lib/tarfile.py) --- Модуль [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile) позволяет читать и записывать tar-архивы, в том числе сжатые с помощью gzip, bz2 и lzma. Для чтения или записи файлов `.zip` используйте модуль [`zipfile`](https://python-all.ru/3.4/library/zipfile.html#module-zipfile), а для более высокоуровневых функций – [*shutil*](https://python-all.ru/3.4/library/shutil.html#archiving-operations). Некоторые факты и цифры: - читает и записывает архивы, сжатые с помощью [`gzip`](https://python-all.ru/3.4/library/gzip.html#module-gzip), [`bz2`](https://python-all.ru/3.4/library/bz2.html#module-bz2) и [`lzma`](https://python-all.ru/3.4/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.4/library/lzma.html#module-lzma). #### `tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)` Возвращает объект [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile) для пути *name*. Подробную информацию об объектах [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile) и разрешённых именованных аргументах см. в [*TarFile Objects*](https://python-all.ru/3.4/library/tarfile.html#tarfile-objects). *mode* должен быть строкой вида `'filemode[:compression]'`; по умолчанию используется `'r'`. Вот полный список комбинаций режимов: | Режим | Действие | | --- | --- | | `'r' или 'r:*'` | Открыть для чтения с прозрачным сжатием (рекомендуется). | | `'r:'` | Открыть для чтения исключительно без сжатия. | | `'r:gz'` | Открыть для чтения со сжатием gzip. | | `'r:bz2'` | Открыть для чтения со сжатием bzip2. | | `'r:xz'` | Открыть для чтения со сжатием lzma. | | `'a' или 'a:'` | Открыть для добавления без сжатия. Файл создаётся, если он не существует. | | `'w' или 'w:'` | Открывается для записи без сжатия. | | `'w:gz'` | Открывается для записи со сжатием gzip. | | `'w:bz2'` | Открывается для записи со сжатием bzip2. | | `'w:xz'` | Открывается для записи со сжатием lzma. | Обратите внимание, что `'a:gz'`, `'a:bz2'` и `'a:xz'` невозможны. Если *mode* не подходит для открытия определённого (сжатого) файла на чтение, возбуждается [`ReadError`](https://python-all.ru/3.4/library/tarfile.html#tarfile.ReadError). Чтобы этого избежать, используйте *mode* `'r'`. Если метод сжатия не поддерживается, возбуждается [`CompressionError`](https://python-all.ru/3.4/library/tarfile.html#tarfile.CompressionError). Если указан *fileobj*, он используется вместо [*файлового объекта*](https://python-all.ru/3.4/glossary.html#term-file-object), открытого в бинарном режиме для *имени*. Предполагается, что он находится на позиции 0. Для режимов `'w:gz'`, `'r:gz'`, `'w:bz2'`, `'r:bz2'` функция [`tarfile.open()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.open) принимает именованный аргумент *compresslevel* для указания уровня сжатия файла. Для особых случаев существует второй формат для *mode*: `'filemode|[compression]'`. Функция [`tarfile.open()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.open) вернёт объект [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile), который обрабатывает свои данные как поток блоков. При этом не выполняется произвольный доступ к файлу. Если задан, *fileobj* может быть любым объектом, имеющим метод `read()` или `write()` (в зависимости от *mode*). *bufsize* задаёт размер блока; по умолчанию `20 * 512` байтов. Используйте этот вариант в сочетании, например, с `sys.stdin`, сокетом [*файловый объект*](https://python-all.ru/3.4/glossary.html#term-file-object) или ленточным устройством. Однако такой объект [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile) ограничен: он не допускает произвольного доступа; см. [*Примеры*](https://python-all.ru/3.4/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 *поток данных* для записи. | #### `class tarfile.TarFile` Класс для чтения и записи tar-архивов. Не используйте этот класс напрямую, вместо этого используйте [`tarfile.open()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.open). См. [*TarFile Objects*](https://python-all.ru/3.4/library/tarfile.html#tarfile-objects). #### `tarfile.is_tarfile(name)` Возвращает [`True`](https://python-all.ru/3.4/library/constants.html#True), если *name* является файлом tar-архива, который может прочитать модуль [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile). Модуль [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile) определяет следующие исключения: #### `exception tarfile.TarError` Базовый класс для всех исключений [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile). #### `exception tarfile.ReadError` Возникает, когда открывается tar-архив, который не может быть обработан модулем [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile) или является некорректным. #### `exception tarfile.CompressionError` Возникает, когда метод сжатия не поддерживается или данные не удаётся корректно декодировать. #### `exception tarfile.StreamError` Возникает для ограничений, типичных для потокоподобных [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile) объектов. #### `exception tarfile.ExtractError` Возникает при *нефатальных* ошибках при использовании [`TarFile.extract()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile.extract), но только если `TarFile.errorlevel``== 2`. #### `exception tarfile.HeaderError` Возникает при вызове [`TarInfo.frombuf()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo.frombuf), если полученный буфер некорректен. На уровне модуля доступны следующие константы: #### `tarfile.ENCODING` Кодировка по умолчанию: `'utf-8'` в Windows, иначе значение, возвращаемое [`sys.getfilesystemencoding()`](https://python-all.ru/3.4/library/sys.html#sys.getfilesystemencoding). Каждая из следующих констант определяет формат tar-архива, который может создать модуль [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile). См. раздел [*Supported tar formats*](https://python-all.ru/3.4/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` Формат по умолчанию для создания архивов. В настоящее время это [`GNU_FORMAT`](https://python-all.ru/3.4/library/tarfile.html#tarfile.GNU_FORMAT). > **См. также** > > **Модуль [`zipfile`](https://python-all.ru/3.4/library/zipfile.html#module-zipfile)** > > Документация стандартного модуля > > [`zipfile`](https://python-all.ru/3.4/library/zipfile.html#module-zipfile) > > . > > **[*Операции архивирования*](https://python-all.ru/3.4/library/shutil.html#archiving-operations)** > > Документация высокоуровневых средств архивирования, предоставляемых стандартным модулем > > [`shutil`](https://python-all.ru/3.4/library/shutil.html#module-shutil) > > . > > **[Руководство GNU tar, базовый формат tar](https://python-all.ru/3.4/library/tarfile.html)** > > Документация для файлов архивов tar, включая расширения GNU tar. ## 13.6.1. Объекты TarFile Объект [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile) предоставляет интерфейс к tar-архиву. Tar-архив представляет собой последовательность блоков. Элемент архива (хранящийся файл) состоит из заголовочного блока, за которым следуют блоки данных. Можно хранить файл в tar-архиве несколько раз. Каждый элемент архива представлен объектом [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo), см. [*TarInfo Objects*](https://python-all.ru/3.4/library/tarfile.html#tarinfo-objects) для подробностей. Объект [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile) можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3.4/reference/compound_stmts.html#with) . Он будет автоматически закрыт по завершении блока. Обратите внимание, что в случае исключения архив, открытый для записи, не будет финализирован; будет закрыт только внутренний файловый объект. См. раздел [*Examples*](https://python-all.ru/3.4/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=0)` Все последующие аргументы необязательны и также могут быть доступны как атрибуты экземпляра. *name* – это путь к архиву. Его можно опустить, если указан *fileobj*. В этом случае используется атрибут `name` файлового объекта, если он существует. *mode* может быть `'r'` для чтения существующего архива, `'a'` для добавления данных в существующий файл или `'w'` для создания нового файла с перезаписью существующего . Если указан *fileobj*, он используется для чтения или записи данных. Если это можно определить, *mode* переопределяется режимом *fileobj*. *fileobj* будет использоваться с позиции 0. > **Примечание** > > *fileobj* не закрывается, когда [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile) закрывается. *format* управляет форматом архива. Он должен быть одной из констант [`USTAR_FORMAT`](https://python-all.ru/3.4/library/tarfile.html#tarfile.USTAR_FORMAT), [`GNU_FORMAT`](https://python-all.ru/3.4/library/tarfile.html#tarfile.GNU_FORMAT) или [`PAX_FORMAT`](https://python-all.ru/3.4/library/tarfile.html#tarfile.PAX_FORMAT), которые определены на уровне модуля. Аргумент *tarinfo* можно использовать для замены класса по умолчанию [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) на другой. Если *dereference* равен [`False`](https://python-all.ru/3.4/library/constants.html#False), символические и жёсткие ссылки добавляются в архив. Если он равен [`True`](https://python-all.ru/3.4/library/constants.html#True), в архив добавляется содержимое целевых файлов. Это не влияет на системы, не поддерживающие символические ссылки. Если *ignore\_zeros* равен [`False`](https://python-all.ru/3.4/library/constants.html#False), пустой блок считается концом архива. Если он равен [`True`](https://python-all.ru/3.4/library/constants.html#True), пустые (и недопустимые) блоки пропускаются, и предпринимается попытка получить как можно больше элементов. Это полезно только для чтения объединённых или повреждённых архивов. *debug* может быть установлен от `0` (нет отладочных сообщений) до `3` (все отладочные сообщения). Сообщения записываются в `sys.stderr`. Если *errorlevel* равен `0`, все ошибки игнорируются при использовании [`TarFile.extract()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile.extract). Тем не менее, они отображаются как сообщения об ошибках в отладочном выводе, если отладка включена. Если `1`, все *фатальные* ошибки вызываются как исключения [`OSError`](https://python-all.ru/3.4/library/exceptions.html#OSError). Если `2`, все *нефатальные* ошибки также вызываются как исключения [`TarError`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarError). Аргументы *encoding* и *errors* определяют кодировку символов, используемую для чтения или записи архива, и способ обработки ошибок преобразования. Настройки по умолчанию подходят для большинства пользователей. Подробную информацию см. в разделе [*Проблемы Unicode*](https://python-all.ru/3.4/library/tarfile.html#tar-unicode). Изменено в версии 3.2: Используется `'surrogateescape'` по умолчанию для аргумента *errors*. Аргумент *pax\_headers* – это необязательный словарь строк, который будет добавлен в качестве глобального заголовка pax, если *format* равен [`PAX_FORMAT`](https://python-all.ru/3.4/library/tarfile.html#tarfile.PAX_FORMAT). #### `classmethod TarFile.open(...)` Альтернативный конструктор. Функция [`tarfile.open()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.open) на самом деле является сокращением для этого метода класса. #### `TarFile.getmember(name)` Возвращает объект [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) для элемента *name*. Если *name* не найден в архиве, вызывается исключение [`KeyError`](https://python-all.ru/3.4/library/exceptions.html#KeyError). > **Примечание** > > Если элемент встречается в архиве более одного раза, последнее его вхождение считается самой актуальной версией. #### `TarFile.getmembers()` Возвращает элементы архива в виде списка объектов [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo). Список имеет тот же порядок, что и элементы в архиве. #### `TarFile.getnames()` Возвращает элементы в виде списка их имён. Он имеет тот же порядок, что и список, возвращаемый [`getmembers()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile.getmembers). #### `TarFile.list(verbose=True)` Выводит оглавление в `sys.stdout`. Если *verbose* равен [`False`](https://python-all.ru/3.4/library/constants.html#False), печатаются только имена элементов. Если он равен [`True`](https://python-all.ru/3.4/library/constants.html#True), вывод аналогичен выводу **ls -l**. #### `TarFile.next()` Возвращает следующий элемент архива в виде объекта [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo), когда [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile) открыт для чтения. Возвращает [`None`](https://python-all.ru/3.4/library/constants.html#None), если больше нет доступных элементов. #### `TarFile.extractall(path=".", members=None)` Извлекает все элементы из архива в текущий рабочий каталог или каталог *path*. Если задан необязательный *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile.getmembers). Информация о каталоге, такая как владелец, время изменения и права доступа, устанавливается после извлечения всех элементов. Это сделано для обхода двух проблем: время изменения каталога сбрасывается каждый раз, когда в нём создаётся файл. И, если права доступа каталога не разрешают запись, извлечение файлов в него завершится ошибкой. > **Предупреждение** > > Никогда не извлекайте архивы из ненадёжных источников без предварительной проверки. Возможно создание файлов за пределами *path*, например, элементов с абсолютными именами, начинающимися с `"/"`, или с именами, содержащими две точки `".."`. #### `TarFile.extract(member, path="", set_attrs=True)` Извлекает элемент из архива в текущий рабочий каталог, используя его полное имя. Информация о файле извлекается максимально точно. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo). Можно указать другой каталог с помощью *path*. Атрибуты файла (владелец, mtime, режим) устанавливаются, если *set\_attrs* не равен false. > **Примечание** > > Метод [`extract()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile.extract) не учитывает несколько проблем извлечения. В большинстве случаев следует рассмотреть использование метода [`extractall()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile.extractall). > **Предупреждение** > > Смотрите предупреждение для [`extractall()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile.extractall). Изменено в версии 3.2: Добавлен параметр *set\_attrs*. #### `TarFile.extractfile(member)` Извлекает элемент из архива в виде файлового объекта. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo). Если *member* является обычным файлом или ссылкой, возвращается объект [`io.BufferedReader`](https://python-all.ru/3.4/library/io.html#io.BufferedReader). В противном случае возвращается [`None`](https://python-all.ru/3.4/library/constants.html#None). Изменено в версии 3.3: Возвращается объект [`io.BufferedReader`](https://python-all.ru/3.4/library/io.html#io.BufferedReader). #### `TarFile.add(name, arcname=None, recursive=True, exclude=None, *, filter=None)` Добавляет файл *name* в архив. *name* может быть файлом любого типа (каталог, fifo, символическая ссылка и т.д.). Если задан, *arcname* указывает альтернативное имя файла в архиве. Каталоги добавляются рекурсивно по умолчанию. Этого можно избежать, установив *recursive* в [`False`](https://python-all.ru/3.4/library/constants.html#False). Если задан *exclude*, он должен быть функцией, принимающей один аргумент – имя файла – и возвращающей логическое значение. В зависимости от этого значения соответствующий файл либо исключается ([`True`](https://python-all.ru/3.4/library/constants.html#True)), либо добавляется ([`False`](https://python-all.ru/3.4/library/constants.html#False)). Если указан *filter*, он должен быть именованным аргументом. Это должна быть функция, принимающая объект [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) и возвращающая изменённый объект [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo). Если вместо этого возвращается [`None`](https://python-all.ru/3.4/library/constants.html#None), объект [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) будет исключён из архива. Смотрите [*Примеры*](https://python-all.ru/3.4/library/tarfile.html#tar-examples) для примера. Изменено в версии 3.2: Добавлен параметр *filter*. Устарело с версии 3.2: Параметр *exclude* устарел; используйте вместо него параметр *filter* вместо него. #### `TarFile.addfile(tarinfo, fileobj=None)` Add the [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) object *tarinfo* to the archive. If *fileobj* is given, `tarinfo.size` bytes are read from it and added to the archive. You can create [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) objects using [`gettarinfo()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile.gettarinfo). > **Примечание** > > On Windows platforms, *fileobj* should always be opened with mode `'rb'` to avoid irritation about the file size. #### `TarFile.gettarinfo(name=None, arcname=None, fileobj=None)` Create a [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) object for either the file *name* or the [*file object*](https://python-all.ru/3.4/glossary.html#term-file-object) *fileobj* (using [`os.fstat()`](https://python-all.ru/3.4/library/os.html#os.fstat) on its file descriptor). You can modify some of the [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo)‘s attributes before you add it using [`addfile()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile.addfile). If given, *arcname* specifies an alternative name for the file in the archive. #### `TarFile.close()` Close the [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile). In write mode, two finishing zero blocks are appended to the archive. #### `TarFile.pax_headers` Словарь, содержащий пары ключ-значение глобальных заголовков pax. ## 13.6.2. Объекты TarInfo A [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) object represents one member in a [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile). Aside from storing all required attributes of a file (like file type, size, time, permissions, owner etc.), it provides some useful methods to determine its type. It does *not* contain the file’s data itself. [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) objects are returned by [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile)‘s methods `getmember()`, `getmembers()` and `gettarinfo()`. #### `class tarfile.TarInfo(name="")` Create a [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) object. #### `classmethod TarInfo.frombuf(buf, encoding, errors)` Create and return a [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) object from string buffer *buf*. Raises [`HeaderError`](https://python-all.ru/3.4/library/tarfile.html#tarfile.HeaderError) if the buffer is invalid. #### `classmethod TarInfo.fromtarfile(tarfile)` Читает следующий элемент из объекта [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile) *tarfile* и возвращает его как объект [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo). #### `TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')` Создаёт строковый буфер из объекта [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo). Информацию об аргументах см. в конструкторе класса [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile). Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`. Объект `TarInfo` имеет следующие публичные атрибуты данных: #### `TarInfo.name` Имя элемента архива. #### `TarInfo.size` Размер в байтах. #### `TarInfo.mtime` Время последнего изменения. #### `TarInfo.mode` Биты разрешений. #### `TarInfo.type` Тип файла. *type* обычно является одной из следующих констант: `REGTYPE`, `AREGTYPE`, `LNKTYPE`, `SYMTYPE`, `DIRTYPE`, `FIFOTYPE`, `CONTTYPE`, `CHRTYPE`, `BLKTYPE`, `GNUTYPE_SPARSE`. Для более удобного определения типа объекта [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) используйте методы `is*()` ниже. #### `TarInfo.linkname` Имя целевого файла, которое присутствует только в объектах [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) типа `LNKTYPE` и `SYMTYPE`. #### `TarInfo.uid` Идентификатор пользователя, который изначально сохранил этот элемент. #### `TarInfo.gid` Идентификатор группы пользователя, который изначально сохранил этот элемент. #### `TarInfo.uname` Имя пользователя. #### `TarInfo.gname` Имя группы. #### `TarInfo.pax_headers` Словарь, содержащий пары ключ-значение связанного расширенного заголовка pax. Объект [`TarInfo`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo) также предоставляет несколько удобных методов для запросов: #### `TarInfo.isfile()` Возвращает [`True`](https://python-all.ru/3.4/library/constants.html#True), если объект `Tarinfo` является обычным файлом. #### `TarInfo.isreg()` То же, что и [`isfile()`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarInfo.isfile). #### `TarInfo.isdir()` Возвращает [`True`](https://python-all.ru/3.4/library/constants.html#True), если это каталог. #### `TarInfo.issym()` Возвращает [`True`](https://python-all.ru/3.4/library/constants.html#True), если это символическая ссылка. #### `TarInfo.islnk()` Возвращает [`True`](https://python-all.ru/3.4/library/constants.html#True), если это жёсткая ссылка. #### `TarInfo.ischr()` Возвращает [`True`](https://python-all.ru/3.4/library/constants.html#True), если это символьное устройство. #### `TarInfo.isblk()` Возвращает [`True`](https://python-all.ru/3.4/library/constants.html#True), если это блочное устройство. #### `TarInfo.isfifo()` Возвращает [`True`](https://python-all.ru/3.4/library/constants.html#True), если это FIFO. #### `TarInfo.isdev()` Возвращает [`True`](https://python-all.ru/3.4/library/constants.html#True), если это символьное устройство, блочное устройство или FIFO. ## 13.6.3. Интерфейс командной строки Новое в версии 3.4. Модуль [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile) предоставляет простой интерфейс командной строки для работы с tar-архивами. Чтобы создать новый tar-архив, укажите его имя после опции [*-c*](https://python-all.ru/3.4/using/cmdline.html#cmdoption-c) и затем перечислите имена файлов, которые нужно включить: ```python $ python -m tarfile -c monty.tar spam.txt eggs.txt ``` Можно также передать каталог: ```python $ python -m tarfile -c monty.tar life-of-brian_1979/ ``` Чтобы извлечь tar-архив в текущий каталог, используйте опцию [*-e*](https://python-all.ru/3.4/library/tarfile.html#cmdoption-e): ```python $ python -m tarfile -e monty.tar ``` Вы также можете извлечь tar-архив в другой каталог, передав его имя: ```python $ python -m tarfile -e monty.tar other-dir/ ``` Для получения списка файлов в tar-архиве используйте опцию [*-l*](https://python-all.ru/3.4/library/tarfile.html#cmdoption-l): ```python $ python -m tarfile -l monty.tar ``` ### 13.6.3.1. Опции командной строки #### `-l ` #### `--list ` Выводит список файлов в tar-архиве. #### `-c ` #### `--create ` Создаёт tar-архив из исходных файлов. #### `-e []` #### `--extract []` Извлекает tar-архив в текущий каталог, если *output\_dir* не указан. #### `-t ` #### `--test ` Проверяет, является ли tar-файл допустимым. #### `-v, --verbose` Подробный вывод ## 13.6.4. Примеры Как извлечь полный tar-архив в текущий рабочий каталог: ```python import tarfile tar = tarfile.open("sample.tar.gz") tar.extractall() tar.close() ``` Как извлечь подмножество tar-архива с помощью [`TarFile.extractall()`](https://python-all.ru/3.4/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.4/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() ``` Как создать архив и сбросить информацию о пользователе с помощью параметра *filter* в [`TarFile.add()`](https://python-all.ru/3.4/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() ``` ## 13.6.5. Поддерживаемые форматы tar Существует три tar-формата, которые можно создать с помощью модуля [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile): - Формат ustar POSIX.1-1988 ([`USTAR_FORMAT`](https://python-all.ru/3.4/library/tarfile.html#tarfile.USTAR_FORMAT)). Он поддерживает имена файлов длиной до 256 символов и имена ссылок до 100 символов. Максимальный размер файла – 8 Гиб. Это старый и ограниченный, но широко поддерживаемый формат. - Формат GNU tar ([`GNU_FORMAT`](https://python-all.ru/3.4/library/tarfile.html#tarfile.GNU_FORMAT)). Он поддерживает длинные имена файлов и ссылок, файлы размером более 8 Гиб и разрежённые файлы. Это де-факто стандарт в системах GNU/Linux. [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile) полностью поддерживает расширения GNU tar для длинных имён, поддержка разрежённых файлов – только для чтения. - Формат pax POSIX.1-2001 ([`PAX_FORMAT`](https://python-all.ru/3.4/library/tarfile.html#tarfile.PAX_FORMAT)). Это наиболее гибкий формат, практически без ограничений. Он поддерживает длинные имена файлов и ссылок, большие файлы и хранит пути переносимым образом. Однако не все современные реализации tar умеют корректно обрабатывать архивы pax. Формат *pax* является расширением существующего формата *ustar*. Он использует дополнительные заголовки для информации, которую иначе сохранить невозможно. Существует две разновидности pax-заголовков: расширенные заголовки действуют только на последующий заголовок файла, а глобальные заголовки действительны для всего архива и влияют на все последующие файлы. Все данные в pax-заголовке для портативности кодируются в *UTF-8*. Существуют ещё некоторые варианты формата tar, которые можно читать, но не создавать: - Древний формат V7. Это первый формат tar из Unix Seventh Edition, хранящий только обычные файлы и каталоги. Имена не должны быть длиннее 100 символов, информация об имени пользователя/группы отсутствует. Некоторые архивы имеют неправильные контрольные суммы заголовков в случае полей с не-ASCII символами. - Расширенный формат SunOS tar. Этот формат является вариантом формата POSIX.1-2001 pax, но несовместим с ним. ## 13.6.6. Вопросы Unicode Формат tar изначально был задуман для создания резервных копий на ленточных накопителях с основным упором на сохранение информации о файловой системе. Сегодня tar-архивы обычно используются для распространения файлов и обмена архивами по сетям. Одна проблема исходного формата (который является основой всех других форматов) заключается в том, что нет концепции поддержки разных кодировок символов. Например, обычный tar-архив, созданный в системе с *UTF-8*, не может быть корректно прочитан в системе с *Latin-1*, если он содержит символы, отличные от *ASCII*. Текстовые метаданные (например, имена файлов, имена ссылок, имена пользователей/групп) будут повреждены. К сожалению, нет способа автоматически определить кодировку архива. Формат pax был разработан для решения этой проблемы. Он хранит не-ASCII метаданные, используя универсальную кодировку символов *UTF-8*. Детали преобразования символов в [`tarfile`](https://python-all.ru/3.4/library/tarfile.html#module-tarfile) управляются именованными аргументами *encoding* и *errors* класса [`TarFile`](https://python-all.ru/3.4/library/tarfile.html#tarfile.TarFile). *encoding* определяет кодировку символов для метаданных в архиве. Значение по умолчанию – [`sys.getfilesystemencoding()`](https://python-all.ru/3.4/library/sys.html#sys.getfilesystemencoding) или `'ascii'` в качестве запасного варианта. В зависимости от того, читается архив или записывается, метаданные должны быть декодированы или закодированы. Если *encoding* задан неподходящим образом, это преобразование может завершиться ошибкой. Аргумент *errors* определяет, как обрабатывать символы, которые невозможно преобразовать. Возможные значения перечислены в разделе [*Обработчики ошибок*](https://python-all.ru/3.4/library/codecs.html#error-handlers). По умолчанию используется схема `'surrogateescape'`, которую Python также применяет для системных вызовов файловой системы; см. [*Имена файлов, аргументы командной строки и переменные окружения*](https://python-all.ru/3.4/library/os.html#os-filenames). В случае архивов [`PAX_FORMAT`](https://python-all.ru/3.4/library/tarfile.html#tarfile.PAX_FORMAT) *encoding* обычно не требуется, поскольку все метаданные хранятся в *UTF-8*. *encoding* используется только в редких случаях, когда декодируются двоичные заголовки pax или сохраняются строки с суррогатными символами.