`zlib.md`

294 строк · 28.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3/library/zlib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# `zlib` – сжатие, совместимое с **gzip**89---1011Для приложений, которым требуется сжатие данных, функции этого модуля позволяют выполнять сжатие и распаковку с помощью [библиотеки zlib](https://python-all.ru/3/library/zlib.html).1213Это [опциональный модуль](https://python-all.ru/3/glossary.html#term-optional-module). Если его нет в вашей копии CPython, обратитесь к документации от вашего дистрибьютора (то есть того, кто предоставил вам Python). Если вы дистрибьютор, обратитесь к [требованиям к опциональным модулям](https://python-all.ru/3/using/configure.html#optional-module-requirements).1415Функции zlib имеют множество параметров и часто требуют определённого порядка вызова. В этой документации нет попытки охватить все комбинации; для получения исчерпывающей информации обращайтесь к [руководству по zlib](https://python-all.ru/3/library/zlib.html).1617Для чтения и записи файлов `.gz` обратитесь к модулю [`gzip`](https://python-all.ru/3/library/gzip.html#module-gzip).1819Доступные исключение и функции в этом модуле:2021#### `exception zlib.error`2223Исключение, возникающее при ошибках сжатия и распаковки.2425#### `zlib.adler32(data[, value])`2627Вычисляет контрольную сумму Адлера-32 для *data*. (Контрольная сумма Адлера-32 почти так же надёжна, как CRC32, но вычисляется гораздо быстрее.) Результат – 32-битное целое число без знака. Если указан *value*, он используется как начальное значение контрольной суммы; в противном случае используется значение 1 по умолчанию. Передача *value* позволяет вычислять накопленную контрольную сумму для объединения нескольких входных данных. Алгоритм не является криптостойким и не должен использоваться для аутентификации или цифровых подписей. Поскольку алгоритм разработан для использования в качестве алгоритма контрольной суммы, он не подходит для использования в качестве общего алгоритма хеширования.2829Изменено в версии 3.0: Результат всегда беззнаковый.3031#### `zlib.compress(data, /, level=Z_DEFAULT_COMPRESSION, wbits=MAX_WBITS)`3233Сжимает байты в *data* и возвращает объект bytes, содержащий сжатые данные. *level* – целое число от `0` до `9` или `-1`, управляющее степенью сжатия. Подробнее об этих значениях см. [`Z_BEST_SPEED`](https://python-all.ru/3/library/zlib.html#zlib.Z_BEST_SPEED) (`1`), [`Z_BEST_COMPRESSION`](https://python-all.ru/3/library/zlib.html#zlib.Z_BEST_COMPRESSION) (`9`), [`Z_NO_COMPRESSION`](https://python-all.ru/3/library/zlib.html#zlib.Z_NO_COMPRESSION) (`0`) и значение по умолчанию [`Z_DEFAULT_COMPRESSION`](https://python-all.ru/3/library/zlib.html#zlib.Z_DEFAULT_COMPRESSION) (`-1`).3435Аргумент *wbits* управляет размером буфера истории (или «размером окна»), используемого при сжатии данных, а также тем, включаются ли заголовок и концевая часть в выходные данные. Он может принимать несколько диапазонов значений, по умолчанию `15` ([`MAX_WBITS`](https://python-all.ru/3/library/zlib.html#zlib.MAX_WBITS)):3637- +9 … +15: двоичный логарифм размера окна, который соответственно находится в диапазоне от 512 до 32768. Большие значения дают лучшее сжатие за счёт большего расхода памяти. Полученный выходной поток будет включать заголовок и концевик, специфичные для zlib.38- −9 … −15: использует абсолютное значение *wbits* как логарифм размера окна, при этом создаётся необработанный выходной поток без заголовка и концевой контрольной суммы.39- +25 … +31 = 16 + (9 … 15): использует младшие 4 бита значения как логарифм размера окна, при этом в выходные данные включается простой заголовок **gzip** и концевая контрольная сумма.4041Возбуждает исключение [`error`](https://python-all.ru/3/library/zlib.html#zlib.error) в случае возникновения ошибки.4243Изменено в версии 3.6: *level* теперь можно использовать как именованный параметр.4445Изменено в версии 3.11: Параметр *wbits* теперь доступен для установки битов окна и типа сжатия.4647#### `zlib.compressobj(level=Z_DEFAULT_COMPRESSION, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict])`4849Возвращает объект сжатия, который используется для сжатия потоков данных, не помещающихся в память целиком.5051*level* – степень сжатия: целое число от `0` до `9` или `-1`. Подробнее об этих значениях см. [`Z_BEST_SPEED`](https://python-all.ru/3/library/zlib.html#zlib.Z_BEST_SPEED) (`1`), [`Z_BEST_COMPRESSION`](https://python-all.ru/3/library/zlib.html#zlib.Z_BEST_COMPRESSION) (`9`), [`Z_NO_COMPRESSION`](https://python-all.ru/3/library/zlib.html#zlib.Z_NO_COMPRESSION) (`0`) и значение по умолчанию [`Z_DEFAULT_COMPRESSION`](https://python-all.ru/3/library/zlib.html#zlib.Z_DEFAULT_COMPRESSION) (`-1`).5253*method* – алгоритм сжатия. В настоящее время поддерживается только значение [`DEFLATED`](https://python-all.ru/3/library/zlib.html#zlib.DEFLATED).5455Параметр *wbits* управляет размером буфера истории (или «размером окна») и тем, какой формат заголовка и концевика будет использоваться. Его смысл такой же, как [описано для compress()](https://python-all.ru/3/library/zlib.html#compress-wbits).5657Аргумент *memLevel* управляет объёмом памяти, используемой для внутреннего состояния сжатия. Допустимые значения – от `1` до `9`. Большие значения используют больше памяти, но работают быстрее и дают меньший выходной поток.5859*strategy* используется для настройки алгоритма сжатия. Возможные значения: [`Z_DEFAULT_STRATEGY`](https://python-all.ru/3/library/zlib.html#zlib.Z_DEFAULT_STRATEGY), [`Z_FILTERED`](https://python-all.ru/3/library/zlib.html#zlib.Z_FILTERED), [`Z_HUFFMAN_ONLY`](https://python-all.ru/3/library/zlib.html#zlib.Z_HUFFMAN_ONLY), [`Z_RLE`](https://python-all.ru/3/library/zlib.html#zlib.Z_RLE) и [`Z_FIXED`](https://python-all.ru/3/library/zlib.html#zlib.Z_FIXED).6061*zdict* – предопределённый словарь сжатия. Это последовательность байтов (например, объект [`bytes`](https://python-all.ru/3/library/stdtypes.html#bytes)), содержащая подпоследовательности, которые, как ожидается, часто встречаются в сжимаемых данных. Подпоследовательности, которые, как ожидается, встречаются чаще всего, должны располагаться в конце словаря.6263Изменено в версии 3.3: Добавлен параметр *zdict* и поддержка именованных аргументов.6465#### `zlib.crc32(data[, value])`6667Вычисляет контрольную сумму CRC (Cyclic Redundancy Check) для *data*. Результат – 32-битное целое число без знака. Если указан *value*, он используется как начальное значение контрольной суммы; в противном случае используется значение 0 по умолчанию. Передача *value* позволяет вычислять накопленную контрольную сумму для объединения нескольких входных данных. Алгоритм не является криптостойким и не должен использоваться для аутентификации или цифровых подписей. Поскольку алгоритм разработан для использования в качестве алгоритма контрольной суммы, он не подходит для использования в качестве общего алгоритма хеширования.6869Изменено в версии 3.0: Результат всегда беззнаковый.7071#### `zlib.decompress(data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)`7273Распаковывает байты в *data* и возвращает объект bytes, содержащий несжатые данные. Параметр *wbits* зависит от формата *data*; подробнее это обсуждается ниже. Если указан *bufsize*, он используется как начальный размер выходного буфера. Возбуждает исключение [`error`](https://python-all.ru/3/library/zlib.html#zlib.error) в случае возникновения ошибки.7475Параметр *wbits* управляет размером буфера истории (или «размером окна»), а также тем, какой формат заголовка и трейлера ожидается. Он аналогичен параметру для [`compressobj()`](https://python-all.ru/3/library/zlib.html#zlib.compressobj), но принимает больше диапазонов значений:7677- +8 … +15: двоичный логарифм размера окна. Входные данные должны содержать заголовок и трейлер zlib.78- 0: автоматически определять размер окна из заголовка zlib. Поддерживается только начиная с zlib 1.2.3.5.79- −8 … −15: использует абсолютное значение *wbits* как логарифм размера окна. Входные данные должны быть сырым потоком без заголовка или трейлера.80- +24 … +31 = 16 + (8 … 15): использует младшие 4 бита значения как логарифм размера окна. Входные данные должны содержать заголовок и трейлер gzip.81- +40 … +47 = 32 + (8 … 15): использует младшие 4 бита значения как логарифм размера окна и автоматически принимает как формат zlib, так и gzip.8283При распаковке потока размер окна не должен быть меньше размера, изначально использованного для сжатия потока; слишком маленькое значение может привести к исключению [`error`](https://python-all.ru/3/library/zlib.html#zlib.error). Значение *wbits* по умолчанию соответствует наибольшему размеру окна и требует включения заголовка и трейлера zlib.8485*bufsize* – это начальный размер буфера для хранения распакованных данных. Если требуется больше места, размер буфера будет увеличен по мере необходимости, так что необязательно подбирать это значение точно; его настройка лишь позволит сэкономить несколько вызовов `malloc()`.8687Изменено в версии 3.6: *wbits* и *bufsize* можно использовать как именованные аргументы.8889#### `zlib.decompressobj(wbits=MAX_WBITS[, zdict])`9091Возвращает объект распаковки, предназначенный для распаковки потоков данных, которые не помещаются в память целиком.9293Параметр *wbits* управляет размером буфера истории (или «размером окна») и тем, какой формат заголовка и трейлера ожидается. Он имеет то же значение, что и [описанный для decompress()](https://python-all.ru/3/library/zlib.html#decompress-wbits).9495Параметр *zdict* задаёт предопределённый словарь сжатия. Если он указан, это должен быть тот же словарь, который использовался компрессором, создавшим подлежащие распаковке данные.9697> **Примечание**98>99> Если *zdict* является изменяемым объектом (например, [`bytearray`](https://python-all.ru/3/library/stdtypes.html#bytearray)), его содержимое нельзя изменять между вызовом `decompressobj()` и первым вызовом метода `decompress()` распаковщика.100101Изменено в версии 3.3: Добавлен параметр *zdict*.102103Объекты сжатия поддерживают следующие методы:104105#### `Compress.compress(data)`106107Сжимает *data*, возвращая объект bytes, содержащий сжатые данные, по крайней мере для части данных из *data*. Эти данные следует добавить к выводу, полученному от любых предыдущих вызовов метода `compress()`. Некоторые входные данные могут быть сохранены во внутренних буферах для последующей обработки.108109#### `Compress.flush([mode])`110111Все ожидающие входные данные обрабатываются, и возвращается объект bytes, содержащий оставшийся сжатый вывод. *mode* может быть выбран из констант [`Z_NO_FLUSH`](https://python-all.ru/3/library/zlib.html#zlib.Z_NO_FLUSH), [`Z_PARTIAL_FLUSH`](https://python-all.ru/3/library/zlib.html#zlib.Z_PARTIAL_FLUSH), [`Z_SYNC_FLUSH`](https://python-all.ru/3/library/zlib.html#zlib.Z_SYNC_FLUSH), [`Z_FULL_FLUSH`](https://python-all.ru/3/library/zlib.html#zlib.Z_FULL_FLUSH), [`Z_BLOCK`](https://python-all.ru/3/library/zlib.html#zlib.Z_BLOCK) или [`Z_FINISH`](https://python-all.ru/3/library/zlib.html#zlib.Z_FINISH), по умолчанию `Z_FINISH`. За исключением `Z_FINISH`, все константы позволяют сжимать дальнейшие строки байт, в то время как `Z_FINISH` завершает сжатый поток и предотвращает сжатие дальнейших данных. После вызова `flush()` с *mode*, установленным в `Z_FINISH`, метод [`compress()`](https://python-all.ru/3/library/zlib.html#zlib.compress) больше нельзя вызывать; единственное разумное действие – удалить объект.112113#### `Compress.copy()`114115Возвращает копию объекта сжатия. Это может быть использовано для эффективного сжатия набора данных, имеющих общий начальный префикс.116117Изменено в версии 3.8: Добавлена поддержка [`copy.copy()`](https://python-all.ru/3/library/copy.html#copy.copy) и [`copy.deepcopy()`](https://python-all.ru/3/library/copy.html#copy.deepcopy) для объектов сжатия.118119Объекты распаковки поддерживают следующие методы и атрибуты:120121#### `Decompress.unused_data`122123Объект bytes, содержащий любые байты после конца сжатых данных. То есть он остаётся `b""` до тех пор, пока не станет доступен последний байт, содержащий сжатые данные. Если вся строка байт оказалась состоящей из сжатых данных, это `b""`, пустой объект bytes.124125#### `Decompress.unconsumed_tail`126127Объект bytes, содержащий любые данные, которые не были потреблены последним вызовом [`decompress()`](https://python-all.ru/3/library/zlib.html#zlib.decompress), так как они превысили лимит буфера распакованных данных. Эти данные ещё не были обработаны механизмом zlib, поэтому их необходимо снова передать (возможно, с добавлением дополнительных данных) в последующий вызов метода `decompress()`, чтобы получить правильный вывод.128129#### `Decompress.eof`130131Логическое значение, указывающее, достигнут ли конец сжатого потока данных.132133Это позволяет различать правильно сформированный сжатый поток и неполный или усечённый.134135Добавлено в версии 3.3.136137#### `Decompress.decompress(data, max_length=0)`138139Распаковывает *data*, возвращая bytes-объект с распакованными данными, соответствующими по меньшей мере части данных из *string*. Эти данные следует добавить к результату, полученному от предыдущих вызовов метода `decompress()`. Некоторые входные данные могут сохраняться во внутренних буферах для последующей обработки.140141Если необязательный параметр *max\_length* не равен нулю, возвращаемое значение будет не длиннее *max\_length*. Это может означать, что не все сжатые входные данные удалось обработать; необработанные данные сохраняются в атрибуте [`unconsumed_tail`](https://python-all.ru/3/library/zlib.html#zlib.Decompress.unconsumed_tail). Эту байтовую строку необходимо передать в последующий вызов `decompress()`, чтобы продолжить распаковку. Если *max\_length* равен нулю, то все входные данные распаковываются, а `unconsumed_tail` остаётся пустой.142143Изменено в версии 3.6: *max\_length* можно использовать как именованный аргумент.144145#### `Decompress.flush([length])`146147Все ожидающие обработки входные данные обрабатываются, и возвращается bytes-объект, содержащий оставшиеся распакованные выходные данные. После вызова `flush()` метод [`decompress()`](https://python-all.ru/3/library/zlib.html#zlib.decompress) больше нельзя вызывать; единственное разумное действие – удалить объект.148149Необязательный параметр *length* задаёт начальный размер выходного буфера.150151#### `Decompress.copy()`152153Возвращает копию объекта распаковки. Это можно использовать для сохранения состояния распаковщика на середине потока данных, чтобы ускорить произвольный доступ к потоку в будущем.154155Изменено в версии 3.8: Добавлена поддержка [`copy.copy()`](https://python-all.ru/3/library/copy.html#copy.copy) и [`copy.deepcopy()`](https://python-all.ru/3/library/copy.html#copy.deepcopy) для объектов распаковки.156157Следующие константы доступны для настройки поведения сжатия и распаковки:158159#### `zlib.DEFLATED`160161Метод сжатия deflate.162163#### `zlib.MAX_WBITS`164165Максимальный размер окна, выраженный как степень двойки. Например, если `MAX_WBITS` равен `15`, то размер окна составит `32 KiB`.166167#### `zlib.DEF_MEM_LEVEL`168169Уровень памяти по умолчанию для объектов сжатия.170171#### `zlib.DEF_BUF_SIZE`172173Размер буфера по умолчанию для операций распаковки.174175#### `zlib.Z_NO_COMPRESSION`176177Уровень сжатия `0`; без сжатия.178179Добавлено в версии 3.6.180181#### `zlib.Z_BEST_SPEED`182183Уровень сжатия `1`; самый быстрый, обеспечивает наименьшее сжатие.184185#### `zlib.Z_BEST_COMPRESSION`186187Уровень сжатия `9`; самый медленный, обеспечивает наибольшее сжатие.188189#### `zlib.Z_DEFAULT_COMPRESSION`190191Уровень сжатия по умолчанию (`-1`); компромисс между скоростью и сжатием. В настоящее время эквивалентен уровню сжатия `6`.192193#### `zlib.Z_DEFAULT_STRATEGY`194195Стратегия сжатия по умолчанию для обычных данных.196197#### `zlib.Z_FILTERED`198199Стратегия сжатия для данных, полученных от фильтра (или предсказателя).200201#### `zlib.Z_HUFFMAN_ONLY`202203Стратегия сжатия, использующая только кодирование Хаффмана.204205#### `zlib.Z_RLE`206207Стратегия сжатия, ограничивающая расстояния совпадений до одного (кодирование длин серий).208209Эта константа доступна только если Python был собран с zlib 1.2.0.1 или новее.210211Добавлено в версии 3.6.212213#### `zlib.Z_FIXED`214215Стратегия сжатия, предотвращающая использование динамических кодов Хаффмана.216217Эта константа доступна только если Python был собран с zlib 1.2.2.2 или новее.218219Добавлено в версии 3.6.220221#### `zlib.Z_NO_FLUSH`222223Режим сброса `0`. Особого поведения при сбросе нет.224225Добавлено в версии 3.6.226227#### `zlib.Z_PARTIAL_FLUSH`228229Режим сброса `1`. Сбрасывает как можно больше выходных данных.230231#### `zlib.Z_SYNC_FLUSH`232233Режим сброса `2`. Все выходные данные сбрасываются, и выходные данные выравниваются по границе байта.234235#### `zlib.Z_FULL_FLUSH`236237Режим сброса `3`. Все выходные данные сбрасываются, а состояние сжатия сбрасывается.238239#### `zlib.Z_FINISH`240241Режим сброса `4`. Все отложенные входные данные обрабатываются; новых данных не ожидается.242243#### `zlib.Z_BLOCK`244245Режим сброса `5`. Блок deflate завершается и выводится.246247Эта константа доступна только если Python был собран с zlib 1.2.2.2 или новее.248249Добавлено в версии 3.6.250251#### `zlib.Z_TREES`252253Режим сброса `6` для операций inflate. Указывает inflate вернуться, когда он достигнет границы следующего блока deflate.254255Эта константа доступна только если Python был собран с zlib 1.2.3.4 или новее.256257Добавлено в версии 3.6.258259Информацию о версии используемой библиотеки zlib можно получить через следующие константы:260261#### `zlib.ZLIB_VERSION`262263Строка версии библиотеки zlib, использовавшейся для сборки модуля. Она может отличаться от библиотеки zlib, фактически используемой во время выполнения, которая доступна как [`ZLIB_RUNTIME_VERSION`](https://python-all.ru/3/library/zlib.html#zlib.ZLIB_RUNTIME_VERSION).264265#### `zlib.ZLIB_RUNTIME_VERSION`266267Строка версии библиотеки zlib, фактически загруженной интерпретатором.268269Добавлено в версии 3.3.270271#### `zlib.ZLIBNG_VERSION`272273Строка версии библиотеки zlib-ng, использовавшейся для сборки модуля, если использовалась zlib-ng. При наличии константы [`ZLIB_VERSION`](https://python-all.ru/3/library/zlib.html#zlib.ZLIB_VERSION) и [`ZLIB_RUNTIME_VERSION`](https://python-all.ru/3/library/zlib.html#zlib.ZLIB_RUNTIME_VERSION) отражают версию API zlib, предоставляемого zlib-ng.274275Если zlib-ng не использовалась для сборки модуля, эта константа будет отсутствовать.276277Добавлено в версии 3.14.278279> **См. также**280>281> **Модуль [`gzip`](https://python-all.ru/3/library/gzip.html#module-gzip)**282>283> Чтение и запись файлов в формате **gzip**.284>285> **[https://www.zlib.net](https://python-all.ru/3/library/zlib.html)**286>287> Домашняя страница библиотеки zlib.288>289> **[https://www.zlib.net/manual.html](https://python-all.ru/3/library/zlib.html)**290>291> Руководство zlib объясняет семантику и использование многих функций библиотеки.292>293> Если сжатие/распаковка gzip является узким местом, пакет [python-isal](https://python-all.ru/3/library/zlib.html) ускоряет сжатие/распаковку с помощью почти совместимого API.294