python: Update ExpiryType enum references in hash field expiration docs

affonsov · affonsov · commit 0c7f3b48d5ab · 2025-09-10T14:39:31.000-07:00
Replace deprecated ExpiryType enum values with new names in docstrings:
- EX → SEC
- PX → MILLSEC
- EXAT → UNIX_SEC
- PXAT → UNIX_MILLSEC
- KEEPTTL → KEEP_TTL

Updates documentation for hash field expiration commands in both async and sync clients.

Signed-off-by: affonsov &lt;67347924+affonsov@users.noreply.github.com&gt;
diff --git a/python/glide-async/python/glide/async_commands/core.py b/python/glide-async/python/glide/async_commands/core.py
@@ -1120,7 +1120,7 @@ async def httl(self, key: TEncodable, fields: List[TEncodable]) -> List[int]:
             - `-2`: field does not exist or key does not exist
 
         Examples:
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> await client.httl("my_hash", ["field1", "field2", "non_existent_field"])
                 [9, 9, -2]  # field1 and field2 have ~9 seconds left, non_existent_field doesn't exist
 
@@ -1150,7 +1150,7 @@ async def hpttl(self, key: TEncodable, fields: List[TEncodable]) -> List[int]:
             - `-2`: field does not exist or key does not exist
 
         Examples:
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.PX, 10000))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.MILLSEC, 10000))
             >>> await client.hpttl("my_hash", ["field1", "field2", "non_existent_field"])
                 [9500, 9500, -2]  # field1 and field2 have ~9500 milliseconds left, non_existent_field doesn't exist
 
@@ -1182,7 +1182,7 @@ async def hexpiretime(self, key: TEncodable, fields: List[TEncodable]) -> List[i
         Examples:
             >>> import time
             >>> future_timestamp = int(time.time()) + 60  # 60 seconds from now
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EXAT, future_timestamp))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.UNIX_SEC, future_timestamp))
             >>> await client.hexpiretime("my_hash", ["field1", "field2", "non_existent_field"])
                 [future_timestamp, future_timestamp, -2]  # field1 and field2 expire at future_timestamp, non_existent_field doesn't exist
 
@@ -1216,7 +1216,7 @@ async def hpexpiretime(
         Examples:
             >>> import time
             >>> future_timestamp_ms = int(time.time() * 1000) + 60000  # 60 seconds from now in milliseconds
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.PXAT, future_timestamp_ms))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.UNIX_MILLSEC, future_timestamp_ms))
             >>> await client.hpexpiretime("my_hash", ["field1", "field2", "non_existent_field"])
                 [future_timestamp_ms, future_timestamp_ms, -2]  # field1 and field2 expire at future_timestamp_ms, non_existent_field doesn't exist
 
