Alex Nicksay | f7b5b3d | 2016-09-28 17:26:00 -0400 | [diff] [blame] | 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 | |
| 8 | import _brotli |
| 9 | |
| 10 | |
| 11 | # The library version. |
| 12 | __version__ = _brotli.__version__ |
| 13 | |
| 14 | # The compression mode. |
| 15 | MODE_GENERIC = _brotli.MODE_GENERIC |
| 16 | MODE_TEXT = _brotli.MODE_TEXT |
| 17 | MODE_FONT = _brotli.MODE_FONT |
| 18 | |
| 19 | # Compress a byte string. |
Alex Nicksay | 595a524 | 2016-09-29 15:14:16 -0400 | [diff] [blame^] | 20 | def compress(string, mode=MODE_GENERIC, quality=11, lgwin=22, lgblock=0, |
| 21 | dictionary=''): |
| 22 | """Compress a byte string. |
| 23 | |
| 24 | Args: |
| 25 | string (bytes): The input data. |
| 26 | mode (int, optional): The compression mode can be MODE_GENERIC (default), |
| 27 | MODE_TEXT (for UTF-8 format text input) or MODE_FONT (for WOFF 2.0). |
| 28 | quality (int, optional): Controls the compression-speed vs compression- |
| 29 | density tradeoff. The higher the quality, the slower the compression. |
| 30 | Range is 0 to 11. Defaults to 11. |
| 31 | lgwin (int, optional): Base 2 logarithm of the sliding window size. Range |
| 32 | is 10 to 24. Defaults to 22. |
| 33 | lgblock (int, optional): Base 2 logarithm of the maximum input block size. |
| 34 | Range is 16 to 24. If set to 0, the value will be set based on the |
| 35 | quality. Defaults to 0. |
| 36 | dictionary (bytes, optional): Custom dictionary. Only last sliding window |
| 37 | size bytes will be used. |
| 38 | |
| 39 | Returns: |
| 40 | The compressed byte string. |
| 41 | |
| 42 | Raises: |
| 43 | brotli.error: If arguments are invalid, or compressor fails. |
| 44 | """ |
| 45 | compressor = _brotli.Compressor(mode=mode, quality=quality, lgwin=lgwin, |
| 46 | lgblock=lgblock, dictionary=dictionary) |
| 47 | return compressor.compress(string) |
Alex Nicksay | f7b5b3d | 2016-09-28 17:26:00 -0400 | [diff] [blame] | 48 | |
| 49 | # Decompress a compressed byte string. |
| 50 | decompress = _brotli.decompress |
| 51 | |
| 52 | # Raised if compression or decompression fails. |
| 53 | error = _brotli.error |