zlib.md

1> **Источник:** https://python-all.ru/3.10/library/zlib.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`zlib`](https://python-all.ru/3.10/library/zlib.html#module-zlib) – сжатие, совместимое с **gzip**89---1011Для приложений, которым требуется сжатие данных, функции этого модуля позволяют выполнять сжатие и распаковку с помощью библиотеки zlib. Домашняя страница библиотеки zlib находится по адресу [https://www.zlib.net](https://python-all.ru/3.10/library/zlib.html). Известны несовместимости между модулем Python и версиями библиотеки zlib старше 1.1.3; версия 1.1.3 содержит [уязвимость в безопасности](https://python-all.ru/3.10/library/zlib.html), поэтому рекомендуется использовать 1.1.4 или новее.1213Функции zlib имеют множество опций и зачастую должны вызываться в определённом порядке. Данная документация не пытается охватить все комбинации; за авторитетной информацией обращайтесь к руководству zlib по адресу [http://www.zlib.net/manual.html](https://python-all.ru/3.10/library/zlib.html).1415Для чтения и записи файлов `.gz` обратитесь к модулю [`gzip`](https://python-all.ru/3.10/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: Результат всегда беззнаковый. Чтобы получить то же числовое значение при использовании Python 2 или более старых версий, используйте `adler32(data) & 0xffffffff`.2829#### `zlib.compress(data, /, level=- 1)`3031Сжимает байты из *данных* и возвращает объект bytes, содержащий сжатые данные. *level* – целое число от `0` до `9` или `-1`, управляющее степенью сжатия; `1` (Z\_BEST\_SPEED) обеспечивает максимальную скорость и наименьшее сжатие, `9` (Z\_BEST\_COMPRESSION) – наименьшую скорость и наибольшее сжатие. `0` (Z\_NO\_COMPRESSION) – сжатие отсутствует. Значение по умолчанию – `-1` (Z\_DEFAULT\_COMPRESSION). Z\_DEFAULT\_COMPRESSION представляет собой компромисс между скоростью и сжатием (в настоящее время эквивалентен уровню 6). Возбуждает исключение [`error`](https://python-all.ru/3.10/library/zlib.html#zlib.error) при возникновении любой ошибки.3233Изменено в версии 3.6: *level* теперь можно использовать как именованный параметр.3435#### `zlib.compressobj(level=-1, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict])`3637Возвращает объект сжатия, который используется для сжатия потоков данных, не помещающихся в память целиком.3839*level* – степень сжатия – целое число от `0` до `9` или `-1`. Значение `1` (Z\_BEST\_SPEED) даёт максимальную скорость и минимальное сжатие, а значение `9` (Z\_BEST\_COMPRESSION) – максимальное сжатие при минимальной скорости. `0` (Z\_NO\_COMPRESSION) – без сжатия. Значение по умолчанию – `-1` (Z\_DEFAULT\_COMPRESSION). Z\_DEFAULT\_COMPRESSION представляет стандартный компромисс между скоростью и сжатием (в настоящее время эквивалентен уровню 6).4041*method* – алгоритм сжатия. В настоящее время поддерживается только значение `DEFLATED`.4243Аргумент *wbits* управляет размером буфера истории (или «размером окна»), используемого при сжатии данных, а также определяет, включать ли заголовок и концевик в выходные данные. Он может принимать несколько диапазонов значений; по умолчанию `15` (MAX\_WBITS):4445- +9 … +15: двоичный логарифм размера окна, который соответственно находится в диапазоне от 512 до 32768. Большие значения дают лучшее сжатие за счёт большего расхода памяти. Полученный выходной поток будет включать заголовок и концевик, специфичные для zlib.46- −9 … −15: использует абсолютное значение *wbits* как логарифм размера окна, при этом создаётся необработанный выходной поток без заголовка и концевой контрольной суммы.47- +25 … +31 = 16 + (9 … 15): использует младшие 4 бита значения как логарифм размера окна, при этом в выходные данные включается простой заголовок **gzip** и концевая контрольная сумма.4849Аргумент *memLevel* управляет объёмом памяти, используемой для внутреннего состояния сжатия. Допустимые значения – от `1` до `9`. Большие значения используют больше памяти, но работают быстрее и дают меньший выходной поток.5051*strategy* используется для настройки алгоритма сжатия. Возможные значения: `Z_DEFAULT_STRATEGY`, `Z_FILTERED`, `Z_HUFFMAN_ONLY`, `Z_RLE` (zlib 1.2.0.1) и `Z_FIXED` (zlib 1.2.2.2).5253*zdict* – предопределённый словарь сжатия. Это последовательность байтов (например, объект [`bytes`](https://python-all.ru/3.10/library/stdtypes.html#bytes)), содержащая подпоследовательности, которые, как ожидается, часто встречаются в сжимаемых данных. Подпоследовательности, которые, как ожидается, встречаются чаще всего, должны располагаться в конце словаря.5455Изменено в версии 3.3: Добавлен параметр *zdict* и поддержка именованных аргументов.5657#### `zlib.crc32(data[, value])`5859Вычисляет контрольную сумму CRC (Cyclic Redundancy Check) для *data*. Результат – 32-битное целое число без знака. Если указан *value*, он используется как начальное значение контрольной суммы; в противном случае используется значение 0 по умолчанию. Передача *value* позволяет вычислять накопленную контрольную сумму для объединения нескольких входных данных. Алгоритм не является криптостойким и не должен использоваться для аутентификации или цифровых подписей. Поскольку алгоритм разработан для использования в качестве алгоритма контрольной суммы, он не подходит для использования в качестве общего алгоритма хеширования.6061Изменено в версии 3.0: Результат всегда беззнаковый. Чтобы получить то же числовое значение при использовании Python 2 или более старых версий, используйте `crc32(data) & 0xffffffff`.6263#### `zlib.decompress(data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)`6465Распаковывает байты в *data* и возвращает объект bytes, содержащий несжатые данные. Параметр *wbits* зависит от формата *data*; подробнее это обсуждается ниже. Если указан *bufsize*, он используется как начальный размер выходного буфера. Возбуждает исключение [`error`](https://python-all.ru/3.10/library/zlib.html#zlib.error) в случае возникновения ошибки.6667Параметр *wbits* управляет размером буфера истории (или «размером окна»), а также тем, какой формат заголовка и трейлера ожидается. Он аналогичен параметру для [`compressobj()`](https://python-all.ru/3.10/library/zlib.html#zlib.compressobj), но принимает больше диапазонов значений:6869- +8 … +15: двоичный логарифм размера окна. Входные данные должны содержать заголовок и трейлер zlib.70- 0: автоматически определять размер окна из заголовка zlib. Поддерживается только начиная с zlib 1.2.3.5.71- −8 … −15: использует абсолютное значение *wbits* как логарифм размера окна. Входные данные должны быть сырым потоком без заголовка или трейлера.72- +24 … +31 = 16 + (8 … 15): использует младшие 4 бита значения как логарифм размера окна. Входные данные должны содержать заголовок и трейлер gzip.73- +40 … +47 = 32 + (8 … 15): использует младшие 4 бита значения как логарифм размера окна и автоматически принимает как формат zlib, так и gzip.7475При распаковке потока размер окна не должен быть меньше размера, изначально использованного для сжатия потока; слишком маленькое значение может привести к исключению [`error`](https://python-all.ru/3.10/library/zlib.html#zlib.error). Значение *wbits* по умолчанию соответствует наибольшему размеру окна и требует включения заголовка и трейлера zlib.7677*bufsize* – это начальный размер буфера для хранения распакованных данных. Если требуется больше места, размер буфера будет увеличен по мере необходимости, так что необязательно подбирать это значение точно; его настройка лишь позволит сэкономить несколько вызовов `malloc()`.7879Изменено в версии 3.6: *wbits* и *bufsize* можно использовать как именованные аргументы.8081#### `zlib.decompressobj(wbits=MAX_WBITS[, zdict])`8283Возвращает объект распаковки, предназначенный для распаковки потоков данных, которые не помещаются в память целиком.8485Параметр *wbits* управляет размером буфера истории (или «размером окна») и тем, какой формат заголовка и трейлера ожидается. Он имеет то же значение, что и [описанный для decompress()](https://python-all.ru/3.10/library/zlib.html#decompress-wbits).8687Параметр *zdict* задаёт предопределённый словарь сжатия. Если он указан, это должен быть тот же словарь, который использовался компрессором, создавшим подлежащие распаковке данные.8889> **Примечание**90>91> Если *zdict* является изменяемым объектом (например, [`bytearray`](https://python-all.ru/3.10/library/stdtypes.html#bytearray)), его содержимое нельзя изменять между вызовом [`decompressobj()`](https://python-all.ru/3.10/library/zlib.html#zlib.decompressobj) и первым вызовом метода `decompress()` распаковщика.9293Изменено в версии 3.3: Добавлен параметр *zdict*.9495Объекты сжатия поддерживают следующие методы:9697#### `Compress.compress(data)`9899Сжимает *data*, возвращая объект bytes, содержащий сжатые данные, по крайней мере для части данных из *data*. Эти данные следует добавить к выводу, полученному от любых предыдущих вызовов метода [`compress()`](https://python-all.ru/3.10/library/zlib.html#zlib.compress). Некоторые входные данные могут быть сохранены во внутренних буферах для последующей обработки.100101#### `Compress.flush([mode])`102103Обрабатываются все ожидающие входные данные, и возвращается объект bytes, содержащий оставшийся сжатый вывод. *mode* может быть выбран из констант `Z_NO_FLUSH`, `Z_PARTIAL_FLUSH`, `Z_SYNC_FLUSH`, `Z_FULL_FLUSH`, `Z_BLOCK` (zlib 1.2.3.4) или `Z_FINISH`; по умолчанию `Z_FINISH`. За исключением `Z_FINISH`, все константы позволяют продолжать сжатие следующих строк байтов, тогда как `Z_FINISH` завершает сжатый поток и предотвращает дальнейшее сжатие. После вызова [`flush()`](https://python-all.ru/3.10/library/zlib.html#zlib.Compress.flush) с *mode*, установленным в `Z_FINISH`, метод [`compress()`](https://python-all.ru/3.10/library/zlib.html#zlib.compress) больше не может быть вызван; единственное разумное действие – удалить объект.104105#### `Compress.copy()`106107Возвращает копию объекта сжатия. Это может быть использовано для эффективного сжатия набора данных, имеющих общий начальный префикс.108109Изменено в версии 3.8: Добавлена поддержка [`copy.copy()`](https://python-all.ru/3.10/library/copy.html#copy.copy) и [`copy.deepcopy()`](https://python-all.ru/3.10/library/copy.html#copy.deepcopy) для объектов сжатия.110111Объекты распаковки поддерживают следующие методы и атрибуты:112113#### `Decompress.unused_data`114115Объект bytes, содержащий любые байты после конца сжатых данных. То есть он остаётся `b""` до тех пор, пока не станет доступен последний байт, содержащий сжатые данные. Если вся строка байт оказалась состоящей из сжатых данных, это `b""`, пустой объект bytes.116117#### `Decompress.unconsumed_tail`118119Объект bytes, содержащий любые данные, которые не были потреблены последним вызовом [`decompress()`](https://python-all.ru/3.10/library/zlib.html#zlib.decompress), так как они превысили лимит буфера распакованных данных. Эти данные ещё не были обработаны механизмом zlib, поэтому их необходимо снова передать (возможно, с добавлением дополнительных данных) в последующий вызов метода [`decompress()`](https://python-all.ru/3.10/library/zlib.html#zlib.decompress), чтобы получить правильный вывод.120121#### `Decompress.eof`122123Логическое значение, указывающее, достигнут ли конец сжатого потока данных.124125Это позволяет различать правильно сформированный сжатый поток и неполный или усечённый.126127Новое в версии 3.3.128129#### `Decompress.decompress(data, max_length=0)`130131Распаковывает *data*, возвращая bytes-объект с распакованными данными, соответствующими по меньшей мере части данных из *string*. Эти данные следует добавить к результату, полученному от предыдущих вызовов метода [`decompress()`](https://python-all.ru/3.10/library/zlib.html#zlib.decompress). Некоторые входные данные могут сохраняться во внутренних буферах для последующей обработки.132133Если необязательный параметр *max\_length* не равен нулю, возвращаемое значение будет не длиннее *max\_length*. Это может означать, что не все сжатые входные данные удалось обработать; необработанные данные сохраняются в атрибуте [`unconsumed_tail`](https://python-all.ru/3.10/library/zlib.html#zlib.Decompress.unconsumed_tail). Эту байтовую строку необходимо передать в последующий вызов [`decompress()`](https://python-all.ru/3.10/library/zlib.html#zlib.decompress), чтобы продолжить распаковку. Если *max\_length* равен нулю, то все входные данные распаковываются, а [`unconsumed_tail`](https://python-all.ru/3.10/library/zlib.html#zlib.Decompress.unconsumed_tail) остаётся пустой.134135Изменено в версии 3.6: *max\_length* можно использовать как именованный аргумент.136137#### `Decompress.flush([length])`138139Все ожидающие обработки входные данные обрабатываются, и возвращается bytes-объект, содержащий оставшиеся распакованные выходные данные. После вызова [`flush()`](https://python-all.ru/3.10/library/zlib.html#zlib.Decompress.flush) метод [`decompress()`](https://python-all.ru/3.10/library/zlib.html#zlib.decompress) больше нельзя вызывать; единственное разумное действие – удалить объект.140141Необязательный параметр *length* задаёт начальный размер выходного буфера.142143#### `Decompress.copy()`144145Возвращает копию объекта распаковки. Это можно использовать для сохранения состояния распаковщика на середине потока данных, чтобы ускорить произвольный доступ к потоку в будущем.146147Изменено в версии 3.8: Добавлена поддержка [`copy.copy()`](https://python-all.ru/3.10/library/copy.html#copy.copy) и [`copy.deepcopy()`](https://python-all.ru/3.10/library/copy.html#copy.deepcopy) для объектов распаковки.148149Информацию о версии используемой библиотеки zlib можно получить через следующие константы:150151#### `zlib.ZLIB_VERSION`152153Строка версии библиотеки zlib, использовавшейся для сборки модуля. Она может отличаться от библиотеки zlib, фактически используемой во время выполнения, которая доступна как [`ZLIB_RUNTIME_VERSION`](https://python-all.ru/3.10/library/zlib.html#zlib.ZLIB_RUNTIME_VERSION).154155#### `zlib.ZLIB_RUNTIME_VERSION`156157Строка версии библиотеки zlib, фактически загруженной интерпретатором.158159Новое в версии 3.3.160161> **См. также**162>163> **Модуль [`gzip`](https://python-all.ru/3.10/library/gzip.html#module-gzip)**164>165> Чтение и запись файлов в формате **gzip**.166>167> **[http://www.zlib.net](https://python-all.ru/3.10/library/zlib.html)**168>169> Домашняя страница библиотеки zlib.170>171> **[http://www.zlib.net/manual.html](https://python-all.ru/3.10/library/zlib.html)**172>173> Руководство zlib объясняет семантику и использование многих функций библиотеки.174