@@ -1249,17 +1249,17 @@ async def hsetex(
                 - ONLY_IF_ALL_EXIST (FXX): Only set fields if all of them already exist.
                 - ONLY_IF_NONE_EXIST (FNX): Only set fields if none of them already exist.
             expiry (Optional[ExpirySet]): Expiration options for the fields:
-                - EX: Expiration time in seconds.
-                - PX: Expiration time in milliseconds.
-                - EXAT: Absolute expiration time in seconds (Unix timestamp).
-                - PXAT: Absolute expiration time in milliseconds (Unix timestamp).
-                - KEEPTTL: Retain existing TTL.
+                - SEC (EX): Expiration time in seconds.
+                - MILLSEC (PX): Expiration time in milliseconds.
+                - UNIX_SEC (EXAT): Absolute expiration time in seconds (Unix timestamp).
+                - UNIX_MILLSEC (PXAT): Absolute expiration time in milliseconds (Unix timestamp).
+                - KEEP_TTL (KEEPTTL): Retain existing TTL.
 
         Returns:
             int: 1 if all fields were set successfully, 0 if none were set due to conditional constraints.
 
         Examples:
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
                 1  # All fields set with 10 second expiration
             >>> await client.hsetex("my_hash", {"field3": "value3"}, field_conditional_change=HashFieldConditionalChange.ONLY_IF_ALL_EXIST)
                 1  # Field set because field already exists
@@ -1305,10 +1305,10 @@ async def hgetex(
             key (TEncodable): The key of the hash.
             fields (List[TEncodable]): The list of fields to retrieve from the hash.
             expiry (Optional[ExpiryGetEx]): Expiration options for the retrieved fields:
-                - EX: Expiration time in seconds.
-                - PX: Expiration time in milliseconds.
-                - EXAT: Absolute expiration time in seconds (Unix timestamp).
-                - PXAT: Absolute expiration time in milliseconds (Unix timestamp).
+                - SEC (EX): Expiration time in seconds.
+                - MILLSEC (PX): Expiration time in milliseconds.
+                - UNIX_SEC (EXAT): Absolute expiration time in seconds (Unix timestamp).
+                - UNIX_MILLSEC (PXAT): Absolute expiration time in milliseconds (Unix timestamp).
                 - PERSIST: Remove expiration from the fields.
 
         Returns:
@@ -1317,10 +1317,10 @@ async def hgetex(
             If `key` does not exist, it is treated as an empty hash, and the function returns a list of null values.
 
         Examples:
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> await client.hgetex("my_hash", ["field1", "field2"])
                 [b"value1", b"value2"]
-            >>> await client.hgetex("my_hash", ["field1"], expiry=ExpiryGetEx(ExpiryTypeGetEx.EX, 20))
+            >>> await client.hgetex("my_hash", ["field1"], expiry=ExpiryGetEx(ExpiryTypeGetEx.SEC, 20))
                 [b"value1"]  # field1 now has 20 second expiration
             >>> await client.hgetex("my_hash", ["field1"], expiry=ExpiryGetEx(ExpiryTypeGetEx.PERSIST, None))
                 [b"value1"]  # field1 expiration removed
@@ -1374,7 +1374,7 @@ async def hexpire(
             - `2`: Field was deleted immediately (when seconds is 0 or timestamp is in the past).
 
         Examples:
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> await client.hexpire("my_hash", 20, ["field1", "field2"])
                 [1, 1]  # Both fields' expiration set to 20 seconds
             >>> await client.hexpire("my_hash", 30, ["field1"], option=ExpireOptions.NewExpiryGreaterThanCurrent)
@@ -1420,7 +1420,7 @@ async def hpersist(self, key: TEncodable, fields: List[TEncodable]) -> List[int]
             - `-2`: Field does not exist or key does not exist.
 
         Examples:
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> await client.hpersist("my_hash", ["field1", "field2"])
                 [1, 1]  # Both fields made persistent
             >>> await client.hpersist("my_hash", ["field1"])
@@ -1467,7 +1467,7 @@ async def hpexpire(
             - `2`: Field was deleted immediately (when milliseconds is 0 or timestamp is in the past).
 
         Examples:
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.PX, 10000))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.MILLSEC, 10000))
             >>> await client.hpexpire("my_hash", 20000, ["field1", "field2"])
                 [1, 1]  # Both fields' expiration set to 20000 milliseconds
             >>> await client.hpexpire("my_hash", 30000, ["field1"], option=ExpireOptions.NewExpiryGreaterThanCurrent)
@@ -1528,7 +1528,7 @@ async def hexpireat(
         Examples:
             >>> import time
             >>> future_timestamp = int(time.time()) + 60  # 60 seconds from now
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> await client.hexpireat("my_hash", future_timestamp, ["field1", "field2"])
                 [1, 1]  # Both fields' expiration set to future_timestamp
             >>> past_timestamp = int(time.time()) - 60  # 60 seconds ago
@@ -1588,7 +1588,7 @@ async def hpexpireat(
         Examples:
             >>> import time
             >>> future_timestamp_ms = int(time.time() * 1000) + 60000  # 60 seconds from now in milliseconds
-            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.PX, 10000))
+            >>> await client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.MILLSEC, 10000))
             >>> await client.hpexpireat("my_hash", future_timestamp_ms, ["field1", "field2"])
                 [1, 1]  # Both fields' expiration set to future_timestamp_ms
             >>> past_timestamp_ms = int(time.time() * 1000) - 60000  # 60 seconds ago in milliseconds
