Use Brotli instead of brotlipy (#3803)

brotlipy is stuck at brotli 0.6 and upstream is inactive. Let's switch to the official binding which is up-to-date.
aio-libs · Jul 19, 2019 · 9afc44b · 9afc44b
1 parent 0051aa0
commit 9afc44b
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 7 deletions.
diff --git a/CHANGES/3803.feature b/CHANGES/3803.feature
@@ -0,0 +1 @@
+Use Brotli instead of brotlipy
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -92,6 +92,7 @@ Eugene Chernyshov
 Eugene Naydenov
 Eugene Tolmachev
 Evert Lammerts
+Felix Yan
 FichteFoll
 Frederik Gladhorn
 Frederik Peter Aalund

diff --git a/aiohttp/http_parser.py b/aiohttp/http_parser.py
@@ -698,8 +698,26 @@ def __init__(self, out: StreamReader, encoding: Optional[str]) -> None:
             if not HAS_BROTLI:  # pragma: no cover
                 raise ContentEncodingError(
                     'Can not decode content-encoding: brotli (br). '
-                    'Please install `brotlipy`')
-            self.decompressor = brotli.Decompressor()
+                    'Please install `Brotli`')
+
+            class BrotliDecoder:
+                # Supports both 'brotlipy' and 'Brotli' packages
+                # since they share an import name. The top branches
+                # are for 'brotlipy' and bottom branches for 'Brotli'
+                def __init__(self) -> None:
+                    self._obj = brotli.Decompressor()
+
+                def decompress(self, data: bytes) -> bytes:
+                    if hasattr(self._obj, "decompress"):
+                        return self._obj.decompress(data)
+                    return self._obj.process(data)
+
+                def flush(self) -> bytes:
+                    if hasattr(self._obj, "flush"):
+                        return self._obj.flush()
+                    return b""
+
+            self.decompressor = BrotliDecoder()  # type: Any
         else:
             zlib_mode = (16 + zlib.MAX_WBITS
                          if encoding == 'gzip' else -zlib.MAX_WBITS)

diff --git a/docs/client_quickstart.rst b/docs/client_quickstart.rst
@@ -171,7 +171,7 @@ The ``gzip`` and ``deflate`` transfer-encodings are automatically
 decoded for you.
 
 You can enable ``brotli`` transfer-encodings support,
-just install  `brotlipy <https://github.com/python-hyper/brotlipy>`_.
+just install  `Brotli <https://pypi.org/project/Brotli>`_.
 
 JSON Request
 ============

diff --git a/docs/index.rst b/docs/index.rst
@@ -52,7 +52,7 @@ Installing speedups altogether
 ------------------------------
 
 The following will get you ``aiohttp`` along with :term:`chardet`,
-:term:`aiodns` and ``brotlipy`` in one bundle. No need to type
+:term:`aiodns` and ``Brotli`` in one bundle. No need to type
 separate commands anymore!
 
 .. code-block:: bash

diff --git a/requirements/ci-wheel.txt b/requirements/ci-wheel.txt
@@ -2,7 +2,7 @@
 attrs==19.1.0
 async-generator==1.10
 async-timeout==3.0.1
-brotlipy==0.7.0
+Brotli==1.0.7
 cchardet==2.1.4
 chardet==3.0.4
 coverage==4.5.3

diff --git a/setup.py b/setup.py
@@ -135,7 +135,7 @@ def read(f):
     extras_require={
         'speedups': [
             'aiodns',
-            'brotlipy',
+            'Brotli',
             'cchardet',
         ],
     },

diff --git a/tox.ini b/tox.ini
@@ -12,7 +12,7 @@ deps =
     coverage
     gunicorn
     async-generator
-    brotlipy
+    Brotli
     cython: cython
     -e .