• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright 2016 The Brotli Authors. All rights reserved.
2#
3# Distributed under MIT license.
4# See file LICENSE for detail or copy at https://opensource.org/licenses/MIT
5
6"""Functions to compress and decompress data using the Brotli library."""
7
8import _brotli
9
10
11# The library version.
12__version__ = _brotli.__version__
13
14# The compression mode.
15MODE_GENERIC = _brotli.MODE_GENERIC
16MODE_TEXT = _brotli.MODE_TEXT
17MODE_FONT = _brotli.MODE_FONT
18
19# The Compressor object.
20Compressor = _brotli.Compressor
21
22# The Decompressor object.
23Decompressor = _brotli.Decompressor
24
25# Compress a byte string.
26def compress(string, mode=MODE_GENERIC, quality=11, lgwin=22, lgblock=0):
27    """Compress a byte string.
28
29    Args:
30      string (bytes): The input data.
31      mode (int, optional): The compression mode can be MODE_GENERIC (default),
32        MODE_TEXT (for UTF-8 format text input) or MODE_FONT (for WOFF 2.0).
33      quality (int, optional): Controls the compression-speed vs compression-
34        density tradeoff. The higher the quality, the slower the compression.
35        Range is 0 to 11. Defaults to 11.
36      lgwin (int, optional): Base 2 logarithm of the sliding window size. Range
37        is 10 to 24. Defaults to 22.
38      lgblock (int, optional): Base 2 logarithm of the maximum input block size.
39        Range is 16 to 24. If set to 0, the value will be set based on the
40        quality. Defaults to 0.
41
42    Returns:
43      The compressed byte string.
44
45    Raises:
46      brotli.error: If arguments are invalid, or compressor fails.
47    """
48    compressor = Compressor(mode=mode, quality=quality, lgwin=lgwin,
49                            lgblock=lgblock)
50    return compressor.process(string) + compressor.finish()
51
52# Decompress a compressed byte string.
53decompress = _brotli.decompress
54
55# Raised if compression or decompression fails.
56error = _brotli.error
57