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, когда размер zipfile превышает 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-архивов, представленный как объект bytes.

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 — пароль для зашифрованных файлов в виде объекта bytes.

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

Примечание

Если имя файла элемента — абсолютный путь, системный диск/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 — пароль для зашифрованных файлов в виде объекта bytes object.

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

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

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

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

ZipFile.printdir()

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

ZipFile.setpassword(pwd)

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

ZipFile.read(name, pwd=None)

Возвращает байты файла name в архиве. name — имя файла в архиве или объект ZipInfo. Архив должен быть открыт для чтения или добавления. pwd — пароль, используемый для зашифрованных файлов, как объект bytes, и, если указан, переопределяет пароль по умолчанию, установленный с помощью 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 определяет расположение этого пути внутри архива zip, например, ‘dir/file.txt’, ‘dir/’ или ‘’. По умолчанию пустая строка, что означает корень.

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

Объекты Path можно перебирать, используя оператор / или joinpath.

Path.name

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

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

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

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

Изменено в версии 3.10.10: Параметр encoding можно передать как позиционный аргумент без вызова TypeError. Как это могло быть в 3.9. Код, которому требуется совместимость с неисправленными версиями 3.10 и 3.11, должен передавать все аргументы io.TextIOWrapper, включая encoding, в качестве именованных.

Path.iterdir()

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

Path.is_dir()

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

Path.is_file()

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

Path.exists()

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

Path.read_text(*, **)

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

Изменено в версии 3.10.10: Параметр encoding можно передать как позиционный аргумент без вызова TypeError. Как это могло быть в 3.9. Код, которому требуется совместимость с неисправленными версиями 3.10 и 3.11, должен передавать все аргументы io.TextIOWrapper, включая encoding, в качестве именованных.

Path.read_bytes()

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

Path.joinpath(*other)

Возвращает новый объект Path, соединив каждый из других аргументов. Следующие варианты эквивалентны:

>>> Path(...).joinpath('child').joinpath('grandchild')
>>> Path(...).joinpath('child', 'grandchild')
>>> Path(...) / 'child' / 'grandchild'

Изменено в версии 3.10: До версии 3.10, joinpath не документировался и принимал ровно один параметр.

Объекты 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, позволяет архивировать файлы, более старые, чем 01.01.1980, ценой установки временной метки на 01.01.1980. Аналогичное поведение наблюдается с файлами, более новыми, чем 31.12.2107, временная метка также устанавливается на предельное значение.

Новое в версии 3.6.

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

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

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

ZipInfo.is_dir()

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

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

Новое в версии 3.6.

ZipInfo.filename

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

ZipInfo.date_time

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

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

Примечание

Формат 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 может завершиться неудачей из-за проблем, перечисленных ниже.