zipfile — Работа с архивами ZIP

Объекты ZipFile

class zipfile.ZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, compresslevel=None, *, strict_timestamps=True)

Открывает ZIP-файл, где file может быть путём к файлу (строка), объектом типа «подобный файлу» или объектом-путь.

Параметр mode должен быть 'r' для чтения существующего файла, 'w' для обнуления и записи нового файла, 'a' для добавления к существующему файлу или 'x' для исключительного создания и записи нового файла. Если mode равен 'x' и file ссылается на существующий файл, будет поднято исключение FileExistsError. Если mode равен 'a' и file ссылается на существующий ZIP-архив, то к нему добавляются дополнительные файлы. Если file не ссылается на ZIP-архив, то новый ZIP-архив добавляется в файл. Это предназначено для добавления ZIP-архива в другой файл (например, python.exe). Если mode равен 'a' и файл вообще не существует, он создаётся. Если mode равен 'r' или 'a', файл должен быть доступен для поиска.

compression — метод сжатия ZIP, используемый при записи архива, и должен быть ZIP_STORED, ZIP_DEFLATED, ZIP_BZIP2 или ZIP_LZMA; нераспознанные значения приведут к поднятию исключения NotImplementedError. Если ZIP_DEFLATED, ZIP_BZIP2 или ZIP_LZMA указаны, но соответствующий модуль (zlib, bz2 или lzma) недоступен, будет поднято исключение RuntimeError. По умолчанию используется ZIP_STORED.

Если allowZip64 равно True (по умолчанию), zipfile создаст ZIP-файлы, использующие расширения ZIP64, если размер ZIP-файла больше 4 ГБ. Если оно равно false zipfile вызовет исключение, если ZIP-файлу потребуются расширения ZIP64.

Параметр compresslevel управляет уровнем сжатия при записи файлов в архив. При использовании ZIP_STORED или ZIP_LZMA он не влияет. При использовании ZIP_DEFLATED принимаются целые числа от 0 до 9 (см. zlib для получения дополнительной информации). При использовании ZIP_BZIP2 принимаются целые числа от 1 до 9 (см. bz2 для получения дополнительной информации).

Аргумент strict_timestamps, если установлен в False, позволяет архивировать файлы, более старые, чем 01.01.1980, за счёт установки метки времени на 01.01.1980. Аналогичное поведение наблюдается с файлами, более новыми, чем 31.12.2107, метка времени также устанавливается на предельное значение.

Если файл создан с режимом 'w', 'x' или 'a' и затем closed без добавления каких-либо файлов в архив, в файл будут записаны соответствующие структуры ZIP для пустого архива.

ZipFile также является менеджером контекста и, следовательно, поддерживает оператор with. В примере myzip закрывается после завершения блока оператора with, даже если произойдёт исключение:

with ZipFile('spam.zip', 'w') as myzip:
    myzip.write('eggs.txt')

Новое в версии 3.2: Добавлена возможность использования ZipFile как менеджера контекста.

Изменено в версии 3.3: Добавлена поддержка сжатия bzip2 и lzma.

Изменено в версии 3.4: Расширения ZIP64 включены по умолчанию.

Изменено в версии 3.5: Добавлена поддержка записи в потоки, недоступные для поиска. Добавлена поддержка режима 'x'.

Изменено в версии 3.6: Ранее для нераспознанных значений сжатия поднималось обычное исключение RuntimeError.

Изменено в версии 3.6.2: Параметр file принимает объект-путь.

Изменено в версии 3.7: Добавлен параметр compresslevel.

Новое в версии 3.8: Ключевой аргумент strict_timestamps

ZipFile.close()

Закрывает архивный файл. Необходимо вызвать close() перед завершением программы, иначе важные записи не будут записаны.

ZipFile.getinfo(name)

Возвращает объект ZipInfo с информацией о члене архива name. Вызов getinfo() для имени, не содержащегося в архиве, вызовет исключение KeyError.

ZipFile.infolist()

Возвращает список, содержащий объект ZipInfo для каждого члена архива. Объекты расположены в том же порядке, что и их записи в фактическом ZIP-файле на диске, если был открыт существующий архив.

