`zipfile.md`

625 строк · 57.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.12/library/zipfile.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `zipfile` – Работа с ZIP-архивами89**Исходный код:** [Lib/zipfile/](https://python-all.ru/src/3.12/Lib/zipfile)1011---1213Формат ZIP – распространённый стандарт архивации и сжатия. Этот модуль предоставляет инструменты для создания, чтения, записи, добавления и просмотра содержимого ZIP-файлов. Любое продвинутое использование модуля требует понимания формата, описанного в [PKZIP Application Note](https://python-all.ru/3.12/library/zipfile.html).1415Модуль пока не поддерживает многодисковые ZIP-файлы. Он может обрабатывать ZIP-файлы, использующие расширения ZIP64 (то есть ZIP-файлы размером более 4 ГБ). Поддерживается расшифровка зашифрованных файлов в ZIP-архивах, но пока невозможно создать зашифрованный файл. Расшифровка выполняется очень медленно, так как реализована на чистом Python, а не на C.1617Модуль определяет следующие элементы:1819#### `exception zipfile.BadZipFile`2021Исключение, возникающее при повреждённых ZIP-файлах.2223Добавлено в версии 3.2.2425#### `exception zipfile.BadZipfile`2627Псевдоним [`BadZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.BadZipFile) для совместимости со старыми версиями Python.2829Устарело с версии 3.2.3031#### `exception zipfile.LargeZipFile`3233Исключение, возникающее, когда ZIP-файлу требуется функциональность ZIP64, но она не включена.3435#### `class zipfile.ZipFile`3637Класс для чтения и записи ZIP-файлов. Подробнее о конструкторе см. раздел [Объекты ZipFile](https://python-all.ru/3.12/library/zipfile.html#zipfile-objects).3839#### `class zipfile.Path`4041Класс, реализующий подмножество интерфейса, предоставляемого [`pathlib.Path`](https://python-all.ru/3.12/library/pathlib.html#pathlib.Path), включая полный интерфейс [`importlib.resources.abc.Traversable`](https://python-all.ru/3.12/library/importlib.resources.abc.html#importlib.resources.abc.Traversable).4243Добавлено в версии 3.8.4445#### `class zipfile.PyZipFile`4647Класс для создания ZIP-архивов, содержащих библиотеки Python.4849#### `class zipfile.ZipInfo(filename='NoName', date_time=(1980, 1, 1, 0, 0, 0))`5051Класс для представления информации об элементе архива. Экземпляры этого класса возвращаются методами [`getinfo()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.getinfo) и [`infolist()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.infolist) объектов [`ZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile). Большинству пользователей модуля [`zipfile`](https://python-all.ru/3.12/library/zipfile.html#module-zipfile) не потребуется создавать их самостоятельно – достаточно использовать те, что созданы этим модулем. *filename* должен содержать полное имя элемента архива, а *date\_time* – кортеж из шести полей, описывающих время последнего изменения файла. Описание полей приведено в разделе [Объекты ZipInfo](https://python-all.ru/3.12/library/zipfile.html#zipinfo-objects).5253#### `zipfile.is_zipfile(filename)`5455Возвращает `True`, если *filename* является корректным ZIP-файлом (проверка по магическому числу), иначе возвращает `False`. *filename* может быть файлом или файлоподобным объектом.5657Изменено в версии 3.1: Добавлена поддержка файлов и файлоподобных объектов.5859#### `zipfile.ZIP_STORED`6061Числовая константа для несжатого элемента архива.6263#### `zipfile.ZIP_DEFLATED`6465Числовая константа для стандартного метода сжатия ZIP. Требует модуль [`zlib`](https://python-all.ru/3.12/library/zlib.html#module-zlib).6667#### `zipfile.ZIP_BZIP2`6869Числовая константа для метода сжатия BZIP2. Для этого требуется модуль [`bz2`](https://python-all.ru/3.12/library/bz2.html#module-bz2).7071Добавлено в версии 3.3.7273#### `zipfile.ZIP_LZMA`7475Числовая константа для метода сжатия LZMA. Для этого требуется модуль [`lzma`](https://python-all.ru/3.12/library/lzma.html#module-lzma).7677Добавлено в версии 3.3.7879> **Примечание**80>81> Спецификация формата ZIP поддерживает сжатие bzip2 с 2001 года и сжатие LZMA с 2006 года. Однако некоторые инструменты (включая старые версии Python) не поддерживают эти методы сжатия и могут либо полностью отказаться обрабатывать ZIP-файл, либо не извлечь отдельные файлы.8283> **См. также**84>85> **[Примечание по применению PKZIP](https://python-all.ru/3.12/library/zipfile.html)**86>87> Документация по формату ZIP-файлов от Фила Каца, создателя формата и используемых алгоритмов.88>89> **[Домашняя страница Info-ZIP](https://python-all.ru/3.12/library/zipfile.html)**90>91> Информация о программах для работы с ZIP-архивами и библиотеках для разработки проекта Info-ZIP.9293## Объекты ZipFile9495#### `class zipfile.ZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, compresslevel=None, *, strict_timestamps=True, metadata_encoding=None)`9697Открывает ZIP-файл, где *file* может быть путём к файлу (строка), файлоподобным объектом или [объектом, подобным пути](https://python-all.ru/3.12/glossary.html#term-path-like-object).9899Параметр *mode* должен быть `'r'` для чтения существующего файла, `'w'` для усечения и записи нового файла, `'a'` для добавления к существующему файлу или `'x'` для исключительного создания и записи нового файла. Если *mode* равен `'x'` и *file* указывает на существующий файл, будет вызвано исключение [`FileExistsError`](https://python-all.ru/3.12/library/exceptions.html#FileExistsError). Если *mode* равен `'a'` и *file* указывает на существующий ZIP-файл, в него добавляются дополнительные файлы. Если *file* не указывает на ZIP-файл, то в конец файла добавляется новый ZIP-архив. Это предназначено для добавления ZIP-архива в другой файл (например, `python.exe`). Если *mode* равен `'a'` и файл вообще не существует, он создаётся. Если *mode* равен `'r'` или `'a'`, файл должен поддерживать позиционирование.100101Параметр *compression* задает метод сжатия ZIP, используемый при записи архива; это должно быть [`ZIP_STORED`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_STORED), [`ZIP_DEFLATED`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_DEFLATED), [`ZIP_BZIP2`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_BZIP2) или [`ZIP_LZMA`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_LZMA); неподдерживаемые значения приведут к возбуждению [`NotImplementedError`](https://python-all.ru/3.12/library/exceptions.html#NotImplementedError). Если указано [`ZIP_DEFLATED`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_DEFLATED), [`ZIP_BZIP2`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_BZIP2) или [`ZIP_LZMA`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_LZMA), но соответствующий модуль ([`zlib`](https://python-all.ru/3.12/library/zlib.html#module-zlib), [`bz2`](https://python-all.ru/3.12/library/bz2.html#module-bz2) или [`lzma`](https://python-all.ru/3.12/library/lzma.html#module-lzma)) недоступен, возбуждается [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError). По умолчанию используется [`ZIP_STORED`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_STORED).102103Если *allowZip64* равен `True` (по умолчанию), zipfile будет создавать ZIP-файлы с расширениями ZIP64, когда размер zip-файла превышает 4 ГиБ. Если он равен `false`, [`zipfile`](https://python-all.ru/3.12/library/zipfile.html#module-zipfile) возбудит исключение, когда ZIP-файлу потребуются расширения ZIP64.104105Параметр *compresslevel* управляет уровнем сжатия при записи файлов в архив. При использовании [`ZIP_STORED`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_STORED) или [`ZIP_LZMA`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_LZMA) он не влияет. При использовании [`ZIP_DEFLATED`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_DEFLATED) принимаются целые числа от `0` до `9` (подробнее см. [`zlib`](https://python-all.ru/3.12/library/zlib.html#zlib.compressobj)). При использовании [`ZIP_BZIP2`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_BZIP2) принимаются целые числа от `1` до `9` (подробнее см. [`bz2`](https://python-all.ru/3.12/library/bz2.html#bz2.BZ2File)).106107Аргумент *strict\_timestamps* при значении `False` позволяет архивировать файлы старше 1980-01-01, ценой установки временной метки на 1980-01-01. Аналогичное поведение для файлов новее 2107-12-31: временная метка также устанавливается на предельное значение.108109Если режим равен `'r'`, *metadata\_encoding* можно задать как имя кодека, который будет использоваться для декодирования метаданных, таких как имена элементов и ZIP-комментарии.110111Если файл создан с режимом `'w'`, `'x'` или `'a'`, а затем [`closed`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.close) без добавления каких-либо файлов в архив, в файл будут записаны соответствующие структуры ZIP для пустого архива.112113ZipFile также является контекстным менеджером и поэтому поддерживает оператор [`with`](https://python-all.ru/3.12/reference/compound_stmts.html#with). В примере *myzip* закрывается после завершения блока оператора `with` – даже если возникло исключение:114115```python116with ZipFile('spam.zip', 'w') as myzip:117    myzip.write('eggs.txt')118```119120> **Примечание**121>122> *metadata\_encoding* – настройка, применяемая ко всему экземпляру ZipFile. Задать её для каждого элемента по отдельности пока нельзя.123>124> Этот атрибут – обходной путь для устаревших реализаций, которые создают архивы с именами в кодировке текущей локали или кодовой странице (в основном в Windows). Согласно стандарту .ZIP, кодировка метаданных может быть указана как IBM code page (по умолчанию) или UTF-8 с помощью флага в заголовке архива. Этот флаг имеет приоритет над *metadata\_encoding*, который является расширением, специфичным для Python.125126Изменено в версии 3.2: Добавлена возможность использования [`ZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile) в качестве контекстного менеджера.127128Изменено в версии 3.3: Добавлена поддержка сжатия [`bzip2`](https://python-all.ru/3.12/library/bz2.html#module-bz2) и [`lzma`](https://python-all.ru/3.12/library/lzma.html#module-lzma).129130Изменено в версии 3.4: Расширения ZIP64 включены по умолчанию.131132Изменено в версии 3.5: Добавлена поддержка записи в непозиционируемые потоки. Добавлена поддержка режима `'x'`.133134Изменено в версии 3.6: Ранее для нераспознанных значений сжатия возбуждалось простое исключение [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError).135136Изменено в версии 3.6.2: Параметр *file* принимает [объект, подобный пути](https://python-all.ru/3.12/glossary.html#term-path-like-object).137138Изменено в версии 3.7: Добавлен параметр *compresslevel*.139140Изменено в версии 3.8: Параметр *strict\_timestamps*, передаваемый только по ключу.141142Изменено в версии 3.11: Добавлена поддержка указания кодировки имени элемента для чтения метаданных в заголовках каталога и файлов zipfile.143144#### `ZipFile.close()`145146Закрывает файл архива. Перед выходом из программы необходимо вызвать [`close()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.close), иначе важные записи не будут записаны.147148#### `ZipFile.getinfo(name)`149150Возвращает объект [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo) с информацией об элементе архива *name*. Вызов [`getinfo()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.getinfo) для имени, отсутствующего в архиве, приведёт к возникновению исключения [`KeyError`](https://python-all.ru/3.12/library/exceptions.html#KeyError).151152#### `ZipFile.infolist()`153154Возвращает список, содержащий объект [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo) для каждого элемента архива. Объекты расположены в том же порядке, что и их записи в реальном ZIP-файле на диске, если был открыт существующий архив.155156#### `ZipFile.namelist()`157158Возвращает список элементов архива по именам.159160#### `ZipFile.open(name, mode='r', pwd=None, *, force_zip64=False)`161162Предоставляет доступ к элементу архива в виде двоичного файлоподобного объекта. *name* может быть именем файла внутри архива или объектом [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo). Параметр *mode*, если указан, должен быть равен `'r'` (по умолчанию) или `'w'`. *pwd* – это пароль для расшифровки зашифрованных ZIP-файлов в виде объекта [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).163164[`open()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.open) также является контекстным менеджером и поэтому поддерживает оператор [`with`](https://python-all.ru/3.12/reference/compound_stmts.html#with):165166```python167with ZipFile('spam.zip') as myzip:168    with myzip.open('eggs.txt') as myfile:169        print(myfile.read())170```171172При *mode* `'r'` файлоподобный объект (`ZipExtFile`) доступен только для чтения и предоставляет следующие методы: [`read()`](https://python-all.ru/3.12/library/io.html#io.BufferedIOBase.read), [`readline()`](https://python-all.ru/3.12/library/io.html#io.IOBase.readline), [`readlines()`](https://python-all.ru/3.12/library/io.html#io.IOBase.readlines), [`seek()`](https://python-all.ru/3.12/library/io.html#io.IOBase.seek), [`tell()`](https://python-all.ru/3.12/library/io.html#io.IOBase.tell), [`__iter__()`](https://python-all.ru/3.12/library/stdtypes.html#container.__iter__), [`__next__()`](https://python-all.ru/3.12/library/stdtypes.html#iterator.__next__). Эти объекты могут работать независимо от ZipFile.173174При `mode='w'` возвращается дескриптор файла для записи, который поддерживает метод [`write()`](https://python-all.ru/3.12/library/io.html#io.BufferedIOBase.write). Пока дескриптор для записи открыт, попытка чтения или записи других файлов в ZIP-архиве приведёт к возникновению исключения [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError).175176При записи файла, если размер файла заранее неизвестен, но может превысить 2 ГБ, передайте `force_zip64=True`, чтобы формат заголовка мог поддерживать большие файлы. Если размер файла известен заранее, создайте объект [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo) с установленным [`file_size`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo.file_size) и используйте его в качестве параметра *name*.177178> **Примечание**179>180> Методы [`open()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.open), [`read()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.read) и [`extract()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.extract) могут принимать имя файла или объект [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo). Это пригодится при попытке чтения ZIP-файла, содержащего элементы с повторяющимися именами.181182Изменено в версии 3.6: Удалена поддержка `mode='U'`. Используйте [`io.TextIOWrapper`](https://python-all.ru/3.12/library/io.html#io.TextIOWrapper) для чтения сжатых текстовых файлов в режиме [универсальные символы новой строки](https://python-all.ru/3.12/glossary.html#term-universal-newlines).183184Изменено в версии 3.6: Теперь [`ZipFile.open()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.open) можно использовать для записи файлов в архив с опцией `mode='w'`.185186Изменено в версии 3.6: Вызов [`open()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.open) для закрытого ZipFile приводит к исключению [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError). Ранее вызывалось исключение [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError).187188#### `ZipFile.extract(member, path=None, pwd=None)`189190Извлекает элемент из архива в текущий рабочий каталог; *member* должно быть полным именем или объектом [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo). Информация о файле извлекается максимально точно. *path* указывает другой каталог для извлечения. *member* может быть именем файла или объектом [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo). *pwd* – пароль для зашифрованных файлов в виде объекта [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).191192Возвращает нормализованный путь (каталог или новый файл).193194> **Примечание**195>196> Если имя файла элемента является абсолютным путём, диск/UNC-точка и начальные (обратные) слеши будут удалены, например: `///foo/bar` становится `foo/bar` на Unix, а `C:\foo\bar` становится `foo\bar` на Windows. Все компоненты `".."` в имени файла элемента будут удалены, например: `../../foo../../ba..r` становится `foo../ba..r`. На Windows недопустимые символы (`:`, `<`, `>`, `|`, `"`, `?` и `*`) заменяются подчёркиванием (`_`).197198Изменено в версии 3.6: Вызов [`extract()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.extract) для закрытого ZipFile приводит к исключению [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError). Ранее вызывалось исключение [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError).199200Изменено в версии 3.6.2: Параметр *path* принимает [объект, подобный пути](https://python-all.ru/3.12/glossary.html#term-path-like-object).201202#### `ZipFile.extractall(path=None, members=None, pwd=None)`203204Извлекает все элементы из архива в текущий рабочий каталог. *path* указывает другой каталог для извлечения. *members* необязателен и должен быть подмножеством списка, возвращаемого [`namelist()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.namelist). *pwd* – пароль для зашифрованных файлов в виде объекта [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).205206> **Предупреждение**207>208> Никогда не извлекайте архивы из ненадёжных источников без предварительной проверки. Существует вероятность создания файлов за пределами *path*, например, элементы с абсолютными именами файлов, начинающимися с `"/"`, или имена файлов с двумя точками `".."`. Модуль пытается предотвратить это. См. примечание [`extract()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.extract).209210Изменено в версии 3.6: Вызов [`extractall()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.extractall) для закрытого ZipFile приводит к исключению [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError). Ранее вызывалось исключение [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError).211212Изменено в версии 3.6.2: Параметр *path* принимает [объект, подобный пути](https://python-all.ru/3.12/glossary.html#term-path-like-object).213214#### `ZipFile.printdir()`215216Выводит оглавление архива в `sys.stdout`.217218#### `ZipFile.setpassword(pwd)`219220Устанавливает *pwd* (объект [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes)) в качестве пароля по умолчанию для извлечения зашифрованных файлов.221222#### `ZipFile.read(name, pwd=None)`223224Возвращает содержимое файла *name* из архива в виде байтов. *name* – это имя файла в архиве или объект [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo). Архив должен быть открыт для чтения или добавления. *pwd* – пароль для зашифрованных файлов в виде объекта [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes); если указан, он переопределяет пароль, заданный с помощью [`setpassword()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.setpassword). Вызов [`read()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.read) для ZipFile, использующего метод сжатия, отличный от [`ZIP_STORED`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_STORED), [`ZIP_DEFLATED`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_DEFLATED), [`ZIP_BZIP2`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_BZIP2) или [`ZIP_LZMA`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_LZMA), приведет к возбуждению [`NotImplementedError`](https://python-all.ru/3.12/library/exceptions.html#NotImplementedError). Ошибка также будет возбуждена, если соответствующий модуль сжатия недоступен.225226Изменено в версии 3.6: Вызов [`read()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.read) для закрытого ZipFile приводит к исключению [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError). Ранее вызывалось исключение [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError).227228#### `ZipFile.testzip()`229230Читает все файлы архива и проверяет их CRC и заголовки файлов. Возвращает имя первого повреждённого файла или `None`.231232Изменено в версии 3.6: Вызов [`testzip()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.testzip) для закрытого ZipFile приводит к исключению [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError). Ранее вызывалось исключение [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError).233234#### `ZipFile.write(filename, arcname=None, compress_type=None, compresslevel=None)`235236Записывает файл с именем *filename* в архив, присваивая ему архивное имя *arcname* (по умолчанию оно совпадает с *filename*, но без буквы диска и с удалёнными начальными разделителями путей). Если указан, *compress\_type* переопределяет значение, переданное в параметре *compression* конструктору для новой записи. Аналогично, *compresslevel* переопределит конструктор, если указан. Архив должен быть открыт с режимом `'w'`, `'x'` или `'a'`.237238> **Примечание**239>240> Стандарт ZIP-файлов исторически не определял кодировку метаданных, но настоятельно рекомендовал CP437 (оригинальную кодировку IBM PC) для совместимости. Последние версии допускают использование только UTF-8. В этом модуле UTF-8 будет автоматически использоваться для записи имён элементов, если они содержат любые не-ASCII символы. Невозможно записать имена элементов в любой кодировке, кроме ASCII или UTF-8.241242> **Примечание**243>244> Архивные имена должны быть относительными по отношению к корню архива, то есть не должны начинаться с разделителя пути.245246> **Примечание**247>248> Если `arcname` (или `filename`, если `arcname` не указан) содержит нулевой байт, имя файла в архиве будет обрезано по этому байту.249250> **Примечание**251>252> Начальный слэш в имени файла может привести к невозможности открытия архива в некоторых ZIP-программах в системах Windows.253254Изменено в версии 3.6: Вызов [`write()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.write) для ZipFile, созданного с режимом `'r'`, или для закрытого ZipFile приведёт к исключению [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError). Ранее вызывалось исключение [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError).255256#### `ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, compresslevel=None)`257258Записывает файл в архив. Содержимое – это *data*, который может быть экземпляром [`str`](https://python-all.ru/3.12/library/stdtypes.html#str) или [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes); если это [`str`](https://python-all.ru/3.12/library/stdtypes.html#str), то он сначала кодируется в UTF-8. *zinfo\_or\_arcname* – это либо имя файла, которое он получит в архиве, либо экземпляр [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo). Если это экземпляр, должны быть указаны как минимум имя файла, дата и время. Если это имя, дата и время устанавливаются на текущие дату и время. Архив должен быть открыт с режимом `'w'`, `'x'` или `'a'`.259260Если указан, *compress\_type* переопределяет значение, переданное в параметре *compression* конструктору для новой записи, или значение в *zinfo\_or\_arcname* (если это экземпляр [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo)). Аналогично, *compresslevel* переопределит конструктор, если указан.261262> **Примечание**263>264> При передаче экземпляра [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo) в качестве параметра *zinfo\_or\_arcname* используемый метод сжатия будет тем, который указан в элементе *compress\_type* данного экземпляра [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo). По умолчанию конструктор [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo) устанавливает этот элемент в [`ZIP_STORED`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZIP_STORED).265266Изменено в версии 3.2: Аргумент *compress\_type*.267268Изменено в версии 3.6: Вызов [`writestr()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.writestr) для ZipFile, созданного с режимом `'r'`, или для закрытого ZipFile приведёт к исключению [`ValueError`](https://python-all.ru/3.12/library/exceptions.html#ValueError). Ранее вызывалось исключение [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError).269270#### `ZipFile.mkdir(zinfo_or_directory, mode=511)`271272Создаёт каталог внутри архива. Если *zinfo\_or\_directory* – строка, каталог создаётся внутри архива с режимом, указанным в аргументе *mode*. Однако если *zinfo\_or\_directory* является экземпляром [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo), то аргумент *mode* игнорируется.273274Архив должен быть открыт с режимом `'w'`, `'x'` или `'a'`.275276Добавлено в версии 3.12.277278Также доступны следующие атрибуты данных:279280#### `ZipFile.filename`281282Имя ZIP-файла.283284#### `ZipFile.debug`285286Уровень отладочного вывода. Может быть установлен от `0` (по умолчанию, без вывода) до `3` (максимальный вывод). Отладочная информация записывается в `sys.stdout`.287288#### `ZipFile.comment`289290Комментарий, связанный с ZIP-файлом, в виде объекта [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes). Если присваивать комментарий экземпляру [`ZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile), созданному с режимом `'w'`, `'x'` или `'a'`, его длина не должна превышать 65535 байт. Комментарии длиннее этого будут обрезаны.291292## Объекты Path293294#### `class zipfile.Path(root, at='')`295296Создаёт объект Path из zip-файла `root` (который может быть экземпляром [`ZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile) или `file`, подходящим для передачи в конструктор [`ZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile)).297298`at` задаёт расположение этого Path внутри zip-файла, например, ‘dir/file.txt’, ‘dir/’ или ‘’. По умолчанию – пустая строка, что означает корень.299300> **Примечание**301>302> Класс [`Path`](https://python-all.ru/3.12/library/zipfile.html#zipfile.Path) не проверяет имена файлов внутри ZIP-архива. В отличие от методов [`ZipFile.extract()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.extract) и [`ZipFile.extractall()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.extractall), обязанность проверять и очищать имена файлов для предотвращения уязвимостей обхода пути (например, имена, содержащие «..» или абсолютные пути) лежит на вызывающем коде. При работе с архивами из ненадёжных источников рекомендуется разрешать имена файлов с помощью [`os.path.abspath()`](https://python-all.ru/3.12/library/os.path.html#os.path.abspath) и проверять их относительно целевого каталога с помощью [`os.path.commonpath()`](https://python-all.ru/3.12/library/os.path.html#os.path.commonpath).303304Объекты Path предоставляют следующие возможности объектов [`pathlib.Path`](https://python-all.ru/3.12/library/pathlib.html#pathlib.Path) :305306Объекты Path можно обходить с помощью оператора `/` или `joinpath`.307308#### `Path.name`309310Последний компонент пути.311312#### `Path.open(mode='r', *, pwd, **)`313314Вызывает [`ZipFile.open()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.open) для текущего пути. Позволяет открывать для чтения или записи, в текстовом или двоичном режиме через поддерживаемые режимы: ‘r’, ‘w’, ‘rb’, ‘wb’. Позиционные и именованные аргументы передаются в [`io.TextIOWrapper`](https://python-all.ru/3.12/library/io.html#io.TextIOWrapper) при открытии как текст и игнорируются в противном случае. `pwd` – это параметр `pwd` для [`ZipFile.open()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.open).315316Изменено в версии 3.9: Добавлена поддержка текстового и двоичного режимов для open. Режим по умолчанию теперь текстовый.317318Изменено в версии 3.11.2: Параметр `encoding` теперь можно передавать как позиционный аргумент, не вызывая [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError). Как это было возможно в 3.9. Код, которому требуется совместимость с неисправленными версиями 3.10 и 3.11, должен передавать все аргументы [`io.TextIOWrapper`](https://python-all.ru/3.12/library/io.html#io.TextIOWrapper), включая `encoding`, только как именованные.319320#### `Path.iterdir()`321322Перечисляет дочерние элементы текущего каталога.323324#### `Path.is_dir()`325326Возвращает `True`, если текущий контекст ссылается на каталог.327328#### `Path.is_file()`329330Возвращает `True`, если текущий контекст ссылается на файл.331332#### `Path.exists()`333334Возвращает `True`, если текущий контекст ссылается на файл или каталог внутри zip-файла.335336#### `Path.suffix`337338Расширение файла последнего компонента пути.339340Добавлено в версии 3.11: Добавлено свойство [`Path.suffix`](https://python-all.ru/3.12/library/zipfile.html#zipfile.Path.suffix).341342#### `Path.stem`343344Конечный компонент пути без его суффикса.345346Добавлено в версии 3.11: Добавлено свойство [`Path.stem`](https://python-all.ru/3.12/library/zipfile.html#zipfile.Path.stem).347348#### `Path.suffixes`349350Список расширений файлов пути.351352Добавлено в версии 3.11: Добавлено свойство [`Path.suffixes`](https://python-all.ru/3.12/library/zipfile.html#zipfile.Path.suffixes).353354#### `Path.read_text(*, **)`355356Читает текущий файл как текст в кодировке Unicode. Позиционные и именованные аргументы передаются в [`io.TextIOWrapper`](https://python-all.ru/3.12/library/io.html#io.TextIOWrapper) (кроме `buffer`, который подразумевается контекстом).357358Изменено в версии 3.11.2: Параметр `encoding` теперь можно передавать как позиционный аргумент, не вызывая [`TypeError`](https://python-all.ru/3.12/library/exceptions.html#TypeError). Как это было возможно в 3.9. Код, которому требуется совместимость с неисправленными версиями 3.10 и 3.11, должен передавать все аргументы [`io.TextIOWrapper`](https://python-all.ru/3.12/library/io.html#io.TextIOWrapper), включая `encoding`, только как именованные.359360#### `Path.read_bytes()`361362Читает текущий файл как байты.363364#### `Path.joinpath(*other)`365366Возвращает новый объект Path, объединяя каждый аргумент *other*. Следующие вызовы эквивалентны:367368```python369>>> Path(...).joinpath('child').joinpath('grandchild')370>>> Path(...).joinpath('child', 'grandchild')371>>> Path(...) / 'child' / 'grandchild'372```373374Изменено в версии 3.10: До версии 3.10 `joinpath` не был документирован и принимал ровно один параметр.375376Проект [zipp](https://python-all.ru/3.12/library/zipfile.html) предоставляет обратные порты последних возможностей объекта path для старых версий Python. Используйте `zipp.Path` вместо `zipfile.Path` для раннего доступа к изменениям.377378## Объекты PyZipFile379380Конструктор [`PyZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.PyZipFile) принимает те же параметры, что и конструктор [`ZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile), плюс один дополнительный параметр *optimize*.381382#### `class zipfile.PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, optimize=-1)`383384Изменено в версии 3.2: Добавлен параметр *optimize*.385386Изменено в версии 3.4: Расширения ZIP64 включены по умолчанию.387388Экземпляры имеют один метод в дополнение к методам [`ZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile) объектов:389390#### `writepy(pathname, basename='', filterfunc=None)`391392Ищет файлы `*.py` и добавляет соответствующий файл в архив.393394Если параметру *optimize* в [`PyZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.PyZipFile) не было задано значение или он равен `-1`, то соответствующим файлом является `*.pyc` файл, при необходимости компилируемый.395396Если параметру *optimize* в [`PyZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.PyZipFile) было задано значение `0`, `1` или `2`, в архив добавляются только файлы с таким уровнем оптимизации (см. [`compile()`](https://python-all.ru/3.12/library/functions.html#compile)), при необходимости компилируемые.397398Если *pathname* – это файл, его имя должно заканчиваться на `.py`, и в корень архива добавляется только (соответствующий `*.pyc`) файл (без информации о пути). Если *pathname* – это файл, не заканчивающийся на `.py`, будет возбуждено [`RuntimeError`](https://python-all.ru/3.12/library/exceptions.html#RuntimeError). Если это каталог и он не является каталогом пакета, то все файлы `*.pyc` добавляются в корень. Если каталог является каталогом пакета, то все `*.pyc` добавляются под именем пакета как путь к файлу, а если какие-либо подкаталоги являются каталогами пакетов, все они добавляются рекурсивно в отсортированном порядке.399400*basename* предназначен только для внутреннего использования.401402*filterfunc*, если задан, должен быть функцией, принимающей один строковый аргумент. Ей будет передаваться каждый путь (включая каждый полный путь к файлу) перед добавлением в архив. Если *filterfunc* возвращает ложное значение, путь не будет добавлен, а если это каталог, его содержимое будет проигнорировано. Например, если все наши тестовые файлы находятся в каталогах `test` или начинаются со строки `test_`, мы можем использовать *filterfunc* для их исключения:403404```python405>>> zf = PyZipFile('myprog.zip')406>>> def notests(s):407...     fn = os.path.basename(s)408...     return (not (fn == 'test' or fn.startswith('test_')))409...410>>> zf.writepy('myprog', filterfunc=notests)411```412413Метод [`writepy()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.PyZipFile.writepy) создаёт архивы с именами файлов следующего вида:414415```python416string.pyc                   # Имя верхнего уровня417test/__init__.pyc            # Каталог пакета418test/testall.pyc             # Модуль test.testall419test/bogus/__init__.pyc      # Каталог подпакета420test/bogus/myfile.pyc        # Подмодуль test.bogus.myfile421```422423Изменено в версии 3.4: Добавлен параметр *filterfunc*.424425Изменено в версии 3.6.2: Параметр *pathname* теперь принимает [объект, подобный пути](https://python-all.ru/3.12/glossary.html#term-path-like-object).426427Изменено в версии 3.7: Рекурсия сортирует записи каталога.428429## Объекты ZipInfo430431Экземпляры класса [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo) возвращаются методами [`getinfo()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.getinfo) и [`infolist()`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile.infolist) объектов [`ZipFile`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipFile). Каждый объект хранит информацию об одном элементе ZIP-архива.432433Существует один метод класса для создания экземпляра [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo) для файла в файловой системе:434435#### `classmethod ZipInfo.from_file(filename, arcname=None, *, strict_timestamps=True)`436437Создаёт экземпляр [`ZipInfo`](https://python-all.ru/3.12/library/zipfile.html#zipfile.ZipInfo) для файла в файловой системе, подготавливая его для добавления в zip-архив.438439Параметр *filename* должен быть путём к файлу или каталогу в файловой системе.440441Если *arcname* указан, он используется как имя внутри архива. Если *arcname* не указан, имя будет совпадать с *filename*, но без буквы диска и ведущих разделителей пути.442443Аргумент *strict\_timestamps* при значении `False` позволяет архивировать файлы старше 1980-01-01, ценой установки временной метки на 1980-01-01. Аналогичное поведение для файлов новее 2107-12-31: временная метка также устанавливается на предельное значение.444445Добавлено в версии 3.6.446447Изменено в версии 3.6.2: Параметр *filename* теперь принимает [объект, подобный пути](https://python-all.ru/3.12/glossary.html#term-path-like-object).448449Изменено в версии 3.8: Добавлен параметр *strict\_timestamps*, передаваемый только по ключу.450451Экземпляры имеют следующие методы и атрибуты:452453#### `ZipInfo.is_dir()`454455Возвращает `True`, если данный элемент архива является каталогом.456457Используется имя записи: каталоги всегда должны заканчиваться на `/`.458459Добавлено в версии 3.6.460461#### `ZipInfo.filename`462463Имя файла в архиве.464465#### `ZipInfo.date_time`466467Время и дата последнего изменения элемента архива. Это кортеж из шести значений:468469| Индекс | Значение |470| --- | --- |471| `0` | Год (\>= 1980) |472| `1` | Месяц (начиная с 1) |473| `2` | День месяца (начиная с 1) |474| `3` | Часы (начиная с 0) |475| `4` | Минуты (начиная с 0) |476| `5` | Секунды (начиная с 0) |477478> **Примечание**479>480> Формат ZIP-файлов не поддерживает метки времени до 1980 года.481482#### `ZipInfo.compress_type`483484Тип сжатия для элемента архива.485486#### `ZipInfo.comment`487488Комментарий для отдельного элемента архива в виде объекта [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).489490#### `ZipInfo.extra`491492Данные поля расширения. [Примечание к приложению PKZIP](https://python-all.ru/3.12/library/zipfile.html) содержит некоторые комментарии о внутренней структуре данных, содержащихся в этом объекте [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes).493494#### `ZipInfo.create_system`495496Система, создавшая ZIP-архив.497498#### `ZipInfo.create_version`499500Версия PKZIP, создавшая ZIP-архив.501502#### `ZipInfo.extract_version`503504Версия PKZIP, необходимая для извлечения архива.505506#### `ZipInfo.reserved`507508Должно быть равно нулю.509510#### `ZipInfo.flag_bits`511512Биты флагов ZIP.513514#### `ZipInfo.volume`515516Номер тома заголовка файла.517518#### `ZipInfo.internal_attr`519520Внутренние атрибуты.521522#### `ZipInfo.external_attr`523524Внешние атрибуты файла.525526#### `ZipInfo.header_offset`527528Смещение в байтах до заголовка файла.529530#### `ZipInfo.CRC`531532CRC-32 несжатого файла.533534#### `ZipInfo.compress_size`535536Размер сжатых данных.537538#### `ZipInfo.file_size`539540Размер несжатого файла.541542## Интерфейс командной строки543544Модуль [`zipfile`](https://python-all.ru/3.12/library/zipfile.html#module-zipfile) предоставляет простой интерфейс командной строки для работы с ZIP-архивами.545546Чтобы создать новый ZIP-архив, укажите его имя после параметра [`-c`](https://python-all.ru/3.12/library/zipfile.html#cmdoption-zipfile-c) и перечислите имена файлов, которые нужно включить:547548```console549$ python -m zipfile -c monty.zip spam.txt eggs.txt550```551552Можно также передать каталог:553554```console555$ python -m zipfile -c monty.zip life-of-brian_1979/556```557558Чтобы извлечь ZIP-архив в указанный каталог, используйте параметр [`-e`](https://python-all.ru/3.12/library/zipfile.html#cmdoption-zipfile-e):559560```console561$ python -m zipfile -e monty.zip target-dir/562```563564Для получения списка файлов в ZIP-архиве используйте параметр [`-l`](https://python-all.ru/3.12/library/zipfile.html#cmdoption-zipfile-l):565566```console567$ python -m zipfile -l monty.zip568```569570### Параметры командной строки571572#### `-l <zipfile>`573574#### `--list <zipfile>`575576Выводит список файлов в ZIP-архиве.577578#### `-c <zipfile> <source1> ... <sourceN>`579580#### `--create <zipfile> <source1> ... <sourceN>`581582Создать zip-файл из исходных файлов.583584#### `-e <zipfile> <output_dir>`585586#### `--extract <zipfile> <output_dir>`587588Извлечь zip-файл в целевой каталог.589590#### `-t <zipfile>`591592#### `--test <zipfile>`593594Проверить, корректен ли zip-файл.595596#### `--metadata-encoding <encoding>`597598Указать кодировку имён элементов для [`-l`](https://python-all.ru/3.12/library/zipfile.html#cmdoption-zipfile-l), [`-e`](https://python-all.ru/3.12/library/zipfile.html#cmdoption-zipfile-e) и [`-t`](https://python-all.ru/3.12/library/zipfile.html#cmdoption-zipfile-t).599600Добавлено в версии 3.12.601602## Подводные камни распаковки603604Извлечение в модуле zipfile может завершиться неудачей из-за некоторых подводных камней, перечисленных ниже.605606### Проблемы, связанные с файлом607608Распаковка может не удаться из-за неверного пароля, несовпадения контрольной суммы CRC, неверного формата ZIP, неподдерживаемого метода сжатия или шифрования.609610### Ограничения файловой системы611612Превышение ограничений разных файловых систем может привести к сбою распаковки. Например, допустимые символы в записях каталогов, длина имени файла, длина полного пути, размер отдельного файла, количество файлов и т.д.613614### Ограничения ресурсов615616Нехватка памяти или дискового пространства может привести к сбою распаковки. Например, бомбы распаковки (также известные как [ZIP-бомбы](https://python-all.ru/3.12/library/zipfile.html)) применимы к библиотеке zipfile и могут вызвать исчерпание дискового пространства.617618### Прерывание619620Прерывание в процессе распаковки, например нажатие Control-C или завершение процесса распаковки, может привести к неполной распаковке архива.621622### Действия по умолчанию при извлечении623624Незнание действий по умолчанию при извлечении может привести к неожиданным результатам распаковки. Например, при повторном извлечении одного и того же архива файлы перезаписываются без запроса.625