12.1. zlib – сжатие, совместимое с gzip¶zlib – Compression compatible with gzip

Для приложений, которым требуется сжатие данных, функции этого модуля позволяют выполнять сжатие и распаковку с помощью библиотеки zlib. Библиотека zlib имеет собственную домашнюю страницу по адресу http://www.zlib.net. Существуют известные несовместимости между модулем Python и версиями библиотеки zlib старше 1.1.3; в версии 1.1.3 есть уязвимость безопасности, поэтому рекомендуется использовать версию 1.1.4 или новее.

Функции zlib имеют множество опций и зачастую должны вызываться в определённом порядке. Данная документация не пытается охватить все комбинации; за авторитетной информацией обращайтесь к руководству zlib по адресу http://www.zlib.net/manual.html.

Для чтения и записи файлов .gz см. модуль gzip. Для других форматов архивов см. модули bz2, zipfile и tarfile.

Доступные исключение и функции в этом модуле:

exception zlib.error¶

Исключение, возникающее при ошибках сжатия и распаковки.

zlib.adler32(data[, value])¶

Вычисляет контрольную сумму Адлера-32 для data. (Контрольная сумма Адлера-32 почти так же надёжна, как CRC32, но вычисляется гораздо быстрее.) Если указан value, он используется как начальное значение контрольной суммы; в противном случае используется фиксированное значение по умолчанию. Это позволяет вычислять нарастающую контрольную сумму для объединения нескольких входных данных. Алгоритм не является криптостойким и не должен использоваться для аутентификации или цифровых подписей. Поскольку алгоритм предназначен для использования в качестве контрольной суммы, он не подходит для применения в качестве хеш-функции общего назначения.

Всегда возвращает беззнаковое 32-битное целое число.

zlib.compress(data[, level])¶

Сжимает байты из data и возвращает объект bytes со сжатыми данными. level – целое число от 1 до 9, управляющее степенью сжатия; 1 – самый быстрый и даёт наименьшее сжатие, 9 – самый медленный и даёт наибольшее. Значение по умолчанию – 6. В случае ошибки возникает исключение error.

zlib.compressobj([level])¶

Возвращает объект сжатия, предназначенный для сжатия потоков данных, которые не помещаются в память целиком. level – целое число от 1 до 9, управляющее степенью сжатия; 1 – самый быстрый и даёт наименьшее сжатие, 9 – самый медленный и даёт наибольшее. Значение по умолчанию – 6.

zlib.crc32(data[, value])¶

Вычисляет контрольную сумму CRC (Cyclic Redundancy Check) для data. Если указан value, он используется как начальное значение контрольной суммы; в противном случае используется фиксированное значение по умолчанию. Это позволяет вычислять контрольную сумму на лету для объединения нескольких входных данных. Алгоритм не является криптостойким и не должен использоваться для аутентификации или цифровых подписей. Поскольку алгоритм спроектирован как алгоритм контрольной суммы, он не подходит для использования в качестве универсальной хеш-функции.

Всегда возвращает беззнаковое 32-битное целое число.

zlib.decompress(data[, wbits[, bufsize]])¶

Распаковывает байты из data и возвращает объект bytes с неупакованными данными. Параметр wbits управляет размером буфера окна. Если указан bufsize, он используется как начальный размер выходного буфера. В случае ошибки возникает исключение error.

Абсолютное значение wbits – это двоичный логарифм размера буфера истории («размер окна»), используемого при сжатии данных. Для последних версий библиотеки zlib абсолютное значение должно быть от 8 до 15; большие значения дают лучшее сжатие за счёт большего расхода памяти. Значение по умолчанию – 15. Если wbits отрицательное, стандартный заголовок gzip подавляется.

bufsize – начальный размер буфера для хранения распакованных данных. Если требуется больше места, размер буфера будет увеличен по мере необходимости, так что не обязательно подбирать это значение точно; его настройка лишь сэкономит несколько вызовов malloc(). Размер по умолчанию – 16384.

zlib.decompressobj([wbits])¶

Возвращает объект распаковки, предназначенный для распаковки потоков данных, которые не помещаются в память целиком. Параметр wbits управляет размером окна буфера.

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

Compress.compress(data)¶

Сжимает data и возвращает объект bytes, содержащий сжатые данные для как минимум части данных из data. Эти данные следует добавить к результату, полученному от предыдущих вызовов метода compress(). Некоторые входные данные могут сохраняться во внутренних буферах для последующей обработки.

Compress.flush([mode])¶

Обрабатываются все ожидающие входные данные и возвращается объект bytes, содержащий оставшийся сжатый вывод. mode можно выбрать из констант Z_SYNC_FLUSH, Z_FULL_FLUSH или Z_FINISH, по умолчанию Z_FINISH. Z_SYNC_FLUSH и Z_FULL_FLUSH позволяют продолжать сжатие новых строк байтов, тогда как Z_FINISH завершает сжатый поток и предотвращает дальнейшее сжатие. После вызова flush() с mode, установленным в Z_FINISH, метод compress() больше нельзя вызывать; единственное разумное действие – удалить объект.

Compress.copy()¶

Возвращает копию объекта сжатия. Это может быть использовано для эффективного сжатия набора данных, имеющих общий начальный префикс.

Объекты распаковки поддерживают следующие методы и два атрибута:

Decompress.unused_data¶

Объект байтов, содержащий все байты после конца сжатых данных. То есть остаётся равным "" до тех пор, пока не будет доступен последний байт, содержащий сжатые данные. Если вся строка байтов оказалась сжатыми данными, это будет b"", пустой объект байтов.

Единственный способ определить, где заканчивается строка байтов со сжатыми данными, – это фактически распаковать её. Это означает, что если сжатые данные являются частью более крупного файла, можно найти её конец, только читая данные и подавая их в метод decompress() объекта распаковки, после чего подавать непустую строку байтов, пока атрибут unused_data не перестанет быть пустым.

Decompress.unconsumed_tail¶

Объект bytes, содержащий любые данные, которые не были обработаны последним вызовом decompress(), поскольку они превысили лимит буфера несжатых данных. Эти данные ещё не были обработаны механизмом zlib, поэтому их необходимо передать (возможно, с присоединёнными дополнительными данными) обратно в последующий вызов метода decompress(), чтобы получить корректный вывод.

Decompress.decompress(data[, max_length])¶

Распаковывает data, возвращая объект bytes, содержащий несжатые данные, соответствующие по меньшей мере части данных из string. Эти данные следует добавить к выводу, полученному в результате всех предыдущих вызовов метода decompress(). Часть входных данных может сохраняться во внутренних буферах для последующей обработки.

Если указан необязательный параметр max_length, то возвращаемое значение будет не длиннее max_length. Это может означать, что не все сжатые входные данные удастся обработать; необработанные данные будут сохранены в атрибуте unconsumed_tail. Эта строка байтов должна быть передана последующему вызову decompress(), если декомпрессию необходимо продолжить. Если max_length не указан, то обрабатываются все входные данные целиком, и unconsumed_tail пуст.

Decompress.flush([length])¶

Все ожидающие входные данные обрабатываются, и возвращается объект bytes, содержащий оставшиеся несжатые данные. После вызова flush() метод decompress() больше нельзя вызывать; единственное разумное действие – удалить объект.

Необязательный параметр length задаёт начальный размер выходного буфера.

Decompress.copy()¶

Возвращает копию объекта распаковки. Это можно использовать для сохранения состояния распаковщика на середине потока данных, чтобы ускорить произвольный доступ к потоку в будущем.