redis-dict 2.4.1__tar.gz → 2.5.1__tar.gz

{redis dict-2.4.1 → redis dict-2.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: redis dict
-Version: 2.4.1
+Version: 2.5.1
 Summary: Dictionary with Redis as storage backend
 Home-page: https://github.com/Attumm/redisdict
 Author: Melvin Bijman
@@ -18,12 +18,14 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: redis
 
 # Redis-dict
-[![Build Status](https://travis-ci.com/Attumm/redis-dict.svg?branch=main)](https://travis-ci.com/Attumm/redis-dict)
+[![CI](https://github.com/Attumm/redis-dict/actions/workflows/ci.yml/badge.svg)](https://github.com/Attumm/redis-dict/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/Attumm/redis-dict/graph/badge.svg?token=Lqs7McQGEs)](https://codecov.io/gh/Attumm/redis-dict)
 [![Downloads](https://static.pepy.tech/badge/redis-dict/month)](https://pepy.tech/project/redis-dict)
 
 RedisDict is a Python library that provides a convenient and familiar interface for interacting with Redis as if it were a Python dictionary. This simple yet powerful library enables you to manage key-value pairs in Redis using native Python syntax. It supports various data types, including strings, integers, floats, booleans, lists, and dictionaries, and includes additional utility functions for more complex use cases.
@@ -128,6 +130,8 @@ with dic.pipeline():
 You can use RedisDict for distributed computing by starting multiple RedisDict instances on different servers or instances that have access to the same Redis instance:
 ```python
 # On server 1
+from redis_dict import RedisDict
+
 dic = RedisDict(namespace="example")
 dic["foo"] = "bar"
 
@@ -227,7 +231,7 @@ print(dic["d"])  # Output: 4
 ```
 
 ### Additional Examples
-For more advanced examples of RedisDict, please refer to the unit-test files in the repository. All features and functionalities are thoroughly tested in [unit tests (here)](https://github.com/Attumm/redis-dict/blob/main/tests.py#L1) Or take a look at load test for batching [load test](https://github.com/Attumm/redis-dict/blob/main/load_test.py.py#L1).
+For more advanced examples of RedisDict, please refer to the unit-test files in the repository. All features and functionalities are thoroughly tested in [unit tests (here)](https://github.com/Attumm/redis-dict/blob/main/tests.py#L1) Or take a look at load test for batching [load test](https://github.com/Attumm/redis-dict/blob/main/load_test.py#L1).
 The unit-tests can be as used as a starting point.
 
 ### Redis Encryption

{redis dict-2.4.1 → redis dict-2.5.1}/README.md

@@ -1,5 +1,6 @@
 # Redis-dict
-[![Build Status](https://travis-ci.com/Attumm/redis-dict.svg?branch=main)](https://travis-ci.com/Attumm/redis-dict)
+[![CI](https://github.com/Attumm/redis-dict/actions/workflows/ci.yml/badge.svg)](https://github.com/Attumm/redis-dict/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/Attumm/redis-dict/graph/badge.svg?token=Lqs7McQGEs)](https://codecov.io/gh/Attumm/redis-dict)
 [![Downloads](https://static.pepy.tech/badge/redis-dict/month)](https://pepy.tech/project/redis-dict)
 
 RedisDict is a Python library that provides a convenient and familiar interface for interacting with Redis as if it were a Python dictionary. This simple yet powerful library enables you to manage key-value pairs in Redis using native Python syntax. It supports various data types, including strings, integers, floats, booleans, lists, and dictionaries, and includes additional utility functions for more complex use cases.
@@ -104,6 +105,8 @@ with dic.pipeline():
 You can use RedisDict for distributed computing by starting multiple RedisDict instances on different servers or instances that have access to the same Redis instance:
 ```python
 # On server 1
+from redis_dict import RedisDict
+
 dic = RedisDict(namespace="example")
 dic["foo"] = "bar"
 
@@ -203,7 +206,7 @@ print(dic["d"])  # Output: 4
 ```
 
 ### Additional Examples
-For more advanced examples of RedisDict, please refer to the unit-test files in the repository. All features and functionalities are thoroughly tested in [unit tests (here)](https://github.com/Attumm/redis-dict/blob/main/tests.py#L1) Or take a look at load test for batching [load test](https://github.com/Attumm/redis-dict/blob/main/load_test.py.py#L1).
+For more advanced examples of RedisDict, please refer to the unit-test files in the repository. All features and functionalities are thoroughly tested in [unit tests (here)](https://github.com/Attumm/redis-dict/blob/main/tests.py#L1) Or take a look at load test for batching [load test](https://github.com/Attumm/redis-dict/blob/main/load_test.py#L1).
 The unit-tests can be as used as a starting point.
 
 ### Redis Encryption

{redis dict-2.4.1 → redis dict-2.5.1}/redis_dict.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: redis-dict
-Version: 2.4.1
+Version: 2.5.1
 Summary: Dictionary with Redis as storage backend
 Home-page: https://github.com/Attumm/redisdict
 Author: Melvin Bijman
@@ -18,12 +18,14 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: redis
 
 # Redis-dict
-[![Build Status](https://travis-ci.com/Attumm/redis-dict.svg?branch=main)](https://travis-ci.com/Attumm/redis-dict)
+[![CI](https://github.com/Attumm/redis-dict/actions/workflows/ci.yml/badge.svg)](https://github.com/Attumm/redis-dict/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/Attumm/redis-dict/graph/badge.svg?token=Lqs7McQGEs)](https://codecov.io/gh/Attumm/redis-dict)
 [![Downloads](https://static.pepy.tech/badge/redis-dict/month)](https://pepy.tech/project/redis-dict)
 
 RedisDict is a Python library that provides a convenient and familiar interface for interacting with Redis as if it were a Python dictionary. This simple yet powerful library enables you to manage key-value pairs in Redis using native Python syntax. It supports various data types, including strings, integers, floats, booleans, lists, and dictionaries, and includes additional utility functions for more complex use cases.
@@ -128,6 +130,8 @@ with dic.pipeline():
 You can use RedisDict for distributed computing by starting multiple RedisDict instances on different servers or instances that have access to the same Redis instance:
 ```python
 # On server 1
+from redis_dict import RedisDict
+
 dic = RedisDict(namespace="example")
 dic["foo"] = "bar"
 
@@ -227,7 +231,7 @@ print(dic["d"])  # Output: 4
 ```
 
 ### Additional Examples
-For more advanced examples of RedisDict, please refer to the unit-test files in the repository. All features and functionalities are thoroughly tested in [unit tests (here)](https://github.com/Attumm/redis-dict/blob/main/tests.py#L1) Or take a look at load test for batching [load test](https://github.com/Attumm/redis-dict/blob/main/load_test.py.py#L1).
+For more advanced examples of RedisDict, please refer to the unit-test files in the repository. All features and functionalities are thoroughly tested in [unit tests (here)](https://github.com/Attumm/redis-dict/blob/main/tests.py#L1) Or take a look at load test for batching [load test](https://github.com/Attumm/redis-dict/blob/main/load_test.py#L1).
 The unit-tests can be as used as a starting point.
 
 ### Redis Encryption

{redis dict-2.4.1 → redis dict-2.5.1}/redis_dict.py

@@ -7,7 +7,6 @@ from contextlib import contextmanager
 
 SENTINEL = object()
 
-
 transform_type = Dict[str, Callable[[str], Any]]
 pre_transform_type = Dict[str, Callable[[Any], str]]
 
@@ -132,7 +131,7 @@ class RedisDict:
         Args:
             namespace (str, optional): A prefix for keys stored in Redis.
             expire (int, timedelta, optional): Expiration time for keys in seconds.
-            preserve_expiration (bool, optional): Whether or not to preserve the expiration.
+            preserve_expiration (bool, optional): Preserve the expiration count when the key is updated.
             **redis_kwargs: Additional keyword arguments passed to StrictRedis.
         """
         self.temp_redis: Optional[StrictRedis[Any]] = None
@@ -234,7 +233,7 @@ class RedisDict:
         """
         self.transform[k] = v
 
-    def __cmp__(self, other: Any) -> int:
+    def __eq__(self, other: Any) -> bool:
         """
         Compare the current RedisDict with another object.
 
@@ -242,22 +241,26 @@ class RedisDict:
             other (Any): The object to compare with.
 
         Returns:
-            int: 1 if equal, -1 otherwise.
-        Note:
-            TODO add the following methods
-            __lt__(self, other)
-            __le__(self, other)
-            __eq__(self, other)
-            __ne__(self, other)
-            __gt__(self, other)
-            __ge__(self, other)
+            bool: True if equal, False otherwise
         """
         if len(self) != len(other):
-            return -1
+            return False
         for key, value in self.iteritems():
             if value != other.get(key, SENTINEL):
-                return -1
-        return 1
+                return False
+        return True
+
+    def __ne__(self, other: Any) -> bool:
+        """
+        Compare the current RedisDict with another object.
+
+        Args:
+            other (Any): The object to compare with.
+
+        Returns:
+            bool: False if equal, True otherwise
+        """
+        return not self.__eq__(other)
 
     def __getitem__(self, item: str) -> Any:
         """
@@ -400,14 +403,14 @@ class RedisDict:
 
     def iterkeys(self) -> Iterator[str]:
         """
-            Note: for pythone2 str is needed
+            Note: for python2 str is needed
         """
         to_rm = len(self.namespace) + 1
         return (str(item[to_rm:]) for item in self._scan_keys())
 
     def key(self, search_term: str = '') -> Optional[str]:
         """
-        Note: for pythone2 str is needed
+        Note: for python2 str is needed
         """
         to_rm = len(self.namespace) + 1
         cursor, data = self.get_redis.scan(match='{}:{}{}'.format(self.namespace, search_term, '*'), count=1)
@@ -427,7 +430,7 @@ class RedisDict:
 
     def iteritems(self) -> Iterator[Tuple[str, Any]]:
         """
-        Note: for pythone2 str is needed
+        Note: for python2 str is needed
         """
         to_rm = len(self.namespace) + 1
         for item in self._scan_keys():
@@ -543,7 +546,7 @@ class RedisDict:
 
         Args:
             key (str): The key to retrieve the value.
-            default (Optional[Any], optional): The value to set if the key is not found.
+            default_value (Optional[Any], optional): The value to set if the key is not found.
 
         Returns:
             Any: The value associated with the key or the default value.
@@ -572,7 +575,7 @@ class RedisDict:
         Update the RedisDict with key-value pairs from the given mapping, analogous to a dictionary's update method.
 
         Args:
-            other (Mapping[str, Any]): A mapping containing key-value pairs to update the RedisDict.
+            dic (Mapping[str, Any]): A mapping containing key-value pairs to update the RedisDict.
         """
         with self.pipeline():
             for key, value in dic.items():
@@ -639,8 +642,10 @@ class RedisDict:
         """
         return self.__delitem__(':'.join(iterable))
 
+    #  def expire_at(self, sec_epoch: int | timedelta) -> Iterator[None]:
+    #  compatibility with Python 3.9 typing
     @contextmanager
-    def expire_at(self, sec_epoch: int | timedelta) -> Iterator[None]:
+    def expire_at(self, sec_epoch: Union[int, timedelta]) -> Iterator[None]:
         """
         Context manager to set the expiration time for keys in the RedisDict.
 
@@ -741,13 +746,13 @@ class RedisDict:
     def get_ttl(self, key: str) -> Optional[int]:
         """
         Get the Time To Live (TTL) in seconds for a given key. If the key does not exist or does not have an
-        associated expire, return None.
+        associated `expire`, return None.
 
         Args:
             key (str): The key for which to get the TTL.
 
         Returns:
-            Optional[int]: The TTL in seconds if the key exists and has an expire set; otherwise, None.
+            Optional[int]: The TTL in seconds if the key exists and has an expiry set; otherwise, None.
         """
         val = self.redis.ttl(self._format_key(key))
         if val < 0:

{redis dict-2.4.1 → redis dict-2.5.1}/setup.py

@@ -17,7 +17,7 @@ setup(
     long_description=long_description,
     long_description_content_type='text/markdown',
 
-    version='2.4.1',
+    version='2.5.1',
     py_modules=['redis_dict'],
     install_requires=['redis',],
     license='MIT',
@@ -41,6 +41,6 @@ setup(
         'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: 3.10',
         'Programming Language :: Python :: 3.11',
+        'Programming Language :: Python :: 3.12',
     ],
 )
-