redis-dict 2.5.0__py3-none-any.whl → 2.5.1__py3-none-any.whl

{redis_dict-2.5.0.dist-info → redis_dict-2.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: redis-dict
-Version: 2.5.0
+Version: 2.5.1
 Summary: Dictionary with Redis as storage backend
 Home-page: https://github.com/Attumm/redisdict
 Author: Melvin Bijman
@@ -24,7 +24,8 @@ 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.
@@ -230,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.5.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+redis_dict.py,sha256=ZQSg6bCaV_Ho18x7CtjYgD0kakFeskn3TfJzR3e0I28,25677
+redis_dict-2.5.1.dist-info/LICENSE,sha256=-QiLwYznh_vNUSz337k0faP9Jl0dgtCIHVZ39Uyl6cA,1070
+redis_dict-2.5.1.dist-info/METADATA,sha256=dKyus34pm_rQ-icVu7L53N_QzMSaxbLWhKuVSTh7RfI,10000
+redis_dict-2.5.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+redis_dict-2.5.1.dist-info/top_level.txt,sha256=Wyp5Xvq_imoxvu-c-Le1rbTZ3pYM5BF440H9YAcgBZ8,11
+redis_dict-2.5.1.dist-info/RECORD,,

{redis_dict-2.5.0.dist-info → redis_dict-2.5.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: setuptools (75.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

redis_dict.py

@@ -131,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
@@ -403,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)
@@ -546,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.
@@ -575,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():
@@ -746,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.5.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-redis_dict.py,sha256=xB36Vby3FIIuSoRSqfTT1XuVXi-ZpQPHmUQoUf_HOTg,25661
-redis_dict-2.5.0.dist-info/LICENSE,sha256=-QiLwYznh_vNUSz337k0faP9Jl0dgtCIHVZ39Uyl6cA,1070
-redis_dict-2.5.0.dist-info/METADATA,sha256=e0bB_4MTF5C7lHFt0eRPqBRB2QocOJjmNDs80gaur7w,9847
-redis_dict-2.5.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-redis_dict-2.5.0.dist-info/top_level.txt,sha256=Wyp5Xvq_imoxvu-c-Le1rbTZ3pYM5BF440H9YAcgBZ8,11
-redis_dict-2.5.0.dist-info/RECORD,,