ZipFile.namelist()

Возвращает список имен членов архива.

ZipFile.open(name, mode='r', pwd=None, *, force_zip64=False)

Доступ к члену архива в виде двоичного объекта, подобного файлу. name может быть именем файла внутри архива или объектом ZipInfo. Параметр mode, если он указан, должен быть 'r' (по умолчанию) или 'w'. pwd — пароль, используемый для расшифровки зашифрованных ZIP-архивов.

open() также является менеджером контекста и, следовательно, поддерживает оператор with:

with ZipFile('spam.zip') as myzip:
    with myzip.open('eggs.txt') as myfile:
        print(myfile.read())

При mode 'r' объект, подобный файлу (ZipExtFile) является только для чтения и предоставляет следующие методы: read(), readline(), readlines(), seek(), tell(), __iter__(), __next__(). Эти объекты могут работать независимо от ZipFile.

При mode='w', возвращается открытый для записи дескриптор файла, который поддерживает метод write(). Пока открыт дескриптор для записи, попытка чтения или записи других файлов в ZIP-архиве приведет к исключению ValueError.

При записи файла, если размер файла неизвестен заранее, но может превышать 2 ГБ, передайте force_zip64=True для обеспечения того, что формат заголовка может поддерживать файлы большого размера. Если размер файла известен заранее, создайте объект ZipInfo с установленным значением file_size и используйте его как параметр name.

Примечание

Методы open(), read() и extract() могут принимать имя файла или объект ZipInfo. Это пригодится при попытке чтения ZIP-архива, содержащего члены с дублирующимися именами.

Изменено в версии 3.6: Убрана поддержка mode='U'. Используйте io.TextIOWrapper для чтения сжатых текстовых файлов в режиме универсальных символов новой строки.

Изменено в версии 3.6: ZipFile.open() теперь можно использовать для записи файлов в архив с опцией mode='w'.

Изменено в версии 3.6: Вызов open() для закрытого ZipFile приведет к исключению ValueError. Ранее генерировалось исключение RuntimeError.

ZipFile.extract(member, path=None, pwd=None)

Извлечь член из архива в текущий рабочий каталог; member должен быть его полным именем или объектом ZipInfo. Его информация о файле извлекается максимально точно. path указывает другой каталог для извлечения. member может быть именем файла или объектом ZipInfo. pwd — пароль, используемый для зашифрованных файлов.

Возвращает нормализованный созданный путь (каталог или новый файл).

Примечание

Если имя файла члена — абсолютный путь, диск/совместный ресурс UNC и ведущие (обратные) косые черты будут удалены, например: ///foo/bar становится foo/bar в Unix и C:\foo\bar становится foo\bar в Windows. И все ".." компоненты в имени файла члена будут удалены, например: ../../foo../../ba..r становится foo../ba..r. В Windows недопустимые символы (:, <, >, |, ", ?, и *) заменяются подчеркиванием (_).

Изменено в версии 3.6: Вызов extract() для закрытого ZipFile приведет к исключению ValueError. Ранее генерировалось исключение RuntimeError.

Изменено в версии 3.6.2: Параметр path принимает объект, подобный пути.

ZipFile.extractall(path=None, members=None, pwd=None)

Извлечь все члены из архива в текущий рабочий каталог. path указывает другой каталог для извлечения. members необязательно и должно быть подмножеством списка, возвращаемого namelist(). pwd — пароль, используемый для зашифрованных файлов.

Предупреждение

Никогда не извлекайте архивы из ненадежных источников без предварительного осмотра. Возможно, файлы создаются вне path, например, члены, имеющие абсолютные имена файлов, начинающиеся с "/" или имена файлов с двумя точками "..". Этот модуль пытается предотвратить это. См. Примечание к extract().

Изменено в версии 3.6: Вызов extractall() для закрытого ZipFile приведет к исключению ValueError. Ранее генерировалось исключение RuntimeError.

Изменено в версии 3.6.2: Параметр path принимает объект, подобный пути.

ZipFile.printdir()

Вывести таблицу содержания архива в sys.stdout.

