redis-dict 3.0.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

redis_dict/core.py

@@ -35,13 +35,6 @@ class RedisDict:
     This functionality enables various use cases, such as managing encrypted data in Redis,
     To implement this, simply create and register your custom encoding and decoding functions.
     By delegating serialization to redis-dict, reduce complexity and have simple code in the codebase.
-
-    Attributes:
-        decoding_registry (Dict[str, DecodeFuncType]): Mapping of decoding transformation functions based on type
-        encoding_registry (Dict[str, EncodeFuncType]): Mapping of encoding transformation functions based on type
-        namespace (str): A string used as a prefix for Redis keys to separate data in different namespaces.
-        expire (Union[int, None]): An optional expiration time for keys, in seconds.
-
     """
 
     encoding_registry: EncodeType = enc_reg
@@ -53,7 +46,8 @@ class RedisDict:
                  preserve_expiration: Optional[bool] = False,
                  redis: "Optional[StrictRedis[Any]]" = None,
                  **redis_kwargs: Any) -> None:
-        """Initialize a RedisDict instance.
+        """
+        Initialize a RedisDict instance.
 
         Init the RedisDict instance.
 
@@ -220,7 +214,8 @@ class RedisDict:
             encoding_method_name: Optional[str] = None,
             decoding_method_name: Optional[str] = None,
     ) -> None:
-        """Extend RedisDict to support a custom type in the encode/decode mapping.
+        """
+        Extend RedisDict to support a custom type in the encode/decode mapping.
 
         This method enables serialization of instances based on their type,
         allowing for custom types, specialized storage formats, and more.
@@ -247,19 +242,19 @@ class RedisDict:
         attributes of the RedisDict instance
 
         Example:
-            class Person:
-                def __init__(self, name, age):
-                    self.name = name
-                    self.age = age
-
-                def encode(self) -> str:
-                    return json.dumps(self.__dict__)
-
-                @classmethod
-                def decode(cls, encoded_str: str) -> 'Person':
-                    return cls(**json.loads(encoded_str))
-
-            redis_dict.extends_type(Person)
+            >>> class Person:
+            ...     def __init__(self, name, age):
+            ...         self.name = name
+            ...         self.age = age
+            ...
+            ...     def encode(self) -> str:
+            ...         return json.dumps(self.__dict__)
+            ...
+            ...     @classmethod
+            ...     def decode(cls, encoded_str: str) -> 'Person':
+            ...         return cls(**json.loads(encoded_str))
+            ...
+            >>> redis_dict.extends_type(Person)
 
         Args:
             class_type (type): The class `__name__` will become the key for the encoding and decoding functions.
@@ -409,8 +404,8 @@ class RedisDict:
         return str(self.to_dict())
 
     def __or__(self, other: Dict[str, Any]) -> Dict[str, Any]:
-        """
-        Implements the | operator (dict union).
+        """Implement the | operator (dict union).
+
         Returns a new dictionary with items from both dictionaries.
 
         Args:
@@ -432,7 +427,8 @@ class RedisDict:
 
     def __ror__(self, other: Dict[str, Any]) -> Dict[str, Any]:
         """
-        Implements the reverse | operator.
+        Implement the reverse | operator.
+
         Called when RedisDict is on the right side of |.
 
         Args:
@@ -454,7 +450,8 @@ class RedisDict:
 
     def __ior__(self, other: Dict[str, Any]) -> 'RedisDict':
         """
-        Implements the |= operator (in-place union).
+        Implement the |= operator (in-place union).
+
         Modifies the current dictionary by adding items from other.
 
         Args:
@@ -475,7 +472,7 @@ class RedisDict:
     @classmethod
     def __class_getitem__(cls: Type['RedisDict'], key: Any) -> Type['RedisDict']:
         """
-        Enables type hinting support like RedisDict[str, Any].
+        Enable type hinting support like RedisDict[str, Any].
 
         Args:
             key (Any): The type parameter(s) used in the type hint.
@@ -487,7 +484,8 @@ class RedisDict:
 
     def __reversed__(self) -> Iterator[str]:
         """
-        Implements reversed() built-in:
+        Implement reversed() built-in.
+
         Returns an iterator over dictionary keys in reverse insertion order.
 
         Warning:

redis_dict/type_management.py

@@ -143,7 +143,8 @@ encoding_registry: EncodeType = {
 
 
 class RedisDictJSONEncoder(json.JSONEncoder):
-    """Extends JSON encoding capabilities by reusing RedisDict type conversion.
+    """
+    Extends JSON encoding capabilities by reusing RedisDict type conversion.
 
     Uses existing decoding_registry to know which types to handle specially and
     encoding_registry (falls back to str) for converting to JSON-compatible formats.
@@ -157,11 +158,11 @@ class RedisDictJSONEncoder(json.JSONEncoder):
             }
 
     Notes:
-
         Uses decoding_registry (containing all supported types) to check if type
         needs special handling. For encoding, defaults to str() if no encoder exists
         in encoding_registry.
     """
