`zlib.md`

284 строк · 28.1 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.13/library/zlib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `zlib` – сжатие, совместимое с **gzip**89---1011Для приложений, которым требуется сжатие данных, функции этого модуля позволяют выполнять сжатие и распаковку с помощью библиотеки zlib. Домашняя страница библиотеки zlib находится по адресу [https://www.zlib.net](https://python-all.ru/3.13/library/zlib.html). Известны несовместимости между модулем Python и версиями библиотеки zlib старше 1.1.3; версия 1.1.3 содержит [уязвимость в безопасности](https://python-all.ru/3.13/library/zlib.html), поэтому рекомендуется использовать 1.1.4 или новее.1213Функции zlib имеют множество параметров и часто требуют определённого порядка вызова. В этой документации нет попытки охватить все комбинации; для получения исчерпывающей информации обращайтесь к [руководству по zlib](https://python-all.ru/3.13/library/zlib.html).1415Для чтения и записи файлов `.gz` обратитесь к модулю [`gzip`](https://python-all.ru/3.13/library/gzip.html#module-gzip).1617Доступные исключение и функции в этом модуле:1819#### `exception zlib.error`2021Исключение, возникающее при ошибках сжатия и распаковки.2223#### `zlib.adler32(data[, value])`2425Вычисляет контрольную сумму Адлера-32 для *data*. (Контрольная сумма Адлера-32 почти так же надёжна, как CRC32, но вычисляется гораздо быстрее.) Результат – 32-битное целое число без знака. Если указан *value*, он используется как начальное значение контрольной суммы; в противном случае используется значение 1 по умолчанию. Передача *value* позволяет вычислять накопленную контрольную сумму для объединения нескольких входных данных. Алгоритм не является криптостойким и не должен использоваться для аутентификации или цифровых подписей. Поскольку алгоритм разработан для использования в качестве алгоритма контрольной суммы, он не подходит для использования в качестве общего алгоритма хеширования.2627Изменено в версии 3.0: Результат всегда беззнаковый.2829#### `zlib.compress(data, /, level=Z_DEFAULT_COMPRESSION, wbits=MAX_WBITS)`3031Сжимает байты в *data* и возвращает объект bytes, содержащий сжатые данные. *level* – целое число от `0` до `9` или `-1`, управляющее степенью сжатия. Подробнее об этих значениях см. [`Z_BEST_SPEED`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_BEST_SPEED) (`1`), [`Z_BEST_COMPRESSION`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_BEST_COMPRESSION) (`9`), [`Z_NO_COMPRESSION`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_NO_COMPRESSION) (`0`) и значение по умолчанию [`Z_DEFAULT_COMPRESSION`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_DEFAULT_COMPRESSION) (`-1`).3233Аргумент *wbits* управляет размером буфера истории (или «размером окна»), используемого при сжатии данных, а также тем, включаются ли заголовок и концевая часть в выходные данные. Он может принимать несколько диапазонов значений, по умолчанию `15` ([`MAX_WBITS`](https://python-all.ru/3.13/library/zlib.html#zlib.MAX_WBITS)):3435- +9 … +15: двоичный логарифм размера окна, который соответственно находится в диапазоне от 512 до 32768. Большие значения дают лучшее сжатие за счёт большего расхода памяти. Полученный выходной поток будет включать заголовок и концевик, специфичные для zlib.36- −9 … −15: использует абсолютное значение *wbits* как логарифм размера окна, при этом создаётся необработанный выходной поток без заголовка и концевой контрольной суммы.37- +25 … +31 = 16 + (9 … 15): использует младшие 4 бита значения как логарифм размера окна, при этом в выходные данные включается простой заголовок **gzip** и концевая контрольная сумма.3839Возбуждает исключение [`error`](https://python-all.ru/3.13/library/zlib.html#zlib.error) в случае возникновения ошибки.4041Изменено в версии 3.6: *level* теперь можно использовать как именованный параметр.4243Изменено в версии 3.11: Параметр *wbits* теперь доступен для установки битов окна и типа сжатия.4445#### `zlib.compressobj(level=Z_DEFAULT_COMPRESSION, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict])`4647Возвращает объект сжатия, который используется для сжатия потоков данных, не помещающихся в память целиком.4849*level* – степень сжатия: целое число от `0` до `9` или `-1`. Подробнее об этих значениях см. [`Z_BEST_SPEED`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_BEST_SPEED) (`1`), [`Z_BEST_COMPRESSION`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_BEST_COMPRESSION) (`9`), [`Z_NO_COMPRESSION`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_NO_COMPRESSION) (`0`) и значение по умолчанию [`Z_DEFAULT_COMPRESSION`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_DEFAULT_COMPRESSION) (`-1`).5051*method* – алгоритм сжатия. В настоящее время поддерживается только значение [`DEFLATED`](https://python-all.ru/3.13/library/zlib.html#zlib.DEFLATED).5253Параметр *wbits* управляет размером буфера истории (или «размером окна») и тем, какой формат заголовка и концевика будет использоваться. Его смысл такой же, как [описано для compress()](https://python-all.ru/3.13/library/zlib.html#compress-wbits).5455Аргумент *memLevel* управляет объёмом памяти, используемой для внутреннего состояния сжатия. Допустимые значения – от `1` до `9`. Большие значения используют больше памяти, но работают быстрее и дают меньший выходной поток.5657*strategy* используется для настройки алгоритма сжатия. Возможные значения: [`Z_DEFAULT_STRATEGY`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_DEFAULT_STRATEGY), [`Z_FILTERED`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_FILTERED), [`Z_HUFFMAN_ONLY`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_HUFFMAN_ONLY), [`Z_RLE`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_RLE) и [`Z_FIXED`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_FIXED).5859*zdict* – предопределённый словарь сжатия. Это последовательность байтов (например, объект [`bytes`](https://python-all.ru/3.13/library/stdtypes.html#bytes)), содержащая подпоследовательности, которые, как ожидается, часто встречаются в сжимаемых данных. Подпоследовательности, которые, как ожидается, встречаются чаще всего, должны располагаться в конце словаря.6061Изменено в версии 3.3: Добавлен параметр *zdict* и поддержка именованных аргументов.6263#### `zlib.crc32(data[, value])`6465Вычисляет контрольную сумму CRC (Cyclic Redundancy Check) для *data*. Результат – 32-битное целое число без знака. Если указан *value*, он используется как начальное значение контрольной суммы; в противном случае используется значение 0 по умолчанию. Передача *value* позволяет вычислять накопленную контрольную сумму для объединения нескольких входных данных. Алгоритм не является криптостойким и не должен использоваться для аутентификации или цифровых подписей. Поскольку алгоритм разработан для использования в качестве алгоритма контрольной суммы, он не подходит для использования в качестве общего алгоритма хеширования.6667Изменено в версии 3.0: Результат всегда беззнаковый.6869#### `zlib.decompress(data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)`7071Распаковывает байты в *data* и возвращает объект bytes, содержащий несжатые данные. Параметр *wbits* зависит от формата *data*; подробнее это обсуждается ниже. Если указан *bufsize*, он используется как начальный размер выходного буфера. Возбуждает исключение [`error`](https://python-all.ru/3.13/library/zlib.html#zlib.error) в случае возникновения ошибки.7273Параметр *wbits* управляет размером буфера истории (или «размером окна»), а также тем, какой формат заголовка и трейлера ожидается. Он аналогичен параметру для [`compressobj()`](https://python-all.ru/3.13/library/zlib.html#zlib.compressobj), но принимает больше диапазонов значений:7475- +8 … +15: двоичный логарифм размера окна. Входные данные должны содержать заголовок и трейлер zlib.76- 0: автоматически определять размер окна из заголовка zlib. Поддерживается только начиная с zlib 1.2.3.5.77- −8 … −15: использует абсолютное значение *wbits* как логарифм размера окна. Входные данные должны быть сырым потоком без заголовка или трейлера.78- +24 … +31 = 16 + (8 … 15): использует младшие 4 бита значения как логарифм размера окна. Входные данные должны содержать заголовок и трейлер gzip.79- +40 … +47 = 32 + (8 … 15): использует младшие 4 бита значения как логарифм размера окна и автоматически принимает как формат zlib, так и gzip.8081При распаковке потока размер окна не должен быть меньше размера, изначально использованного для сжатия потока; слишком маленькое значение может привести к исключению [`error`](https://python-all.ru/3.13/library/zlib.html#zlib.error). Значение *wbits* по умолчанию соответствует наибольшему размеру окна и требует включения заголовка и трейлера zlib.8283*bufsize* – это начальный размер буфера для хранения распакованных данных. Если требуется больше места, размер буфера будет увеличен по мере необходимости, так что необязательно подбирать это значение точно; его настройка лишь позволит сэкономить несколько вызовов `malloc()`.8485Изменено в версии 3.6: *wbits* и *bufsize* можно использовать как именованные аргументы.8687#### `zlib.decompressobj(wbits=MAX_WBITS[, zdict])`8889Возвращает объект распаковки, предназначенный для распаковки потоков данных, которые не помещаются в память целиком.9091Параметр *wbits* управляет размером буфера истории (или «размером окна») и тем, какой формат заголовка и трейлера ожидается. Он имеет то же значение, что и [описанный для decompress()](https://python-all.ru/3.13/library/zlib.html#decompress-wbits).9293Параметр *zdict* задаёт предопределённый словарь сжатия. Если он указан, это должен быть тот же словарь, который использовался компрессором, создавшим подлежащие распаковке данные.9495> **Примечание**96>97> Если *zdict* является изменяемым объектом (например, [`bytearray`](https://python-all.ru/3.13/library/stdtypes.html#bytearray)), его содержимое нельзя изменять между вызовом `decompressobj()` и первым вызовом метода `decompress()` распаковщика.9899Изменено в версии 3.3: Добавлен параметр *zdict*.100101Объекты сжатия поддерживают следующие методы:102103#### `Compress.compress(data)`104105Сжимает *data*, возвращая объект bytes, содержащий сжатые данные, по крайней мере для части данных из *data*. Эти данные следует добавить к выводу, полученному от любых предыдущих вызовов метода `compress()`. Некоторые входные данные могут быть сохранены во внутренних буферах для последующей обработки.106107#### `Compress.flush([mode])`108109Все ожидающие входные данные обрабатываются, и возвращается объект bytes, содержащий оставшийся сжатый вывод. *mode* может быть выбран из констант [`Z_NO_FLUSH`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_NO_FLUSH), [`Z_PARTIAL_FLUSH`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_PARTIAL_FLUSH), [`Z_SYNC_FLUSH`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_SYNC_FLUSH), [`Z_FULL_FLUSH`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_FULL_FLUSH), [`Z_BLOCK`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_BLOCK) или [`Z_FINISH`](https://python-all.ru/3.13/library/zlib.html#zlib.Z_FINISH), по умолчанию `Z_FINISH`. За исключением `Z_FINISH`, все константы позволяют сжимать дальнейшие строки байт, в то время как `Z_FINISH` завершает сжатый поток и предотвращает сжатие дальнейших данных. После вызова `flush()` с *mode*, установленным в `Z_FINISH`, метод [`compress()`](https://python-all.ru/3.13/library/zlib.html#zlib.compress) больше нельзя вызывать; единственное разумное действие – удалить объект.110111#### `Compress.copy()`112113Возвращает копию объекта сжатия. Это может быть использовано для эффективного сжатия набора данных, имеющих общий начальный префикс.114115Изменено в версии 3.8: Добавлена поддержка [`copy.copy()`](https://python-all.ru/3.13/library/copy.html#copy.copy) и [`copy.deepcopy()`](https://python-all.ru/3.13/library/copy.html#copy.deepcopy) для объектов сжатия.116117Объекты распаковки поддерживают следующие методы и атрибуты:118119#### `Decompress.unused_data`120121Объект bytes, содержащий любые байты после конца сжатых данных. То есть он остаётся `b""` до тех пор, пока не станет доступен последний байт, содержащий сжатые данные. Если вся строка байт оказалась состоящей из сжатых данных, это `b""`, пустой объект bytes.122123#### `Decompress.unconsumed_tail`124125Объект bytes, содержащий любые данные, которые не были потреблены последним вызовом [`decompress()`](https://python-all.ru/3.13/library/zlib.html#zlib.decompress), так как они превысили лимит буфера распакованных данных. Эти данные ещё не были обработаны механизмом zlib, поэтому их необходимо снова передать (возможно, с добавлением дополнительных данных) в последующий вызов метода `decompress()`, чтобы получить правильный вывод.126127#### `Decompress.eof`128129Логическое значение, указывающее, достигнут ли конец сжатого потока данных.130131Это позволяет различать правильно сформированный сжатый поток и неполный или усечённый.132133Добавлено в версии 3.3.134135#### `Decompress.decompress(data, max_length=0)`136137Распаковывает *data*, возвращая bytes-объект с распакованными данными, соответствующими по меньшей мере части данных из *string*. Эти данные следует добавить к результату, полученному от предыдущих вызовов метода `decompress()`. Некоторые входные данные могут сохраняться во внутренних буферах для последующей обработки.138139Если необязательный параметр *max\_length* не равен нулю, возвращаемое значение будет не длиннее *max\_length*. Это может означать, что не все сжатые входные данные удалось обработать; необработанные данные сохраняются в атрибуте [`unconsumed_tail`](https://python-all.ru/3.13/library/zlib.html#zlib.Decompress.unconsumed_tail). Эту байтовую строку необходимо передать в последующий вызов `decompress()`, чтобы продолжить распаковку. Если *max\_length* равен нулю, то все входные данные распаковываются, а `unconsumed_tail` остаётся пустой.140141Изменено в версии 3.6: *max\_length* можно использовать как именованный аргумент.142143#### `Decompress.flush([length])`144145Все ожидающие обработки входные данные обрабатываются, и возвращается bytes-объект, содержащий оставшиеся распакованные выходные данные. После вызова `flush()` метод [`decompress()`](https://python-all.ru/3.13/library/zlib.html#zlib.decompress) больше нельзя вызывать; единственное разумное действие – удалить объект.146147Необязательный параметр *length* задаёт начальный размер выходного буфера.148149#### `Decompress.copy()`150151Возвращает копию объекта распаковки. Это можно использовать для сохранения состояния распаковщика на середине потока данных, чтобы ускорить произвольный доступ к потоку в будущем.152153Изменено в версии 3.8: Добавлена поддержка [`copy.copy()`](https://python-all.ru/3.13/library/copy.html#copy.copy) и [`copy.deepcopy()`](https://python-all.ru/3.13/library/copy.html#copy.deepcopy) для объектов распаковки.154155Следующие константы доступны для настройки поведения сжатия и распаковки:156157#### `zlib.DEFLATED`158159Метод сжатия deflate.160161#### `zlib.MAX_WBITS`162163Максимальный размер окна, выраженный как степень двойки. Например, если `MAX_WBITS` равен `15`, то размер окна составит `32 KiB`.164165#### `zlib.DEF_MEM_LEVEL`166167Уровень памяти по умолчанию для объектов сжатия.168169#### `zlib.DEF_BUF_SIZE`170171Размер буфера по умолчанию для операций распаковки.172173#### `zlib.Z_NO_COMPRESSION`174175Уровень сжатия `0`; без сжатия.176177Добавлено в версии 3.6.178179#### `zlib.Z_BEST_SPEED`180181Уровень сжатия `1`; самый быстрый, обеспечивает наименьшее сжатие.182183#### `zlib.Z_BEST_COMPRESSION`184185Уровень сжатия `9`; самый медленный, обеспечивает наибольшее сжатие.186187#### `zlib.Z_DEFAULT_COMPRESSION`188189Уровень сжатия по умолчанию (`-1`); компромисс между скоростью и сжатием. В настоящее время эквивалентен уровню сжатия `6`.190191#### `zlib.Z_DEFAULT_STRATEGY`192193Стратегия сжатия по умолчанию для обычных данных.194195#### `zlib.Z_FILTERED`196197Стратегия сжатия для данных, полученных от фильтра (или предсказателя).198199#### `zlib.Z_HUFFMAN_ONLY`200201Стратегия сжатия, использующая только кодирование Хаффмана.202203#### `zlib.Z_RLE`204205Стратегия сжатия, ограничивающая расстояния совпадений до одного (кодирование длин серий).206207Эта константа доступна только если Python был собран с zlib 1.2.0.1 или новее.208209Добавлено в версии 3.6.210211#### `zlib.Z_FIXED`212213Стратегия сжатия, предотвращающая использование динамических кодов Хаффмана.214215Эта константа доступна только если Python был собран с zlib 1.2.2.2 или новее.216217Добавлено в версии 3.6.218219#### `zlib.Z_NO_FLUSH`220221Режим сброса `0`. Особого поведения при сбросе нет.222223Добавлено в версии 3.6.224225#### `zlib.Z_PARTIAL_FLUSH`226227Режим сброса `1`. Сбрасывает как можно больше выходных данных.228229#### `zlib.Z_SYNC_FLUSH`230231Режим сброса `2`. Все выходные данные сбрасываются, и выходные данные выравниваются по границе байта.232233#### `zlib.Z_FULL_FLUSH`234235Режим сброса `3`. Все выходные данные сбрасываются, а состояние сжатия сбрасывается.236237#### `zlib.Z_FINISH`238239Режим сброса `4`. Все отложенные входные данные обрабатываются; новых данных не ожидается.240241#### `zlib.Z_BLOCK`242243Режим сброса `5`. Блок deflate завершается и выводится.244245Эта константа доступна только если Python был собран с zlib 1.2.2.2 или новее.246247Добавлено в версии 3.6.248249#### `zlib.Z_TREES`250251Режим сброса `6` для операций inflate. Указывает inflate вернуться, когда он достигнет границы следующего блока deflate.252253Эта константа доступна только если Python был собран с zlib 1.2.3.4 или новее.254255Добавлено в версии 3.6.256257Информацию о версии используемой библиотеки zlib можно получить через следующие константы:258259#### `zlib.ZLIB_VERSION`260261Строка версии библиотеки zlib, использовавшейся для сборки модуля. Она может отличаться от библиотеки zlib, фактически используемой во время выполнения, которая доступна как [`ZLIB_RUNTIME_VERSION`](https://python-all.ru/3.13/library/zlib.html#zlib.ZLIB_RUNTIME_VERSION).262263#### `zlib.ZLIB_RUNTIME_VERSION`264265Строка версии библиотеки zlib, фактически загруженной интерпретатором.266267Добавлено в версии 3.3.268269> **См. также**270>271> **Модуль [`gzip`](https://python-all.ru/3.13/library/gzip.html#module-gzip)**272>273> Чтение и запись файлов в формате **gzip**.274>275> **[https://www.zlib.net](https://python-all.ru/3.13/library/zlib.html)**276>277> Домашняя страница библиотеки zlib.278>279> **[https://www.zlib.net/manual.html](https://python-all.ru/3.13/library/zlib.html)**280>281> Руководство zlib объясняет семантику и использование многих функций библиотеки.282>283> Если сжатие/распаковка gzip является узким местом, пакет [python-isal](https://python-all.ru/3.13/library/zlib.html) ускоряет сжатие/распаковку с помощью почти совместимого API.284