> **Источник:** https://python-all.ru/3.5/library/tarfile.html > > «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor. --- # 13.6. [`tarfile`](https://python-all.ru/3.5/library/tarfile.html#module-tarfile) – Чтение и запись tar-архивов **Исходный код:** [Lib/tarfile.py](https://python-all.ru/src/3.5/Lib/tarfile.py) --- Модуль [`tarfile`](https://python-all.ru/3.5/library/tarfile.html#module-tarfile) позволяет читать и записывать tar-архивы, в том числе сжатые gzip, bz2 и lzma. Используйте модуль [`zipfile`](https://python-all.ru/3.5/library/zipfile.html#module-zipfile) для чтения и записи файлов `.zip` или функции более высокого уровня из [shutil](https://python-all.ru/3.5/library/shutil.html#archiving-operations). Некоторые факты и цифры: - читает и записывает сжатые архивы [`gzip`](https://python-all.ru/3.5/library/gzip.html#module-gzip), [`bz2`](https://python-all.ru/3.5/library/bz2.html#module-bz2) и [`lzma`](https://python-all.ru/3.5/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.5/library/lzma.html#module-lzma). #### `tarfile.open(name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)` Возвращает объект [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile) для имени пути *name*. Подробную информацию об объектах [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile) и допустимых именованных аргументах см. в разделе [Объекты TarFile](https://python-all.ru/3.5/library/tarfile.html#tarfile-objects). *mode* должен быть строкой вида `'filemode[:compression]'`, по умолчанию равен `'r'`. Вот полный список комбинаций режимов: | Режим | Действие | | --- | --- | | `'r' or 'r:*'` | Открыть для чтения с прозрачным сжатием (рекомендуется). | | `'r:'` | Открыть для чтения исключительно без сжатия. | | `'r:gz'` | Открыть для чтения со сжатием gzip. | | `'r:bz2'` | Открыть для чтения со сжатием bzip2. | | `'r:xz'` | Открыть для чтения со сжатием lzma. | | `'x'` или `'x:'` | Создаёт tar-файл без сжатия. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.5/library/exceptions.html#FileExistsError), если файл уже существует. | | `'x:gz'` | Создаёт tar-файл со сжатием gzip. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.5/library/exceptions.html#FileExistsError), если файл уже существует. | | `'x:bz2'` | Создаёт tar-файл со сжатием bzip2. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.5/library/exceptions.html#FileExistsError), если файл уже существует. | | `'x:xz'` | Создаёт tar-файл со сжатием lzma. Вызывает исключение [`FileExistsError`](https://python-all.ru/3.5/library/exceptions.html#FileExistsError), если файл уже существует. | | `'a' or 'a:'` | Открыть для добавления без сжатия. Файл создаётся, если он не существует. | | `'w' or 'w:'` | Открывается для записи без сжатия. | | `'w:gz'` | Открывается для записи со сжатием gzip. | | `'w:bz2'` | Открывается для записи со сжатием bzip2. | | `'w:xz'` | Открывается для записи со сжатием lzma. | Обратите внимание, что `'a:gz'`, `'a:bz2'` или `'a:xz'` невозможны. Если *режим* не подходит для открытия определённого (сжатого) файла для чтения, возбуждается [`ReadError`](https://python-all.ru/3.5/library/tarfile.html#tarfile.ReadError). Используйте *режим* `'r'`, чтобы избежать этого. Если метод сжатия не поддерживается, возбуждается [`CompressionError`](https://python-all.ru/3.5/library/tarfile.html#tarfile.CompressionError). Если указан *fileobj*, он используется вместо [файлового объекта](https://python-all.ru/3.5/glossary.html#term-file-object), открытого в бинарном режиме для *имени*. Предполагается, что он находится на позиции 0. Для режимов `'w:gz'`, `'r:gz'`, `'w:bz2'`, `'r:bz2'`, `'x:gz'`, `'x:bz2'`, [`tarfile.open()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.open) принимает именованный аргумент *compresslevel* (по умолчанию `9`) для указания уровня сжатия файла. Для специальных целей существует второй формат для *mode*: `'filemode|[compression]'`. [`tarfile.open()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.open) вернёт объект [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile), который обрабатывает данные как поток блоков. Поиск по файлу с произвольным доступом не выполняется. Если задан *fileobj*, это может быть любой объект с методами `read()` или `write()` (в зависимости от *mode*). *bufsize* задаёт размер блока; по умолчанию `20 * 512` байт. Используйте этот вариант в сочетании, например, с `sys.stdin`, сокетным [файловым объектом](https://python-all.ru/3.5/glossary.html#term-file-object) или ленточным устройством. Однако такой объект [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile) ограничен тем, что не допускает произвольный доступ – см. [Примеры](https://python-all.ru/3.5/library/tarfile.html#tar-examples). Возможные режимы на текущий момент: | Режим | Действие | | --- | --- | | `'r\|*'` | Открывает *поток данных* tar-блоков для чтения с прозрачным сжатием. | | `'r\|'` | Открывает *поток данных* несжатых tar-блоков для чтения. | | `'r\|gz'` | Открывает сжатый gzip *поток данных* для чтения. | | `'r\|bz2'` | Открывает сжатый bzip2 *поток данных* для чтения. | | `'r\|xz'` | Открывает сжатый lzma *поток данных* для чтения. | | `'w\|'` | Открывает несжатый *поток данных* для записи. | | `'w\|gz'` | Открывает сжатый gzip *поток данных* для записи. | | `'w\|bz2'` | Открывает сжатый bzip2 *поток данных* для записи. | | `'w\|xz'` | Открывает сжатый lzma *поток данных* для записи. | Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание). #### `class tarfile.TarFile` Класс для чтения и записи tar-архивов. Не используйте этот класс напрямую: вместо него используйте [`tarfile.open()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.open). См. [Объекты TarFile](https://python-all.ru/3.5/library/tarfile.html#tarfile-objects). #### `tarfile.is_tarfile(name)` Возвращает [`True`](https://python-all.ru/3.5/library/constants.html#True), если *name* является tar-архивом, который может прочитать модуль [`tarfile`](https://python-all.ru/3.5/library/tarfile.html#module-tarfile). Модуль [`tarfile`](https://python-all.ru/3.5/library/tarfile.html#module-tarfile) определяет следующие исключения: #### `exception tarfile.TarError` Базовый класс для всех исключений [`tarfile`](https://python-all.ru/3.5/library/tarfile.html#module-tarfile). #### `exception tarfile.ReadError` Возникает при открытии tar-архива, который не может быть обработан модулем [`tarfile`](https://python-all.ru/3.5/library/tarfile.html#module-tarfile) или является некорректным. #### `exception tarfile.CompressionError` Возникает, когда метод сжатия не поддерживается или данные не удаётся корректно декодировать. #### `exception tarfile.StreamError` Возникает при ограничениях, типичных для объектов, работающих в режиме потока [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile). #### `exception tarfile.ExtractError` Возникает при *нефатальных* ошибках при использовании [`TarFile.extract()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.extract), но только если `TarFile.errorlevel``== 2`. #### `exception tarfile.HeaderError` Возникает при вызове [`TarInfo.frombuf()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo.frombuf), если полученный буфер некорректен. На уровне модуля доступны следующие константы: #### `tarfile.ENCODING` Кодировка символов по умолчанию: `'utf-8'` в Windows, значение, возвращаемое [`sys.getfilesystemencoding()`](https://python-all.ru/3.5/library/sys.html#sys.getfilesystemencoding) в остальных случаях. Каждая из следующих констант определяет формат tar-архива, который модуль [`tarfile`](https://python-all.ru/3.5/library/tarfile.html#module-tarfile) может создавать. Подробнее см. раздел [Поддерживаемые форматы tar](https://python-all.ru/3.5/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.5/library/tarfile.html#tarfile.GNU_FORMAT). > **См. также** > > **Модуль [`zipfile`](https://python-all.ru/3.5/library/zipfile.html#module-zipfile)** > > Документация стандартного модуля > > [`zipfile`](https://python-all.ru/3.5/library/zipfile.html#module-zipfile) > > . > > **[Операции архивирования](https://python-all.ru/3.5/library/shutil.html#archiving-operations)** > > Документация средств архивирования высокого уровня, предоставляемых стандартным модулем > > [`shutil`](https://python-all.ru/3.5/library/shutil.html#module-shutil) > > . > > **[Руководство GNU tar, базовый формат tar](https://python-all.ru/3.5/library/tarfile.html)** > > Документация для файлов архивов tar, включая расширения GNU tar. ## 13.6.1. Объекты TarFile Объект [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile) предоставляет интерфейс к архиву tar. Архив tar представляет собой последовательность блоков. Элемент архива (хранимый файл) состоит из заголовочного блока, за которым следуют блоки данных. Файл можно сохранить в архив tar несколько раз. Каждый элемент архива представляется объектом [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo), подробнее см. [Объекты TarInfo](https://python-all.ru/3.5/library/tarfile.html#tarinfo-objects). Объект [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile) можно использовать как контекстный менеджер в операторе [`with`](https://python-all.ru/3.5/reference/compound_stmts.html#with). Он будет автоматически закрыт по завершении блока. Обратите внимание: в случае исключения архив, открытый для записи, не будет финализирован; будет закрыт только внутренний файловый объект. Пример использования см. в разделе [Примеры](https://python-all.ru/3.5/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'` для создания нового файла с перезаписью существующего или `'x'` для создания нового файла только в том случае, если он ещё не существует. Если указан *fileobj*, он используется для чтения или записи данных. Если это можно определить, *mode* переопределяется режимом *fileobj*. *fileobj* будет использоваться с позиции 0. > **Примечание** > > *fileobj* не закрывается при закрытии [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile). *format* управляет форматом архива. Значением должна быть одна из констант [`USTAR_FORMAT`](https://python-all.ru/3.5/library/tarfile.html#tarfile.USTAR_FORMAT), [`GNU_FORMAT`](https://python-all.ru/3.5/library/tarfile.html#tarfile.GNU_FORMAT) или [`PAX_FORMAT`](https://python-all.ru/3.5/library/tarfile.html#tarfile.PAX_FORMAT), определённых на уровне модуля. Аргумент *tarinfo* можно использовать для замены класса по умолчанию [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) на другой. Если *dereference* равно [`False`](https://python-all.ru/3.5/library/constants.html#False), в архив добавляются символические и жёсткие ссылки. Если [`True`](https://python-all.ru/3.5/library/constants.html#True), в архив добавляется содержимое целевых файлов. Это не влияет на системы, не поддерживающие символические ссылки. Если *ignore\_zeros* равно [`False`](https://python-all.ru/3.5/library/constants.html#False), пустой блок считается концом архива. Если [`True`](https://python-all.ru/3.5/library/constants.html#True), пустые (и недействительные) блоки пропускаются, и предпринимается попытка получить как можно больше элементов. Это полезно только для чтения объединённых или повреждённых архивов. *debug* может быть установлен от `0` (нет отладочных сообщений) до `3` (все отладочные сообщения). Сообщения записываются в `sys.stderr`. Если *errorlevel* равен `0`, при использовании [`TarFile.extract()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.extract) все ошибки игнорируются. Тем не менее, если отладка включена, они отображаются как сообщения об ошибках в отладочном выводе. Если `1`, все *фатальные* ошибки вызывают исключения [`OSError`](https://python-all.ru/3.5/library/exceptions.html#OSError). Если `2`, все *нефатальные* ошибки также вызывают исключения [`TarError`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarError). Аргументы *encoding* и *errors* определяют кодировку символов, используемую для чтения или записи архива, и способ обработки ошибок преобразования. Настройки по умолчанию подходят для большинства пользователей. Подробную информацию см. в разделе [Проблемы Unicode](https://python-all.ru/3.5/library/tarfile.html#tar-unicode). Аргумент *pax\_headers* – необязательный словарь строк, который будет добавлен как глобальный заголовок pax, если *format* равно [`PAX_FORMAT`](https://python-all.ru/3.5/library/tarfile.html#tarfile.PAX_FORMAT). Изменено в версии 3.2: В качестве значения по умолчанию для аргумента *errors* используется `'surrogateescape'`. Изменено в версии 3.5: Добавлен режим `'x'` (эксклюзивное создание). #### `classmethod TarFile.open(...)` Альтернативный конструктор. Функция [`tarfile.open()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.open) на самом деле является сокращением для этого метода класса. #### `TarFile.getmember(name)` Возвращает объект [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) для элемента *name*. Если *name* не найден в архиве, возбуждается [`KeyError`](https://python-all.ru/3.5/library/exceptions.html#KeyError). > **Примечание** > > Если элемент встречается в архиве более одного раза, последнее его вхождение считается самой актуальной версией. #### `TarFile.getmembers()` Возвращает элементы архива в виде списка объектов [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo). Порядок списка соответствует порядку элементов в архиве. #### `TarFile.getnames()` Возвращает элементы в виде списка их имён. Порядок списка соответствует порядку списка, возвращаемого [`getmembers()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.getmembers). #### `TarFile.list(verbose=True, *, members=None)` Выводит оглавление в `sys.stdout`. Если *verbose* равно [`False`](https://python-all.ru/3.5/library/constants.html#False), печатаются только имена элементов. Если же [`True`](https://python-all.ru/3.5/library/constants.html#True), выводятся данные, аналогичные **ls -l**. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.getmembers). Изменено в версии 3.5: Добавлен параметр *members*. #### `TarFile.next()` Возвращает следующий элемент архива в виде объекта [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo), когда [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile) открыт для чтения. Если больше нет элементов, возвращает [`None`](https://python-all.ru/3.5/library/constants.html#None). #### `TarFile.extractall(path=".", members=None, *, numeric_owner=False)` Извлекает все элементы из архива в текущую рабочую директорию или в директорию *path*. Если задан необязательный параметр *members*, он должен быть подмножеством списка, возвращаемого [`getmembers()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.getmembers). Сведения о директории (владелец, время изменения, права доступа) устанавливаются после извлечения всех элементов. Это сделано для обхода двух проблем: время изменения директории сбрасывается при каждом создании в ней файла, и если права директории не разрешают запись, извлечение в неё файлов завершится ошибкой. Если *numeric\_owner* равно [`True`](https://python-all.ru/3.5/library/constants.html#True), для установки владельца и группы извлечённых файлов используются числовые uid и gid из tar-файла. В противном случае используются именованные значения из tar-файла. > **Предупреждение** > > Никогда не извлекайте архивы из ненадёжных источников без предварительной проверки. Возможно создание файлов за пределами *path*, например, элементов с абсолютными именами, начинающимися с `"/"`, или с именами, содержащими две точки `".."`. Изменено в версии 3.5: Добавлен параметр *numeric\_owner*. #### `TarFile.extract(member, path="", set_attrs=True, *, numeric_owner=False)` Извлекает элемент из архива в текущий рабочий каталог, используя его полное имя. Информация о файле извлекается как можно точнее. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo). Можно указать другой каталог с помощью *path*. Атрибуты файла (владелец, mtime, режим) устанавливаются, если *set\_attrs* не равен false. Если *numeric\_owner* равно [`True`](https://python-all.ru/3.5/library/constants.html#True), для установки владельца и группы извлечённых файлов используются числовые uid и gid из tar-файла. В противном случае используются именованные значения из tar-файла. > **Примечание** > > Метод [`extract()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.extract) не решает ряд проблем извлечения. В большинстве случаев стоит рассмотреть использование метода [`extractall()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.extractall). > **Предупреждение** > > См. предупреждение для [`extractall()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.extractall). Изменено в версии 3.2: Добавлен параметр *set\_attrs*. Изменено в версии 3.5: Добавлен параметр *numeric\_owner*. #### `TarFile.extractfile(member)` Извлекает элемент архива в виде файлового объекта. *member* может быть именем файла или объектом [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo). Если *member* является обычным файлом или ссылкой, возвращается объект [`io.BufferedReader`](https://python-all.ru/3.5/library/io.html#io.BufferedReader). В противном случае возвращается [`None`](https://python-all.ru/3.5/library/constants.html#None). Изменено в версии 3.3: Возвращается объект [`io.BufferedReader`](https://python-all.ru/3.5/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.5/library/constants.html#False). Если задан *exclude*, это должна быть функция, принимающая один аргумент – имя файла – и возвращающая логическое значение. В зависимости от этого значения соответствующий файл либо исключается ([`True`](https://python-all.ru/3.5/library/constants.html#True)), либо добавляется ([`False`](https://python-all.ru/3.5/library/constants.html#False)). Если указан *filter*, это должен быть именованный аргумент. Это должна быть функция, принимающая объект [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) и возвращающая изменённый объект [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo). Если вместо этого она возвращает [`None`](https://python-all.ru/3.5/library/constants.html#None), объект [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) будет исключён из архива. Пример см. в [Примерах](https://python-all.ru/3.5/library/tarfile.html#tar-examples). Изменено в версии 3.2: Добавлен параметр *filter*. Устарело с версии 3.2: Параметр *exclude* устарел; используйте вместо него параметр *filter* вместо него. #### `TarFile.addfile(tarinfo, fileobj=None)` Добавляет объект [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) *tarinfo* в архив. Если указан *fileobj*, он должен быть [двоичным файлом](https://python-all.ru/3.5/glossary.html#term-binary-file), из которого читаются `tarinfo.size` байтов и добавляются в архив. Можно создавать объекты [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) напрямую или с помощью [`gettarinfo()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.gettarinfo). #### `TarFile.gettarinfo(name=None, arcname=None, fileobj=None)` Создает объект [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) из результата [`os.stat()`](https://python-all.ru/3.5/library/os.html#os.stat) или эквивалентной операции над существующим файлом. Файл задается либо именем *name*, либо указывается как [файловый объект](https://python-all.ru/3.5/glossary.html#term-file-object) *fileobj* с файловым дескриптором. Если указан *arcname*, он задает альтернативное имя файла в архиве; в противном случае имя берется из атрибута [`name`](https://python-all.ru/3.5/library/io.html#io.FileIO.name) объекта *fileobj* или из аргумента *name*. Имя должно быть текстовой строкой. Можно изменить некоторые атрибуты объекта [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) перед его добавлением с помощью [`addfile()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile.addfile). Если файловый объект не является обычным файловым объектом, расположенным в начале файла, такие атрибуты, как [`size`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo.size), могут потребовать изменения. Это относится к таким объектам, как [`GzipFile`](https://python-all.ru/3.5/library/gzip.html#gzip.GzipFile). Атрибут [`name`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo.name) также может быть изменён, и в этом случае *arcname* может быть фиктивной строкой. #### `TarFile.close()` Закрывает [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile). В режиме записи в архив добавляются два завершающих нулевых блока. #### `TarFile.pax_headers` Словарь, содержащий пары ключ-значение глобальных заголовков pax. ## 13.6.2. Объекты TarInfo Объект [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) представляет один элемент в [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile). Помимо хранения всех необходимых атрибутов файла (таких как тип, размер, время, права доступа, владелец и т.д.), он предоставляет некоторые полезные методы для определения его типа. Он *не* содержит сами данные файла. [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) возвращаются методами [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile): `getmember()`, `getmembers()` и `gettarinfo()`. #### `class tarfile.TarInfo(name="")` Создаёт объект [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo). #### `classmethod TarInfo.frombuf(buf, encoding, errors)` Создаёт и возвращает объект [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo) из строкового буфера *buf*. Вызывает [`HeaderError`](https://python-all.ru/3.5/library/tarfile.html#tarfile.HeaderError), если буфер некорректен. #### `classmethod TarInfo.fromtarfile(tarfile)` Читает следующий элемент из объекта [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile) *tarfile* и возвращает его в виде объекта [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo). #### `TarInfo.tobuf(format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')` Создаёт строковый буфер из объекта [`TarInfo`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo). Подробнее об аргументах см. конструктор класса [`TarFile`](https://python-all.ru/3.5/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.5/library/tarfile.html#tarfile.TarInfo), используйте методы `is*()`, описанные ниже. #### `TarInfo.linkname` Имя целевого файла, которое присутствует только в объектах [`TarInfo`](https://python-all.ru/3.5/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.5/library/tarfile.html#tarfile.TarInfo) также предоставляет несколько удобных запросных методов: #### `TarInfo.isfile()` Возвращает [`True`](https://python-all.ru/3.5/library/constants.html#True), если объект `Tarinfo` является обычным файлом. #### `TarInfo.isreg()` То же, что и [`isfile()`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarInfo.isfile). #### `TarInfo.isdir()` Возвращает [`True`](https://python-all.ru/3.5/library/constants.html#True), если это каталог. #### `TarInfo.issym()` Возвращает [`True`](https://python-all.ru/3.5/library/constants.html#True), если это символическая ссылка. #### `TarInfo.islnk()` Возвращает [`True`](https://python-all.ru/3.5/library/constants.html#True), если это жёсткая ссылка. #### `TarInfo.ischr()` Возвращает [`True`](https://python-all.ru/3.5/library/constants.html#True), если это символьное устройство. #### `TarInfo.isblk()` Возвращает [`True`](https://python-all.ru/3.5/library/constants.html#True), если это блочное устройство. #### `TarInfo.isfifo()` Возвращает [`True`](https://python-all.ru/3.5/library/constants.html#True), если это FIFO. #### `TarInfo.isdev()` Возвращает [`True`](https://python-all.ru/3.5/library/constants.html#True), если это символьное устройство, блочное устройство или FIFO. ## 13.6.3. Интерфейс командной строки Новое в версии 3.4. Модуль [`tarfile`](https://python-all.ru/3.5/library/tarfile.html#module-tarfile) предоставляет простой интерфейс командной строки для работы с tar-архивами. Если вы хотите создать новый tar-архив, укажите его имя после опции [`-c`](https://python-all.ru/3.5/library/tarfile.html#cmdoption-tarfile-c), а затем перечислите имена файлов, которые должны быть включены: ```console $ python -m tarfile -c monty.tar spam.txt eggs.txt ``` Можно также передать каталог: ```console $ python -m tarfile -c monty.tar life-of-brian_1979/ ``` Если вы хотите извлечь tar-архив в текущий каталог, используйте опцию [`-e`](https://python-all.ru/3.5/library/tarfile.html#cmdoption-tarfile-e): ```console $ python -m tarfile -e monty.tar ``` Вы также можете извлечь tar-архив в другой каталог, передав его имя: ```console $ python -m tarfile -e monty.tar other-dir/ ``` Чтобы получить список файлов в tar-архиве, используйте опцию [`-l`](https://python-all.ru/3.5/library/tarfile.html#cmdoption-tarfile-l): ```console $ 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.5/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.5/reference/compound_stmts.html#with): ```python import tarfile with tarfile.open("sample.tar", "w") as tar: for name in ["foo", "bar", "quux"]: tar.add(name) ``` Как прочитать tar-архив, сжатый gzip, и вывести информацию о некоторых элементах: ```python import tarfile tar = tarfile.open("sample.tar.gz", "r:gz") for tarinfo in tar: print(tarinfo.name, "is", tarinfo.size, "bytes in size and is", end="") if tarinfo.isreg(): print("a regular file.") elif tarinfo.isdir(): print("a directory.") else: print("something else.") tar.close() ``` Как создать архив и сбросить информацию о пользователе, используя параметр *фильтр* в [`TarFile.add()`](https://python-all.ru/3.5/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.5/library/tarfile.html#module-tarfile): - Формат ustar POSIX.1-1988 ([`USTAR_FORMAT`](https://python-all.ru/3.5/library/tarfile.html#tarfile.USTAR_FORMAT)). Поддерживает имена файлов длиной не более 256 символов и имена ссылок не более 100 символов. Максимальный размер файла – 8 ГиБ. Это старый и ограниченный, но широко поддерживаемый формат. - Формат GNU tar ([`GNU_FORMAT`](https://python-all.ru/3.5/library/tarfile.html#tarfile.GNU_FORMAT)). Он поддерживает длинные имена файлов и ссылок, файлы размером более 8 ГиБ и разрежённые файлы. Это де-факто стандарт в системах GNU/Linux. [`tarfile`](https://python-all.ru/3.5/library/tarfile.html#module-tarfile) полностью поддерживает расширения GNU tar для длинных имён; поддержка разрежённых файлов – только для чтения. - Формат pax POSIX.1-2001 ([`PAX_FORMAT`](https://python-all.ru/3.5/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.5/library/tarfile.html#module-tarfile) управляются ключевыми аргументами *encoding* и *errors* класса [`TarFile`](https://python-all.ru/3.5/library/tarfile.html#tarfile.TarFile). *encoding* определяет кодировку символов, используемую для метаданных в архиве. Значение по умолчанию – [`sys.getfilesystemencoding()`](https://python-all.ru/3.5/library/sys.html#sys.getfilesystemencoding) или `'ascii'` в качестве запасного варианта. В зависимости от того, читается или записывается архив, метаданные должны быть либо декодированы, либо закодированы. Если *encoding* не установлена соответствующим образом, это преобразование может завершиться ошибкой. Аргумент *errors* определяет, как обрабатываются символы, которые невозможно преобразовать. Возможные значения перечислены в разделе [Обработчики ошибок](https://python-all.ru/3.5/library/codecs.html#error-handlers). Схема по умолчанию – `'surrogateescape'`, которую Python также использует для своих системных вызовов, см. [Имена файлов, аргументы командной строки и переменные окружения](https://python-all.ru/3.5/library/os.html#os-filenames). В случае архивов [`PAX_FORMAT`](https://python-all.ru/3.5/library/tarfile.html#tarfile.PAX_FORMAT) *encoding* обычно не нужен, поскольку все метаданные хранятся с использованием *UTF-8*. *encoding* используется только в редких случаях, когда декодируются бинарные pax-заголовки или когда сохраняются строки с суррогатными символами.