compress.deflate

import compress

compress exposes this as compress.deflate, so import compress is enough and the names are called as compress.deflate.*. import compress.deflate reaches the same definitions directly.

This is the Deflate submodule for the compress module.

Functions

compress()

compress.deflate.compress(data) -> bytes

Compress data using the default options for Deflate.

Parameters

• data (bytes|string)

Returns bytes

decompress()

compress.deflate.decompress(data) -> bytes

Decompress a deflated data using default options.

Parameters

• data (bytes|string)

Returns bytes

Classes

DeflateEncoder

class compress.deflate.DeflateEncoder < GzipEncoder

A streaming Deflate encoder.

Example:

%> import compress.deflate
%> var encoder = deflate.DeflateEncoder()
%> encoder.write('hello world')
11
%> encoder.finish()
(cb 48 cd c9 c9 57 28 cf 2f ca 49 01 00)

Constructor

compress.deflate.DeflateEncoder(level)

Creates a new streaming Deflate encoder at the given level (0..=9).

Parameters

• level (?number) — Default 1

DeflateDecoder

class compress.deflate.DeflateDecoder < GzipDecoder

Streaming deflate decompressor implemention. This decoder reads standard deflate blocks and frames produced at any deflate compression level.

Wraps a byte stream of compressed data and yields decompressed bytes.

Example:

%> import compress.deflate
%> var data = deflate.compress('hello world')
%> data
(cb 48 cd c9 c9 57 28 cf 2f ca 49 01 00)
%> 
%> var decoder = deflate.DeflateDecoder(data)
%> decoder.read_as_string()
hello world

This decoder is level-independent and supports standard deflate frames produced by all deflate compression levels.

Constructor

compress.deflate.DeflateDecoder(source)

Creates a Gzip decoder

Parameters

• source (bytes)

2021, Richard Ore and Zuri contributors