diff --git a/python/glide-sync/glide_sync/sync_commands/core.py b/python/glide-sync/glide_sync/sync_commands/core.py
@@ -1085,7 +1085,7 @@ def httl(self, key: TEncodable, fields: List[TEncodable]) -> List[int]:
             - `-2`: field does not exist or key does not exist
 
         Examples:
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> client.httl("my_hash", ["field1", "field2", "non_existent_field"])
                 [9, 9, -2]  # field1 and field2 have ~9 seconds left, non_existent_field doesn't exist
 
@@ -1115,7 +1115,7 @@ def hpttl(self, key: TEncodable, fields: List[TEncodable]) -> List[int]:
             - `-2`: field does not exist or key does not exist
 
         Examples:
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.PX, 10000))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.MILLSEC, 10000))
             >>> client.hpttl("my_hash", ["field1", "field2", "non_existent_field"])
                 [9500, 9500, -2]  # field1 and field2 have ~9500 milliseconds left, non_existent_field doesn't exist
 
@@ -1147,7 +1147,7 @@ def hexpiretime(self, key: TEncodable, fields: List[TEncodable]) -> List[int]:
         Examples:
             >>> import time
             >>> future_timestamp = int(time.time()) + 60  # 60 seconds from now
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EXAT, future_timestamp))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.UNIX_SEC, future_timestamp))
             >>> client.hexpiretime("my_hash", ["field1", "field2", "non_existent_field"])
                 [future_timestamp, future_timestamp, -2]  # field1 and field2 expire at future_timestamp, non_existent_field doesn't exist
 
@@ -1179,7 +1179,7 @@ def hpexpiretime(self, key: TEncodable, fields: List[TEncodable]) -> List[int]:
         Examples:
             >>> import time
             >>> future_timestamp_ms = int(time.time() * 1000) + 60000  # 60 seconds from now in milliseconds
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.PXAT, future_timestamp_ms))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.UNIX_MILLSEC, future_timestamp_ms))
             >>> client.hpexpiretime("my_hash", ["field1", "field2", "non_existent_field"])
                 [future_timestamp_ms, future_timestamp_ms, -2]  # field1 and field2 expire at future_timestamp_ms, non_existent_field doesn't exist
 