+
     def default(self, o: Any) -> Any:
         """Overwrite default from json encoder.
 
@@ -187,13 +188,15 @@ class RedisDictJSONEncoder(json.JSONEncoder):
 
 
 class RedisDictJSONDecoder(json.JSONDecoder):
-    """JSON decoder leveraging RedisDict existing type conversion system.
+    """
+    JSON decoder leveraging RedisDict existing type conversion system.
 
     Works with RedisDictJSONEncoder to reconstruct Python objects from JSON using
     RedisDict decoding_registry.
 
     Still needs work but allows for more types than without.
     """
+
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         """
         Overwrite the __init__ method from JSON decoder.
@@ -254,7 +257,7 @@ def _default_decoder(x: str) -> str:
 
 def _default_encoder(x: Any) -> str:
     """
-    Takes x and returns the result str of the object.
+    Take x and returns the result str of the object.
 
     Args:
         x (Any): The input object

{redis_dict-3.0.0.dist-info → redis_dict-3.1.0.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: redis-dict
-Version: 3.0.0
+Version: 3.1.0
 Summary: Dictionary with Redis as storage backend
 Author-email: Melvin Bijman <bijman.m.m@gmail.com>
 License: MIT
 Project-URL: Homepage, https://github.com/Attumm/redisdict
-Project-URL: Documentation, https://github.com/Attumm/redisdict#readme
+Project-URL: Documentation, https://attumm.github.io/redis-dict/
 Project-URL: Repository, https://github.com/Attumm/redisdict.git
 Project-URL: Changelog, https://github.com/Attumm/redisdict/releases
 Keywords: redis,python,dictionary,dict,key-value,database,caching,distributed-computing,dictionary-interface,large-datasets,scientific-computing,data-persistence,high-performance,scalable,pipelining,batching,big-data,data-types,distributed-algorithms,encryption,data-management

redis_dict-3.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+redis_dict/__init__.py,sha256=fksonUr5DetzwFDEkT7lpmAaV3Jhmp2IQ12t62LwFb4,476
+redis_dict/core.py,sha256=ej7_EfkPIIb0gH_Ndpeue4i-WsNFGuw0dV6fNm-drzY,34352
+redis_dict/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+redis_dict/type_management.py,sha256=ruyqswKqfte_G-ClTlV6ZuTmrTVkSsHFCy9LEdgblac,7700
+redis_dict-3.1.0.dist-info/LICENSE,sha256=-QiLwYznh_vNUSz337k0faP9Jl0dgtCIHVZ39Uyl6cA,1070
+redis_dict-3.1.0.dist-info/METADATA,sha256=wq3vcKRqTgUllyhm8oEogx9ikHCa6UT4kLNw86bfm3c,16867
+redis_dict-3.1.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+redis_dict-3.1.0.dist-info/top_level.txt,sha256=Wyp5Xvq_imoxvu-c-Le1rbTZ3pYM5BF440H9YAcgBZ8,11
+redis_dict-3.1.0.dist-info/RECORD,,

redis_dict-3.0.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-redis_dict/__init__.py,sha256=fksonUr5DetzwFDEkT7lpmAaV3Jhmp2IQ12t62LwFb4,476
-redis_dict/core.py,sha256=iLVTzpR4HmMPqcgZQWMgdAgwRepLEhTbdxP-tfA13ts,34698
-redis_dict/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-redis_dict/type_management.py,sha256=U3aP_EtHByApRdHvpr-zSOjok6r9BVZ0g3YnpVCVt8Y,7690
-redis_dict-3.0.0.dist-info/LICENSE,sha256=-QiLwYznh_vNUSz337k0faP9Jl0dgtCIHVZ39Uyl6cA,1070
-redis_dict-3.0.0.dist-info/METADATA,sha256=8Zn6a75THLjxiCGfRdFuz675RwSsLrBf0JQE8fH-Kfo,16873
-redis_dict-3.0.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-redis_dict-3.0.0.dist-info/top_level.txt,sha256=Wyp5Xvq_imoxvu-c-Le1rbTZ3pYM5BF440H9YAcgBZ8,11
-redis_dict-3.0.0.dist-info/RECORD,,