BrotliCFFI

1.2.0.1 · active · verified Fri Apr 10

BrotliCFFI provides Python CFFI bindings to Google's high-performance Brotli compression library. It allows Python applications to leverage the Brotli compression algorithm efficiently across various Python interpreters, including PyPy. The current version is 1.2.0.1, and it maintains an active release cadence with regular updates to the underlying Brotli library and Python compatibility.

Warnings

breaking Package renamed from `brotlipy` to `brotlicffi` and import namespace changed from `brotli` to `brotlicffi` to avoid conflicts with Google's official Brotli C bindings.
Fix: Update your `pip install` command to `pip install brotlicffi` and change all `import brotli` statements to `import brotlicffi`.
breaking The `dictionary` parameter was removed from `brotlicffi.compress()` and `brotlicffi.Compressor`.
Fix: Remove the `dictionary` parameter from calls to `compress()` or `Compressor` instantiation.
breaking Support for Python 2.7, 3.5, and 3.6 was explicitly removed.
Fix: Upgrade your Python environment to Python 3.8 or newer.
breaking Concurrent sharing of `Compressor` or `Decompressor` objects across multiple threads (especially with Python 3.14's free-threaded build) now raises an exception.
Fix: Ensure that `Compressor` and `Decompressor` instances are not shared concurrently between threads. Create a new instance per thread or use appropriate locking mechanisms if sharing is unavoidable.
gotcha `decompress()` would return an empty bytestring instead of erroring if the provided bytestring was too small or malformed.
Fix: This bug was resolved in version 0.6.0. Ensure you are using version 0.6.0 or newer. For older versions, explicitly check the length of the decompressed data.
gotcha The `output_buffer_limit` parameter was added to `Decompressor.decompress()` and `Decompressor.process()` methods to mitigate potential security concerns from maliciously crafted compressed data leading to excessive memory usage.
Fix: Consider upgrading to version 1.2.0.0 or later and utilizing the `output_buffer_limit` parameter when decompressing untrusted data.

Install

pip install brotlicffi Install from PyPI
conda install -c conda-forge brotlicffi Install with Conda

Imports

brotlicffi
```
import brotlicffi
```
Prior to version 0.8.0, the import namespace was 'brotli', which conflicted with Google's native 'brotli' package. The correct import is now 'brotlicffi'.

Quickstart

This quickstart demonstrates basic compression and decompression of a byte string using `brotlicffi.compress()` and `brotlicffi.decompress()`.

import brotlicffi

original_data = b"This is some sample data that will be compressed using Brotli!"

# Compress data
compressed_data = brotlicffi.compress(original_data)
print(f"Original size: {len(original_data)} bytes")
print(f"Compressed size: {len(compressed_data)} bytes")

# Decompress data
decompressed_data = brotlicffi.decompress(compressed_data)

print(f"Decompressed data: {decompressed_data}")
assert original_data == decompressed_data
print("Compression and decompression successful!")

view raw JSON →