Function decompress

Lib/compression/zstd/__init__.py:152–172

Decompress one or more frames of Zstandard compressed *data*. *zstd_dict* is a ZstdDict object, a pre-trained Zstandard dictionary. See the function train_dict for how to train a ZstdDict on sample data. *options* is a dict object that contains advanced compression parameters. See D

(data, zstd_dict=None, options=None)

def decompress(data, zstd_dict=None, options=None):
    """Decompress one or more frames of Zstandard compressed *data*.

    *zstd_dict* is a ZstdDict object, a pre-trained Zstandard dictionary. See
    the function train_dict for how to train a ZstdDict on sample data.
    *options* is a dict object that contains advanced compression
    parameters. See DecompressionParameter for more on options.

    For incremental decompression, use a ZstdDecompressor instead.
    """
    results = []
    while True:
        decomp = ZstdDecompressor(options=options, zstd_dict=zstd_dict)
        results.append(decomp.decompress(data))
        if not decomp.eof:
            raise ZstdError('Compressed data ended before the '
                            'end-of-stream marker was reached')
        data = decomp.unused_data
        if not data:
            break
    return b''.join(results)


class CompressionParameter(enum.IntEnum):