@@ -1212,17 +1212,17 @@ def hsetex(
                 - ONLY_IF_ALL_EXIST (FXX): Only set fields if all of them already exist.
                 - ONLY_IF_NONE_EXIST (FNX): Only set fields if none of them already exist.
             expiry (Optional[ExpirySet]): Expiration options for the fields:
-                - EX: Expiration time in seconds.
-                - PX: Expiration time in milliseconds.
-                - EXAT: Absolute expiration time in seconds (Unix timestamp).
-                - PXAT: Absolute expiration time in milliseconds (Unix timestamp).
-                - KEEPTTL: Retain existing TTL.
+                - SEC (EX): Expiration time in seconds.
+                - MILLSEC (PX): Expiration time in milliseconds.
+                - UNIX_SEC (EXAT): Absolute expiration time in seconds (Unix timestamp).
+                - UNIX_MILLSEC (PXAT): Absolute expiration time in milliseconds (Unix timestamp).
+                - KEEP_TTL (KEEPTTL): Retain existing TTL.
 
         Returns:
             int: 1 if all fields were set successfully, 0 if none were set due to conditional constraints.
 
         Examples:
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
                 1  # All fields set with 10 second expiration
             >>> client.hsetex("my_hash", {"field3": "value3"}, field_conditional_change=HashFieldConditionalChange.ONLY_IF_ALL_EXIST)
                 1  # Field set because field already exists
@@ -1268,10 +1268,10 @@ def hgetex(
             key (TEncodable): The key of the hash.
             fields (List[TEncodable]): The list of fields to retrieve from the hash.
             expiry (Optional[ExpiryGetEx]): Expiration options for the retrieved fields:
-                - EX: Expiration time in seconds.
-                - PX: Expiration time in milliseconds.
-                - EXAT: Absolute expiration time in seconds (Unix timestamp).
-                - PXAT: Absolute expiration time in milliseconds (Unix timestamp).
+                - SEC (EX): Expiration time in seconds.
+                - MILLSEC (PX): Expiration time in milliseconds.
+                - UNIX_SEC (EXAT): Absolute expiration time in seconds (Unix timestamp).
+                - UNIX_MILLSEC (PXAT): Absolute expiration time in milliseconds (Unix timestamp).
                 - PERSIST: Remove expiration from the fields.
 
         Returns:
@@ -1280,10 +1280,10 @@ def hgetex(
             If `key` does not exist, it is treated as an empty hash, and the function returns a list of null values.
 
         Examples:
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> client.hgetex("my_hash", ["field1", "field2"])
                 [b"value1", b"value2"]
-            >>> client.hgetex("my_hash", ["field1"], expiry=ExpiryGetEx(ExpiryTypeGetEx.EX, 20))
+            >>> client.hgetex("my_hash", ["field1"], expiry=ExpiryGetEx(ExpiryTypeGetEx.SEC, 20))
                 [b"value1"]  # field1 now has 20 second expiration
             >>> client.hgetex("my_hash", ["field1"], expiry=ExpiryGetEx(ExpiryTypeGetEx.PERSIST, None))
                 [b"value1"]  # field1 expiration removed
@@ -1337,7 +1337,7 @@ def hexpire(
             - `2`: Field was deleted immediately (when seconds is 0 or timestamp is in the past).
 
         Examples:
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> client.hexpire("my_hash", 20, ["field1", "field2"])
                 [1, 1]  # Both fields' expiration set to 20 seconds
             >>> client.hexpire("my_hash", 30, ["field1"], option=ExpireOptions.NewExpiryGreaterThanCurrent)
@@ -1383,7 +1383,7 @@ def hpersist(self, key: TEncodable, fields: List[TEncodable]) -> List[int]:
             - `-2`: Field does not exist or key does not exist.
 
         Examples:
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> client.hpersist("my_hash", ["field1", "field2"])
                 [1, 1]  # Both fields made persistent
             >>> client.hpersist("my_hash", ["field1"])
@@ -1430,7 +1430,7 @@ def hpexpire(
             - `2`: Field was deleted immediately (when milliseconds is 0 or timestamp is in the past).
 
         Examples:
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.PX, 10000))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.MILLSEC, 10000))
             >>> client.hpexpire("my_hash", 20000, ["field1", "field2"])
                 [1, 1]  # Both fields' expiration set to 20000 milliseconds
             >>> client.hpexpire("my_hash", 30000, ["field1"], option=ExpireOptions.NewExpiryGreaterThanCurrent)
@@ -1491,7 +1491,7 @@ def hexpireat(
         Examples:
             >>> import time
             >>> future_timestamp = int(time.time()) + 60  # 60 seconds from now
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.EX, 10))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.SEC, 10))
             >>> client.hexpireat("my_hash", future_timestamp, ["field1", "field2"])
                 [1, 1]  # Both fields' expiration set to future_timestamp
             >>> past_timestamp = int(time.time()) - 60  # 60 seconds ago
@@ -1551,7 +1551,7 @@ def hpexpireat(
         Examples:
             >>> import time
             >>> future_timestamp_ms = int(time.time() * 1000) + 60000  # 60 seconds from now in milliseconds
-            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.PX, 10000))
+            >>> client.hsetex("my_hash", {"field1": "value1", "field2": "value2"}, expiry=ExpirySet(ExpiryType.MILLSEC, 10000))
             >>> client.hpexpireat("my_hash", future_timestamp_ms, ["field1", "field2"])
                 [1, 1]  # Both fields' expiration set to future_timestamp_ms
             >>> past_timestamp_ms = int(time.time() * 1000) - 60000  # 60 seconds ago in milliseconds