ZipFile.setpassword(pwd)

Установить pwd в качестве пароля по умолчанию для извлечения зашифрованных файлов.

ZipFile.read(name, pwd=None)

Возвращает байты файла name в архиве. name — имя файла в архиве или объект ZipInfo. Архив должен быть открыт для чтения или добавления. pwd — пароль, используемый для зашифрованных файлов, и, если задан, он переопределит пароль по умолчанию, установленный с помощью setpassword(). Вызов read() для ZipFile, использующего метод сжатия, отличный от ZIP_STORED, ZIP_DEFLATED, ZIP_BZIP2 или ZIP_LZMA, приведет к исключению NotImplementedError. Ошибка также будет вызвана, если соответствующий модуль сжатия недоступен.

Изменено в версии 3.6: Вызов read() для закрытого ZipFile приведет к исключению ValueError. Ранее генерировалось исключение RuntimeError.

ZipFile.testzip()

Прочитайте все файлы в архиве и проверьте их контрольные суммы CRC и заголовки файлов. Возвратите имя первого повреждённого файла, иначе верните None.

Изменено в версии 3.6: Вызов testzip() для закрытого объекта ZipFile вызовет исключение ValueError. Раньше это вызывало исключение RuntimeError.

ZipFile.write(filename, arcname=None, compress_type=None, compresslevel=None)

Запишите файл с именем filename в архив, присвоив ему имя в архиве arcname (по умолчанию это будет то же самое, что filename, но без буквенно-цифрового обозначения диска и с удалёнными ведущими разделителями пути). Если задано, compress_type переопределяет значение, заданное для параметра compression конструктору для новой записи. Аналогично, compresslevel переопределит конструктор, если задан. Архив должен быть открыт в режиме 'w', 'x' или 'a'.

Примечание

Имена архивов должны быть относительными к корню архива, то есть они не должны начинаться с разделителя пути.

Примечание

Если arcname (или filename, если arcname не задано) содержит нулевой байт, имя файла в архиве будет усечено на нулевом байте.

Примечание

Ведущая косая черта в имени файла может привести к тому, что архив станет недоступным для открытия в некоторых zip-программах на системах Windows.

Изменено в версии 3.6: Вызов write() для ZipFile, созданного в режиме 'r' или закрытого ZipFile, вызовет исключение ValueError. Раньше это вызывало исключение RuntimeError.

ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, compresslevel=None)

Запишите файл в архив. Содержимое — data, которое может быть либо экземпляром str, либо экземпляром bytes; если это str, оно сначала кодируется как UTF-8. zinfo_or_arcname — это либо имя файла, которое ему будет дано в архиве, либо экземпляр ZipInfo. Если это экземпляр, то должны быть указаны, по крайней мере, имя файла, дата и время. Если это имя, дата и время устанавливаются на текущие значения. Архив должен быть открыт в режиме 'w', 'x' или 'a'.

Если задано, compress_type переопределяет значение, заданное для параметра compression конструктору для новой записи, или в zinfo_or_arcname (если это экземпляр ZipInfo). Аналогично, compresslevel переопределит конструктор, если задан.

Примечание

При передаче экземпляра ZipInfo в качестве параметра zinfo_or_arcname, метод сжатия будет тот, который указан в члене compress_type заданного экземпляра ZipInfo. По умолчанию конструктор ZipInfo устанавливает этот член в ZIP_STORED.

Изменено в версии 3.2: Аргумент compress_type.

Изменено в версии 3.6: Вызов writestr() для ZipFile, созданного в режиме 'r' или закрытого ZipFile, вызовет исключение ValueError. Раньше это вызывало исключение RuntimeError.

Доступны следующие данные-атрибуты:

ZipFile.filename

Имя файла ZIP.

ZipFile.debug

Уровень отладочной информации. Может быть задано от 0 (по умолчанию, нет вывода) до 3 (максимум вывода). Данные отладки записываются в sys.stdout.

ZipFile.comment

Комментарий, связанный с файлом ZIP, в виде объекта bytes. Если вы присваиваете комментарий экземпляру ZipFile, созданному в режиме 'w', 'x' или 'a', он не должен превышать 65535 байтов. Комментарии длиннее этого будут усечены.

