feat: add first version (#1)

.github/workflows/ci.yml

@@ -40,7 +40,6 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
-          - "3.12"
         os:
           - ubuntu-latest
           - windows-latest

README.md

@@ -35,12 +35,26 @@
 
 Enable zlib_ng on aiohttp
 
+zlib is be a bottleneck for aiohttp, especially for websocket connections. `aiohttp-zlib-ng` replaces usage of `zlib` in `aiohttp` with `zlib-ng` which is a drop-in faster replacement.
+
 ## Installation
 
 Install this via pip (or your favourite package manager):
 
 `pip install aiohttp-zlib-ng`
 
+## Usage
+
+Importing the module is enough to enable [zlib-ng](https://github.com/pycompression/python-zlib-ng) support in aiohttp.
+
+```python
+
+import aiohttp_zlib_ng
+
+aiohttp_zlib_ng.disable_zlib_ng()
+aiohttp_zlib_ng.enable_zlib_ng()
+```
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

pyproject.toml

@@ -23,6 +23,8 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "^3.8"
+aiohttp = ">=3.8.5"
+zlib-ng = ">=0.2.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.0"

src/aiohttp_zlib_ng/__init__.py

@@ -1 +1,37 @@
 __version__ = "0.0.0"
+
+import importlib
+import zlib as zlib_original
+
+import aiohttp
+from zlib_ng import zlib_ng as zlib_ng
+
+TARGETS = (
+    "compression_utils",
+    "http_writer",
+    "http_websocket",
+    "http_writer",
+    "multipart",
+    "web_response",
+)
+
+
+def enable_zlib_ng() -> None:
+    """Enable zlib-ng."""
+    for location in TARGETS:
+        try:
+            importlib.import_module(f"aiohttp.{location}")
+        except ImportError:
+            continue
+        if module := getattr(aiohttp, location, None):
+            module.zlib = zlib_ng
+
+
+def disable_zlib_ng() -> None:
+    """Disable zlib-ng and restore the original zlib."""
+    for location in TARGETS:
+        if module := getattr(aiohttp, location, None):
+            module.zlib = zlib_original
+
+
+enable_zlib_ng()

tests/test_init.py

@@ -0,0 +1,15 @@
+import zlib as zlib_original
+
+import aiohttp.http_websocket
+from zlib_ng import zlib_ng as zlib_ng
+
+from aiohttp_zlib_ng import disable_zlib_ng, enable_zlib_ng
+
+
+def test_enable_disable():
+    """Test enable/disable."""
+    assert aiohttp.http_websocket.zlib is zlib_ng
+    disable_zlib_ng()
+    assert aiohttp.http_websocket.zlib is zlib_original
+    enable_zlib_ng()
+    assert aiohttp.http_websocket.zlib is zlib_ng