Merge pull request #688 from myungsegyo/master

Author: WisdomPill

AUTHORS.rst

@@ -14,3 +14,4 @@ David Zderic / dzderic <https://github.com/dzderic>
 Kirill Zaitsev / teferi <https://github.com/teferi>
 Jon Dufresne <https://github.com/jdufresne>
 Anès Foufa <https://github.com/AnesFoufa>
+Segyo Myung <https://github.com/myungsegyo>

README.rst

@@ -291,6 +291,21 @@ Let see an example, of how make it work with *lzma* compression format:
         }
     }
 
+*Gzip* compression support:
+
+.. code-block:: python
+
+    import gzip
+
+    CACHES = {
+        "default": {
+            # ...
+            "OPTIONS": {
+                "COMPRESSOR": "django_redis.compressors.gzip.GzipCompressor",
+            }
+        }
+    }
+
 Memcached exceptions behavior
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

changelog.d/688.feature

@@ -0,0 +1 @@
+Support gzip compression

django_redis/compressors/gzip.py

@@ -0,0 +1,19 @@
+import gzip
+
+from django_redis.compressors.base import BaseCompressor
+from django_redis.exceptions import CompressorError
+
+
+class GzipCompressor(BaseCompressor):
+    min_length = 15
+
+    def compress(self, value: bytes) -> bytes:
+        if len(value) > self.min_length:
+            return gzip.compress(value)
+        return value
+
+    def decompress(self, value: bytes) -> bytes:
+        try:
+            return gzip.decompress(value)
+        except gzip.BadGzipFile as e:
+            raise CompressorError from e

setup.cfg

@@ -91,6 +91,7 @@ commands =
   {envpython} -m pytest --cov-append --cov-report= --ds=settings.sqlite_usock {posargs}
   {envpython} -m pytest --cov-append --cov-report= --ds=settings.sqlite_zlib {posargs}
   {envpython} -m pytest --cov-append --cov-report= --ds=settings.sqlite_zstd {posargs}
+  {envpython} -m pytest --cov-append --cov-report= --ds=settings.sqlite_gzip {posargs}
   {envpython} -m coverage report
   {envpython} -m coverage xml
 

tests/settings/sqlite_gzip.py

@@ -0,0 +1,41 @@
+SECRET_KEY = "django_tests_secret_key"
+
+CACHES = {
+    "default": {
+        "BACKEND": "django_redis.cache.RedisCache",
+        "LOCATION": ["redis://127.0.0.1:6379?db=1", "redis://127.0.0.1:6379?db=1"],
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_redis.client.DefaultClient",
+            "COMPRESSOR": "django_redis.compressors.gzip.GzipCompressor",
+        },
+    },
+    "doesnotexist": {
+        "BACKEND": "django_redis.cache.RedisCache",
+        "LOCATION": "redis://127.0.0.1:56379?db=1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_redis.client.DefaultClient",
+            "COMPRESSOR": "django_redis.compressors.gzip.GzipCompressor",
+        },
+    },
+    "sample": {
+        "BACKEND": "django_redis.cache.RedisCache",
+        "LOCATION": "redis://127.0.0.1:6379?db=1,redis://127.0.0.1:6379?db=1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_redis.client.DefaultClient",
+            "COMPRESSOR": "django_redis.compressors.gzip.GzipCompressor",
+        },
+    },
+    "with_prefix": {
+        "BACKEND": "django_redis.cache.RedisCache",
+        "LOCATION": "redis://127.0.0.1:6379?db=1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_redis.client.DefaultClient",
+            "COMPRESSOR": "django_redis.compressors.gzip.GzipCompressor",
+        },
+        "KEY_PREFIX": "test-prefix",
+    },
+}
+
+INSTALLED_APPS = ["django.contrib.sessions"]
+
+USE_TZ = False