Объекты путей

class zipfile.Path(root, at='')

Создайте объект Path из root zip-архива (который может быть экземпляром ZipFile или file подходящим для передачи в конструктор ZipFile).

at определяет расположение этого Path в zip-архиве, например, ‘dir/file.txt’, ‘dir/’ или ''. По умолчанию пустая строка, указывающая корень.

Объекты Path предоставляют следующие функции объектов pathlib.Path:

Объекты Path могут перебираться с помощью оператора /.

Path.name

Последний компонент пути.

Path.open(mode='r', *, pwd, **)

Вызывает ZipFile.open() для текущего пути. Позволяет открыть для чтения или записи, текст или двоичные данные через поддерживаемые режимы: ‘r’, ‘w’, ‘rb’, ‘wb’. Позиционные и ключевые аргументы передаются в io.TextIOWrapper при открытии как текст и игнорируются в противном случае. pwd — параметр pwd для ZipFile.open().

Изменено в версии 3.9: Добавлена поддержка режимов текста и двоичных данных для open. Режим по умолчанию теперь текст.

Path.iterdir()

Перечислите дочерние элементы текущего каталога.

Path.is_dir()

Возвращает True, если текущий контекст ссылается на каталог.

Path.is_file()

Возвращает True если текущий контекст ссылается на файл.

Path.exists()

Возвращает True если текущий контекст ссылается на файл или каталог в zip-архиве.

Path.read_text(*, **)

Прочитайте текущий файл как текст Юникода. Позиционные и ключевые аргументы передаются в io.TextIOWrapper (кроме buffer, которое подразумевается контекстом).

Path.read_bytes()

Прочитайте текущий файл как байты.

Объекты PyZipFile

Конструктор PyZipFile принимает те же параметры, что и конструктор ZipFile, а также дополнительный параметр optimize.

class zipfile.PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, optimize=-1)

Добавлена в версии 3.2: Параметр optimize.

Изменено в версии 3.4: Расширения ZIP64 включены по умолчанию.

Экземпляры имеют один метод дополнительно к тем, что есть у объектов ZipFile:

writepy(pathname, basename='', filterfunc=None)

Поиск файлов *.py и добавление соответствующего файла в архив.

Если параметр optimize для PyZipFile не был задан или -1, соответствующий файл является файлом *.pyc и, при необходимости, компилируется.

Если параметр optimize для PyZipFile был 0, 1 или 2, в архив добавляются только файлы с этим уровнем оптимизации (см. compile()), при необходимости, компилируя их.

Если pathname является файлом, имя файла должно заканчиваться на .py, и только соответствующий *.pyc файл добавляется на верхнем уровне (без пути к файлу). Если pathname является файлом, не заканчивающимся на .py, будет выброшено исключение RuntimeError. Если это директория, и директория не является директорией пакета, все файлы *.pyc добавляются на верхнем уровне. Если директория является директорией пакета, все *.pyc добавляются под именем пакета как путь к файлу, и если какие-либо поддиректории являются директориями пакетов, все они добавляются рекурсивно в отсортированном порядке.

basename предназначен только для внутреннего использования.

filterfunc, если задан, должен быть функцией, принимающей один строковый аргумент. Он будет передан каждому пути (включая каждый отдельный полный путь к файлу) перед его добавлением в архив. Если filterfunc возвращает ложное значение, путь не будет добавлен, а содержимое директории будет проигнорировано. Например, если все наши тестовые файлы находятся в директориях test или начинаются со строки test_, мы можем использовать filterfunc для их исключения:

>>> zf = PyZipFile('myprog.zip')
>>> def notests(s):
...     fn = os.path.basename(s)
...     return (not (fn == 'test' or fn.startswith('test_')))
>>> zf.writepy('myprog', filterfunc=notests)

Метод writepy() создаёт архивы с именами файлов такого вида:

string.pyc                   # Top level name
test/__init__.pyc            # Package directory
test/testall.pyc             # Module test.testall
test/bogus/__init__.pyc      # Subpackage directory
test/bogus/myfile.pyc        # Submodule test.bogus.myfile

