Merge pull request #73 from amirreza8002/msgspec

add support for msgspec serialization

Author: amirreza8002

.github/workflows/ci.yml

@@ -97,6 +97,8 @@ jobs:
           uv run pytest tests/*.py --ds=tests.settings.sqlite -x
           uv run pytest tests/*.py --ds=tests.settings.sqlite_herd -x
           uv run pytest tests/*.py --ds=tests.settings.sqlite_json -x
+          uv run pytest tests/*.py --ds=tests.settings.sqlite_msgspec_json -x
+          uv run pytest tests/*.py --ds=tests.settings.sqlite_msgspec_msgpack -x
           uv run pytest tests/*.py --ds=tests.settings.sqlite_msgpack -x
           uv run pytest tests/*.py --ds=tests.settings.sqlite_sentinel -x
           uv run pytest tests/*.py --ds=tests.settings.sqlite_sentinel_opts -x

CHANGES.md

@@ -1,3 +1,5 @@
+### new
+- added support for msgspec serialization (both json and msgpack)
 
 ### Breaking changes
 - `BackendCommands` and `AsyncBackendCommands` are no longer decorated with `omit_exception`.

django_valkey/serializers/msgspec.py

@@ -0,0 +1,21 @@
+from typing import Any
+
+import msgspec
+
+from django_valkey.serializers.base import BaseSerializer
+
+
+class MsgSpecJsonSerializer(BaseSerializer):
+    def dumps(self, value: Any) -> bytes:
+        return msgspec.json.encode(value)
+
+    def loads(self, value: bytes) -> Any:
+        return msgspec.json.decode(value)
+
+
+class MsgSpecMsgPackSerializer(BaseSerializer):
+    def dumps(self, value: Any) -> bytes:
+        return msgspec.msgpack.encode(value)
+
+    def loads(self, value: bytes) -> Any:
+        return msgspec.msgpack.decode(value)

docs/configure/advanced_configurations.md

@@ -202,7 +202,12 @@ and you're good to go
 
 ### Use Msgpack serializer
 
-to use the msgpack serializer you should first install the msgpack package as explained in :ref:`msgpack`
+to use the msgpack serializer you should first install the msgpack package 
+
+```shell
+pip install django-valkey[msgpack]
+```
+
 then configure your settings like this:
 
 ```python
@@ -219,8 +224,43 @@ CACHES = {
 
 and done
 
-### Fun fact
-you can serialize every type in the python built-ins, and probably non built-ins, but you have to check which serializer supports that type.
+### Use msgspec serializers
+
+msgspec comes with two serializers, one for json, one for msgpack
+
+to use msgspec, first install the extra package:
+```shell
+pip install django-valkey[msgspec]
+```
+
+to use the json serializer, configure your backend like this:
+
+```python
+CACHES = {
+    "default": {
+        # ...
+        "OPTIONS": {
+            "SERIALIZER": "django_valkey.serializer.msgspec.MsgSpecJsonSerializer",
+            # ...
+        }
+    }
+}
+```
+
+to use the msgpack serializer, configure it like this:
+
+```python
+CACHES = {
+    "default": {
+        # ...
+        "OPTIONS": {
+            "SERIALIZER": "django_valkey.serializer.msgspec.MsgSpecMsgPackSerializer",
+            # ...
+        }
+    }
+}
+```
+
 
 ## Pluggable Compressors
 

pyproject.toml

@@ -61,6 +61,10 @@ brotli = [
     "brotli>=1.1.0",
 ]
 
+msgspec = [
+    "msgspec>=0.19.0",
+]
+
 [dependency-groups]
 dev = [
     "anyio>=4.9.0",

tests/settings/sqlite_msgspec_json.py

@@ -0,0 +1,41 @@
+SECRET_KEY = "django_tests_secret_key"
+
+CACHES = {
+    "default": {
+        "BACKEND": "django_valkey.cache.ValkeyCache",
+        "LOCATION": ["valkey://127.0.0.1:6379?db=1", "valkey://127.0.0.1:6379?db=1"],
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_valkey.client.DefaultClient",
+            "SERIALIZER": "django_valkey.serializers.msgspec.MsgSpecJsonSerializer",
+        },
+    },
+    "doesnotexist": {
+        "BACKEND": "django_valkey.cache.ValkeyCache",
+        "LOCATION": "valkey://127.0.0.1:56379?db=1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_valkey.client.DefaultClient",
+            "SERIALIZER": "django_valkey.serializers.msgspec.MsgSpecJsonSerializer",
+        },
+    },
+    "sample": {
+        "BACKEND": "django_valkey.cache.ValkeyCache",
+        "LOCATION": "valkey://127.0.0.1:6379?db=1,valkey://127.0.0.1:6379?db=1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_valkey.client.DefaultClient",
+            "SERIALIZER": "django_valkey.serializers.msgspec.MsgSpecJsonSerializer",
+        },
+    },
+    "with_prefix": {
+        "BACKEND": "django_valkey.cache.ValkeyCache",
+        "LOCATION": "valkey://127.0.0.1:6379?db=1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_valkey.client.DefaultClient",
+            "SERIALIZER": "django_valkey.serializers.msgspec.MsgSpecJsonSerializer",
+        },
+        "KEY_PREFIX": "test-prefix",
+    },
+}
+
+INSTALLED_APPS = ["django.contrib.sessions"]
+
+USE_TZ = False

tests/settings/sqlite_msgspec_msgpack.py

@@ -0,0 +1,41 @@
+SECRET_KEY = "django_tests_secret_key"
+
+CACHES = {
+    "default": {
+        "BACKEND": "django_valkey.cache.ValkeyCache",
+        "LOCATION": ["valkey://127.0.0.1:6379?db=1", "valkey://127.0.0.1:6379?db=1"],
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_valkey.client.DefaultClient",
+            "SERIALIZER": "django_valkey.serializers.msgspec.MsgSpecMsgPackSerializer",
+        },
+    },
+    "doesnotexist": {
+        "BACKEND": "django_valkey.cache.ValkeyCache",
+        "LOCATION": "valkey://127.0.0.1:56379?db=1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_valkey.client.DefaultClient",
+            "SERIALIZER": "django_valkey.serializers.msgspec.MsgSpecMsgPackSerializer",
+        },
+    },
+    "sample": {
+        "BACKEND": "django_valkey.cache.ValkeyCache",
+        "LOCATION": "valkey://127.0.0.1:6379?db=1,valkey://127.0.0.1:6379?db=1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_valkey.client.DefaultClient",
+            "SERIALIZER": "django_valkey.serializers.msgspec.MsgSpecMsgPackSerializer",
+        },
+    },
+    "with_prefix": {
+        "BACKEND": "django_valkey.cache.ValkeyCache",
+        "LOCATION": "valkey://127.0.0.1:6379?db=1",
+        "OPTIONS": {
+            "CLIENT_CLASS": "django_valkey.client.DefaultClient",
+            "SERIALIZER": "django_valkey.serializers.msgspec.MsgSpecMsgPackSerializer",
+        },
+        "KEY_PREFIX": "test-prefix",
+    },
+}
+
+INSTALLED_APPS = ["django.contrib.sessions"]
+
+USE_TZ = False

tests/test_backend.py

@@ -18,6 +18,10 @@
 from django_valkey.cluster_cache.client import DefaultClusterClient
 from django_valkey.serializers.json import JSONSerializer
 from django_valkey.serializers.msgpack import MSGPackSerializer
+from django_valkey.serializers.msgspec import (
+    MsgSpecJsonSerializer,
+    MsgSpecMsgPackSerializer,
+)
 from django_valkey.serializers.pickle import PickleSerializer
 
 
@@ -128,7 +132,15 @@ def test_save_unicode(self, cache: ValkeyCache):
         assert res == "heló"
 
     def test_save_dict(self, cache: ValkeyCache):
-        if isinstance(cache.client._serializer, (JSONSerializer, MSGPackSerializer)):
+        if isinstance(
+            cache.client._serializer,
+            (
+                JSONSerializer,
+                MSGPackSerializer,
+                MsgSpecJsonSerializer,
+                MsgSpecMsgPackSerializer,
+            ),
+        ):
             # JSONSerializer and MSGPackSerializer use the isoformat for
             # datetimes.
             now_dt: str | datetime.datetime = datetime.datetime.now().isoformat()
@@ -1099,9 +1111,17 @@ def test_sismember_memoryview(self, cache: ValkeyCache):
         assert cache.sismember("foo", wrong_val) is False
 
     def test_sismember_complex(self, cache: ValkeyCache):
-        if isinstance(cache.client._serializer, (JSONSerializer, MSGPackSerializer)):
+        if isinstance(
+            cache.client._serializer,
+            (
+                JSONSerializer,
+                MSGPackSerializer,
+                MsgSpecJsonSerializer,
+                MsgSpecMsgPackSerializer,
+            ),
+        ):
             pytest.skip(
-                "JSONSerializer/MSGPackSerializer doesn't support the complex type"
+                "JSONSerializer/MSGPackSerializer and neither the msgspec serializers don't support the complex type"
             )
         cache.sadd("foo", 3j)
         assert cache.sismember("foo", 3j) is True