Add DIGEST command support with tests

Author: petyaslavova

redis/commands/cluster.py

@@ -61,6 +61,7 @@
         "GEOPOS",
         "GEORADIUS",
         "GEORADIUSBYMEMBER",
+        "DIGEST",
         "GET",
         "GETBIT",
         "GETRANGE",

redis/commands/core.py

@@ -1835,6 +1835,21 @@ def expiretime(self, key: str) -> int:
         """
         return self.execute_command("EXPIRETIME", key)
 
+    def digest(self, name: KeyT) -> Optional[str]:
+        """
+        Return the digest of the value stored at the specified key.
+
+        Returns:
+          - None if the key does not exist
+          - (bulk string) the XXH3 digest of the value as a hex string
+        Raises:
+          - ResponseError if key exists but is not a string
+
+        For more information, see https://redis.io/commands/digest
+        """
+        # Bulk string response is already handled (bytes/str based on decode_responses)
+        return self.execute_command("DIGEST", name)
+
     def get(self, name: KeyT) -> ResponseT:
         """
         Return the value at key ``name``, or None if the key doesn't exist

tests/test_asyncio/test_commands.py

@@ -1115,6 +1115,48 @@ async def test_expireat_unixtime(self, r: redis.Redis):
         assert await r.expireat("a", expire_at_seconds)
         assert 0 < await r.ttl("a") <= 61
 
+    @skip_if_server_version_lt("8.3.224")
+    async def test_digest_nonexistent_returns_none(self, r):
+        assert await r.digest("no:such:key") is None
+
+    @skip_if_server_version_lt("8.3.224")
+    async def test_digest_wrong_type_raises(self, r):
+        await r.lpush("alist", "x")
+        with pytest.raises(Exception):  # or redis.exceptions.ResponseError
+            await r.digest("alist")
+
+    @skip_if_server_version_lt("8.3.224")
+    @pytest.mark.parametrize(
+        "value", [b"", b"abc", b"The quick brown fox jumps over the lazy dog"]
+    )
+    async def test_digest_response_when_available(self, r, value):
+        key = "k:digest"
+        await r.delete(key)
+        await r.set(key, value)
+
+        res = await r.digest(key)
+        # got is str if decode_responses=True; ensure bytes->str for comparison
+        if isinstance(res, bytes):
+            res = res.decode()
+        assert res is not None
+        assert all(c in "0123456789abcdefABCDEF" for c in res)
+
+        assert len(res) == 16
+
+    @skip_if_server_version_lt("8.3.224")
+    async def test_pipeline_digest(self, r):
+        k1, k2 = "k:d1", "k:d2"
+        await r.mset({k1: b"A", k2: b"B"})
+        p = r.pipeline()
+        p.digest(k1)
+        p.digest(k2)
+        out = await p.execute()
+        assert len(out) == 2
+        for d in out:
+            if isinstance(d, bytes):
+                d = d.decode()
+            assert d is None or len(d) == 16
+
     async def test_get_and_set(self, r: redis.Redis):
         # get and set can't be tested independently of each other
         assert await r.get("a") is None

tests/test_commands.py

@@ -1666,6 +1666,48 @@ def test_expireat_option_lt(self, r):
         expire_at = redis_server_time(r) + datetime.timedelta(minutes=1)
         assert r.expireat("key", expire_at, lt=True) is True
 
+    @skip_if_server_version_lt("8.3.224")
+    def test_digest_nonexistent_returns_none(self, r):
+        assert r.digest("no:such:key") is None
+
+    @skip_if_server_version_lt("8.3.224")
+    def test_digest_wrong_type_raises(self, r):
+        r.lpush("alist", "x")
+        with pytest.raises(Exception):  # or redis.exceptions.ResponseError
+            r.digest("alist")
+
+    @skip_if_server_version_lt("8.3.224")
+    @pytest.mark.parametrize(
+        "value", [b"", b"abc", b"The quick brown fox jumps over the lazy dog"]
+    )
+    def test_digest_response_when_available(self, r, value):
+        key = "k:digest"
+        r.delete(key)
+        r.set(key, value)
+
+        res = r.digest(key)
+        # got is str if decode_responses=True; ensure bytes->str for comparison
+        if isinstance(res, bytes):
+            res = res.decode()
+        assert res is not None
+        assert all(c in "0123456789abcdefABCDEF" for c in res)
+
+        assert len(res) == 16
+
+    @skip_if_server_version_lt("8.3.224")
+    def test_pipeline_digest(self, r):
+        k1, k2 = "k:d1", "k:d2"
+        r.mset({k1: b"A", k2: b"B"})
+        p = r.pipeline()
+        p.digest(k1)
+        p.digest(k2)
+        out = p.execute()
+        assert len(out) == 2
+        for d in out:
+            if isinstance(d, bytes):
+                d = d.decode()
+            assert d is None or len(d) == 16
+
     def test_get_and_set(self, r):
         # get and set can't be tested independently of each other
         assert r.get("a") is None