Добавлена в версии 3.4: Параметр filterfunc.

Изменено в версии 3.6.2: Параметр pathname принимает объект-путь.

Изменено в версии 3.7: Сортировка записей директорий в рекурсивном режиме.

Объекты ZipInfo

Экземпляры класса ZipInfo возвращаются методами getinfo() и infolist() объектов ZipFile. Каждый объект хранит информацию об одном члене архива ZIP.

Существует один класс-метод для создания экземпляра ZipInfo для файла файловой системы:

classmethod ZipInfo.from_file(filename, arcname=None, *, strict_timestamps=True)

Создаёт экземпляр ZipInfo для файла в файловой системе в качестве подготовки к добавлению его в архив zip.

filename должен быть путём к файлу или директории в файловой системе.

Если arcname задан, он используется как имя внутри архива. Если arcname не задан, имя будет таким же, как filename, но без буквенного обозначения диска и ведущих разделителей пути.

Аргумент strict_timestamps, при установке в False, позволяет добавлять файлы, которые старше 1980-01-01, но при этом дата и время устанавливаются на 1980-01-01. Подобное поведение наблюдается с файлами, более новыми, чем 2107-12-31, дата и время также устанавливаются на предельное значение.

Добавлена в версии 3.6.

Изменено в версии 3.6.2: Параметр filename принимает объект-путь.

Добавлена в версии 3.8: Ключевой аргумент strict_timestamps

Экземпляры имеют следующие методы и атрибуты:

ZipInfo.is_dir()

Возвращает True, если этот член архива является директорией.

Это используется по имени записи: директории всегда должны заканчиваться на /.

Добавлена в версии 3.6.

ZipInfo.filename

Имя файла в архиве.

ZipInfo.date_time

Время и дата последнего изменения члена архива. Это кортеж из шести значений:

Индекс	Значение
0	Год (>= 1980)
1	Месяц (от 1)
2	День месяца (от 1)
3	Часы (от 0)
4	Минуты (от 0)
5	Секунды (от 0)

Примечание

Формат ZIP-архива не поддерживает даты и время до 1980 года.

ZipInfo.compress_type

Тип сжатия для члена архива.

ZipInfo.comment

Комментарий к отдельному члену архива как объект bytes.

ZipInfo.extra

Данные расширения. Приложения к спецификации PKZIP содержат некоторые комментарии по внутренней структуре данных, содержащихся в этом объекте bytes.

ZipInfo.create_system

Система, которая создала ZIP-архив.

ZipInfo.create_version

Версия PKZIP, которая создала ZIP-архив.

ZipInfo.extract_version

Версия PKZIP, необходимая для извлечения архива.

ZipInfo.reserved

Должно быть равно нулю.

ZipInfo.flag_bits

Флаги ZIP.

ZipInfo.volume

Номер тома заголовка файла.

ZipInfo.internal_attr

Внутренние атрибуты.

ZipInfo.external_attr

Внешние атрибуты файла.

ZipInfo.header_offset

Смещение байта до заголовка файла.

ZipInfo.CRC

CRC-32 нескомпрессированного файла.

ZipInfo.compress_size

Размер сжатых данных.

ZipInfo.file_size

Размер нескомпрессированного файла.

Командная строка

Модуль zipfile предоставляет простой интерфейс командной строки для взаимодействия с архивами ZIP.

Если вы хотите создать новый архив ZIP, укажите его имя после опции -c, а затем перечислите имена файлов, которые должны быть включены:

$ python -m zipfile -c monty.zip spam.txt eggs.txt

Также допустимо передать каталог:

$ python -m zipfile -c monty.zip life-of-brian_1979/

Если вы хотите извлечь архив ZIP в указанный каталог, используйте опцию -e:

$ python -m zipfile -e monty.zip target-dir/

Для просмотра списка файлов в архиве ZIP используйте опцию -l:

$ python -m zipfile -l monty.zip

Возможные проблемы при распаковке

Распаковка в модуле zipfile может завершиться ошибкой из-за перечисленных ниже проблем.