Add redis/redis-py@3c244af

getex (redis/redis-py#1515)

* Removed small doc saying all time parameters can be datetime.timedelta. This is not needed with typing and can also be confusing with PXAT and EXAT

Signed-off-by: Andrew-Chen-Wang <[email protected]>

Author: Andrew-Chen-Wang

aioredis/client.py

@@ -1853,6 +1853,63 @@ def get(self, name: KeyT) -> Awaitable:
         """
         return self.execute_command("GET", name)
 
+    def getex(
+        self,
+        name: str,
+        ex: Union[int, datetime.timedelta] = None,
+        px: Union[int, datetime.timedelta] = None,
+        exat: Union[int, datetime.datetime] = None,
+        pxat: Union[int, datetime.datetime] = None,
+        persist: bool = False,
+    ):
+        """
+        Get the value of key and optionally set its expiration.
+        GETEX is similar to GET, but is a write command with
+        additional options.
+
+        ``ex`` sets an expire flag on key ``name`` for ``ex`` seconds.
+
+        ``px`` sets an expire flag on key ``name`` for ``px`` milliseconds.
+
+        ``exat`` sets an expire flag on key ``name`` for ``ex`` seconds,
+        specified in unix time.
+
+        ``pxat`` sets an expire flag on key ``name`` for ``ex`` milliseconds,
+        specified in unix time.
+
+        ``persist`` remove the time to live associated with ``name``.
+        """
+
+        pieces = []
+        # similar to set command
+        if ex is not None:
+            pieces.append("EX")
+            if isinstance(ex, datetime.timedelta):
+                ex = int(ex.total_seconds())
+            pieces.append(ex)
+        if px is not None:
+            pieces.append("PX")
+            if isinstance(px, datetime.timedelta):
+                px = int(px.total_seconds() * 1000)
+            pieces.append(px)
+        # similar to pexpireat command
+        if exat is not None:
+            pieces.append("EXAT")
+            if isinstance(exat, datetime.datetime):
+                s = int(exat.microsecond / 1000000)
+                exat = int(mod_time.mktime(exat.timetuple())) + s
+            pieces.append(exat)
+        if pxat is not None:
+            pieces.append("PXAT")
+            if isinstance(pxat, datetime.datetime):
+                ms = int(pxat.microsecond / 1000)
+                pxat = int(mod_time.mktime(pxat.timetuple())) * 1000 + ms
+            pieces.append(pxat)
+        if persist:
+            pieces.append("PERSIST")
+
+        return self.execute_command("GETEX", name, *pieces)
+
     def getbit(self, name: KeyT, offset: int) -> Awaitable:
         """Returns a boolean indicating the value of ``offset`` in ``name``"""
         return self.execute_command("GETBIT", name, offset)

tests/test_commands.py

@@ -806,6 +806,21 @@ async def test_get_and_set(self, r: aioredis.Redis):
         assert await r.get("integer") == str(integer).encode()
         assert (await r.get("unicode_string")).decode("utf-8") == unicode_string
 
+    @skip_if_server_version_lt("6.2.0")
+    async def test_getex(self, r: aioredis.Redis):
+        await r.set("a", 1)
+        assert await r.getex("a") == b"1"
+        assert await r.ttl("a") == -1
+        assert await r.getex("a", ex=60) == b"1"
+        assert await r.ttl("a") == 60
+        assert await r.getex("a", px=6000) == b"1"
+        assert await r.ttl("a") == 6
+        expire_at = await redis_server_time(r) + datetime.timedelta(minutes=1)
+        assert await r.getex("a", pxat=expire_at) == b"1"
+        assert await r.ttl("a") <= 60
+        assert await r.getex("a", persist=True) == b"1"
+        assert await r.ttl("a") == -1
+
     async def test_get_set_bit(self, r: aioredis.Redis):
         # no value
         assert not await r.getbit("a", 5)