Add support for EXPIREAT command's options

redis/commands/core.py

@@ -1501,16 +1501,28 @@ def expire(self, name: KeyT, time: ExpiryT) -> ResponseT:
             time = int(time.total_seconds())
         return self.execute_command("EXPIRE", name, time)
 
-    def expireat(self, name: KeyT, when: AbsExpiryT) -> ResponseT:
+    def expireat(self, name: KeyT, when: AbsExpiryT, option: str = None) -> ResponseT:
         """
-        Set an expire flag on key ``name``. ``when`` can be represented
-        as an integer indicating unix time or a Python datetime object.
+        Set an expire flag on key ``name`` with the given ``option``. ``when``
+        can be represented as an integer indicating unix time or a Python
+        datetime object.
+
+        Valid options are:
+            -> NX -- Set expiry only when the key has no expiry
+            -> XX -- Set expiry only when the key has an existing expiry
+            -> GT -- Set expiry only when the new expiry is greater than current one
+            -> LT -- Set expiry only when the new expiry is less than current one
 
         For more information check https://redis.io/commands/expireat
         """
         if isinstance(when, datetime.datetime):
             when = int(time.mktime(when.timetuple()))
-        return self.execute_command("EXPIREAT", name, when)
+
+        exp_option = list()
+        if option is not None:
+            exp_option.append(option)
+
+        return self.execute_command("EXPIREAT", name, when, *exp_option)
 
     def get(self, name: KeyT) -> ResponseT:
         """

tests/test_commands.py

@@ -1059,6 +1059,43 @@ def test_expireat_unixtime(self, r):
         assert r.expireat("a", expire_at_seconds) is True
         assert 0 < r.ttl("a") <= 61
 
+    @skip_if_server_version_lt("7.0.0")
+    def test_expireat_option_nx(self, r):
+        assert r.set("key", "val") is True
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=1)
+        assert r.expireat("key", expire_at, "NX") is True
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=2)
+        assert r.expireat("key", expire_at, "NX") is False
+
+    @skip_if_server_version_lt("7.0.0")
+    def test_expireat_option_xx(self, r):
+        assert r.set("key", "val") is True
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=1)
+        assert r.expireat("key", expire_at, "XX") is False
+        assert r.expireat("key", expire_at) is True
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=2)
+        assert r.expireat("key", expire_at, "XX") is True
+
+    @skip_if_server_version_lt("7.0.0")
+    def test_expireat_option_gt(self, r):
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=2)
+        assert r.set("key", "val") is True
+        assert r.expireat("key", expire_at) is True
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=1)
+        assert r.expireat("key", expire_at, "GT") is False
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=3)
+        assert r.expireat("key", expire_at, "GT") is True
+
+    @skip_if_server_version_lt("7.0.0")
+    def test_expireat_option_lt(self, r):
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=2)
+        assert r.set("key", "val") is True
+        assert r.expireat("key", expire_at) is True
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=3)
+        assert r.expireat("key", expire_at, "LT") is False
+        expire_at = redis_server_time(r) + datetime.timedelta(minutes=1)
+        assert r.expireat("key", expire_at, "LT") is True
+
     def test_get_and_set(self, r):
         # get and set can't be tested independently of each other
         assert r.get("a") is None