redis-dict 2.7.0__tar.gz → 3.0.0__tar.gz

redis dict-2.7.0/redis_dict.egg-info/PKG-INFO → redis_dict-3.0.0/PKG-INFO

@@ -1,13 +1,14 @@
 Metadata-Version: 2.1
 Name: redis-dict
-Version: 2.7.0
+Version: 3.0.0
 Summary: Dictionary with Redis as storage backend
-Home-page: https://github.com/Attumm/redisdict
-Author: Melvin Bijman
-Author-email: bijman.m.m@gmail.com
+Author-email: Melvin Bijman <bijman.m.m@gmail.com>
 License: MIT
-Keywords: redis python dictionary dict key-value 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
-Platform: any
+Project-URL: Homepage, https://github.com/Attumm/redisdict
+Project-URL: Documentation, https://github.com/Attumm/redisdict#readme
+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
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Information Technology
@@ -21,18 +22,51 @@ Classifier: Topic :: Software Development :: Object Brokering
 Classifier: Topic :: Database :: Database Engines/Servers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
 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
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: redis
+Requires-Dist: redis>=4.0.0
+Provides-Extra: dev
+Requires-Dist: coverage==5.5; extra == "dev"
+Requires-Dist: hypothesis==6.70.1; extra == "dev"
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: mypy-extensions>=1.0.0; extra == "dev"
+Requires-Dist: types-pyOpenSSL>=24.0.0.0; extra == "dev"
+Requires-Dist: types-redis>=4.6.0; extra == "dev"
+Requires-Dist: typing_extensions>=4.5.0; extra == "dev"
+Requires-Dist: pylama>=8.4.1; extra == "dev"
+Requires-Dist: pycodestyle==2.10.0; extra == "dev"
+Requires-Dist: pydocstyle==6.3.0; extra == "dev"
+Requires-Dist: pyflakes==3.0.1; extra == "dev"
+Requires-Dist: pylint==3.2.7; extra == "dev"
+Requires-Dist: mccabe==0.7.0; extra == "dev"
+Requires-Dist: attrs==22.2.0; extra == "dev"
+Requires-Dist: cffi==1.15.1; extra == "dev"
+Requires-Dist: cryptography==43.0.1; extra == "dev"
+Requires-Dist: exceptiongroup==1.1.1; extra == "dev"
+Requires-Dist: future==0.18.3; extra == "dev"
+Requires-Dist: pycparser==2.21; extra == "dev"
+Requires-Dist: snowballstemmer==2.2.0; extra == "dev"
+Requires-Dist: sortedcontainers==2.4.0; extra == "dev"
+Requires-Dist: tomli==2.0.1; extra == "dev"
+Requires-Dist: setuptools>=68.0.0; extra == "dev"
+Requires-Dist: darglint; extra == "dev"
+Requires-Dist: pydocstyle; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Requires-Dist: tomli; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
 
 # Redis-dict
+[![PyPI](https://img.shields.io/pypi/v/redis-dict.svg)](https://pypi.org/project/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)
@@ -86,7 +120,6 @@ In Redis our example looks like this.
 
 ### Namespaces
 Acting as an identifier for your dictionary across different systems, RedisDict employs namespaces for organized data management. When a namespace isn't specified, "main" becomes the default. Thus allowing for data organization across systems and projects with the same redis instance.
-
 This approach also minimizes the risk of key collisions between different applications, preventing hard-to-debug issues. By leveraging namespaces, RedisDict ensures a cleaner and more maintainable data management experience for developers working on multiple projects.
 
 ## Advanced Features
@@ -135,7 +168,6 @@ dic['gone'] = 'gone in 5 seconds'
 Efficiently batch your requests using the Pipeline feature, which can be easily utilized with a context manager.
 
 ```python
-from redis_dict import RedisDict
 dic = RedisDict(namespace="example")
 
 # one round trip to redis
@@ -263,14 +295,11 @@ This approach optimizes Redis database performance and efficiency by ensuring th
 Following types are supported: 
 `str, int, float, bool, NoneType, list, dict, tuple, set, datetime, date, time, timedelta, Decimal, complex, bytes, UUID, OrderedDict, defaultdict, frozenset`
 ```python
-from redis_dict import RedisDict
-
 from uuid import UUID
 from decimal import Decimal
 from collections import OrderedDict, defaultdict
 from datetime import datetime, date, time, timedelta
 
-
 dic = RedisDict()
 
 dic["string"] = "Hello World"
@@ -299,6 +328,32 @@ dic["default"] = defaultdict(int, {'a': 1, 'b': 2})
 dic["frozen"] = frozenset([1, 2, 3])
 ```
 
+
+
+### Nested types
+Nested Types
+RedisDict supports nested structures with mixed types through JSON serialization. The feature works by utilizing JSON encoding and decoding under the hood. While this represents an upgrade in functionality, the feature is not fully implemented and should be used with caution. For optimal performance, using shallow dictionaries is recommended.
+```python
+from datetime import datetime, timedelta
+
+dic["mixed"] = [1, "foobar", 3.14, [1, 2, 3], datetime.now()]
+
+dic['dic'] = {"elapsed_time": timedelta(hours=60)}
+```
+
+### JSON Encoding - Decoding
+The nested type support in RedisDict is implemented using custom JSON encoders and decoders. These JSON encoders and decoders are built on top of RedisDict's own encoding and decoding functionality, extending it for JSON compatibility. Since JSON serialization was a frequently requested feature, these enhanced encoders and decoders are available for use in other projects:
+```python
+import json
+from datetime import datetime
+from redis_dict import RedisDictJSONDecoder, RedisDictJSONEncoder
+
+data = [1, "foobar", 3.14, [1, 2, 3], datetime.now()]
+encoded = json.dumps(data, cls=RedisDictJSONEncoder)
+result = json.loads(encoded, cls=RedisDictJSONDecoder)
+```
+
+
 ### Extending RedisDict with Custom Types
 
 RedisDict supports custom type serialization. Here's how to add a new type:
@@ -306,7 +361,6 @@ RedisDict supports custom type serialization. Here's how to add a new type:
 
 ```python
 import json
-from redis_dict import RedisDict
 
 class Person:
     def __init__(self, name, age):
@@ -335,23 +389,13 @@ assert result.name == person.name
 assert result.age == person.age
 ```
 
-```python
->>> from datetime import datetime
->>> redis_dict.extends_type(datetime, datetime.isoformat, datetime.fromisoformat)
->>> redis_dict["now"] = datetime.now()
->>> redis_dict
-{'now': datetime.datetime(2024, 10, 14, 18, 41, 53, 493775)}
->>> redis_dict["now"]
-datetime.datetime(2024, 10, 14, 18, 41, 53, 493775)
-```
-
-For more information on [extending types](https://github.com/Attumm/redis-dict/blob/main/extend_types_tests.py).
+For more information on [extending types](https://github.com/Attumm/redis-dict/blob/main/tests/unit/extend_types_tests.py).
 ### Redis Encryption
 Setup guide for configuring and utilizing encrypted Redis TLS for redis-dict.
-[Setup guide](https://github.com/Attumm/redis-dict/blob/main/encrypted_redis.MD)
+[Setup guide](https://github.com/Attumm/redis-dict/blob/main/docs/tutorials/encrypted_redis.MD)
 
 ### Redis Storage Encryption
-For storing encrypted data values, it's possible to use extended types. Take a look at this [encrypted test](https://github.com/Attumm/redis-dict/blob/main/encrypt_tests.py).
+For storing encrypted data values, it's possible to use extended types. Take a look at this [encrypted test](https://github.com/Attumm/redis-dict/blob/main/tests/unit/encrypt_tests.py).
 
 ### Tests
 The RedisDict library includes a comprehensive suite of tests that ensure its correctness and resilience. The test suite covers various data types, edge cases, and error handling scenarios. It also employs the Hypothesis library for property-based testing, which provides fuzz testing to evaluate the implementation
@@ -359,19 +403,16 @@ The RedisDict library includes a comprehensive suite of tests that ensure its co
 ### Redis config
 To configure RedisDict using your Redis config.
 
-Configure both the host and port.
+Configure both the host and port. Or configuration with a setting dictionary.
 ```python
 dic = RedisDict(host='127.0.0.1', port=6380)
-```
 
-Configuration with a dictionary.
-```python
 redis_config = {
     'host': '127.0.0.1',
     'port': 6380,
 }
 
-dic = RedisDict(**redis_config)
+confid_dic = RedisDict(**redis_config)
 ```
 
 ## Installation
@@ -382,4 +423,3 @@ pip install redis-dict
 ### Note
 * Please be aware that this project is currently being utilized by various organizations in their production environments. If you have any questions or concerns, feel free to raise issues
 * This project only uses redis as dependency
-

redis dict-2.7.0/README.md → redis_dict-3.0.0/README.md

@@ -1,4 +1,5 @@
 # Redis-dict
+[![PyPI](https://img.shields.io/pypi/v/redis-dict.svg)](https://pypi.org/project/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)
@@ -52,7 +53,6 @@ In Redis our example looks like this.
 
 ### Namespaces
 Acting as an identifier for your dictionary across different systems, RedisDict employs namespaces for organized data management. When a namespace isn't specified, "main" becomes the default. Thus allowing for data organization across systems and projects with the same redis instance.
-
 This approach also minimizes the risk of key collisions between different applications, preventing hard-to-debug issues. By leveraging namespaces, RedisDict ensures a cleaner and more maintainable data management experience for developers working on multiple projects.
 
 ## Advanced Features
@@ -101,7 +101,6 @@ dic['gone'] = 'gone in 5 seconds'
 Efficiently batch your requests using the Pipeline feature, which can be easily utilized with a context manager.
 
 ```python
-from redis_dict import RedisDict
 dic = RedisDict(namespace="example")
 
 # one round trip to redis
@@ -229,14 +228,11 @@ This approach optimizes Redis database performance and efficiency by ensuring th
 Following types are supported: 
 `str, int, float, bool, NoneType, list, dict, tuple, set, datetime, date, time, timedelta, Decimal, complex, bytes, UUID, OrderedDict, defaultdict, frozenset`
 ```python
-from redis_dict import RedisDict
-
 from uuid import UUID
 from decimal import Decimal
 from collections import OrderedDict, defaultdict
 from datetime import datetime, date, time, timedelta
 
-
 dic = RedisDict()
 
 dic["string"] = "Hello World"
@@ -265,6 +261,32 @@ dic["default"] = defaultdict(int, {'a': 1, 'b': 2})
 dic["frozen"] = frozenset([1, 2, 3])
 ```
 
+
+
+### Nested types
+Nested Types
+RedisDict supports nested structures with mixed types through JSON serialization. The feature works by utilizing JSON encoding and decoding under the hood. While this represents an upgrade in functionality, the feature is not fully implemented and should be used with caution. For optimal performance, using shallow dictionaries is recommended.
+```python
+from datetime import datetime, timedelta
+
+dic["mixed"] = [1, "foobar", 3.14, [1, 2, 3], datetime.now()]
+
+dic['dic'] = {"elapsed_time": timedelta(hours=60)}
+```
+
+### JSON Encoding - Decoding
+The nested type support in RedisDict is implemented using custom JSON encoders and decoders. These JSON encoders and decoders are built on top of RedisDict's own encoding and decoding functionality, extending it for JSON compatibility. Since JSON serialization was a frequently requested feature, these enhanced encoders and decoders are available for use in other projects:
+```python
+import json
+from datetime import datetime
+from redis_dict import RedisDictJSONDecoder, RedisDictJSONEncoder
+
+data = [1, "foobar", 3.14, [1, 2, 3], datetime.now()]
+encoded = json.dumps(data, cls=RedisDictJSONEncoder)
+result = json.loads(encoded, cls=RedisDictJSONDecoder)
+```
+
+
 ### Extending RedisDict with Custom Types
 
 RedisDict supports custom type serialization. Here's how to add a new type:
@@ -272,7 +294,6 @@ RedisDict supports custom type serialization. Here's how to add a new type:
 
 ```python
 import json
-from redis_dict import RedisDict
 
 class Person:
     def __init__(self, name, age):
@@ -301,23 +322,13 @@ assert result.name == person.name
 assert result.age == person.age
 ```
 
-```python
->>> from datetime import datetime
->>> redis_dict.extends_type(datetime, datetime.isoformat, datetime.fromisoformat)
->>> redis_dict["now"] = datetime.now()
->>> redis_dict
-{'now': datetime.datetime(2024, 10, 14, 18, 41, 53, 493775)}
->>> redis_dict["now"]
-datetime.datetime(2024, 10, 14, 18, 41, 53, 493775)
-```
-
-For more information on [extending types](https://github.com/Attumm/redis-dict/blob/main/extend_types_tests.py).
+For more information on [extending types](https://github.com/Attumm/redis-dict/blob/main/tests/unit/extend_types_tests.py).
 ### Redis Encryption
 Setup guide for configuring and utilizing encrypted Redis TLS for redis-dict.
-[Setup guide](https://github.com/Attumm/redis-dict/blob/main/encrypted_redis.MD)
+[Setup guide](https://github.com/Attumm/redis-dict/blob/main/docs/tutorials/encrypted_redis.MD)
 
 ### Redis Storage Encryption
-For storing encrypted data values, it's possible to use extended types. Take a look at this [encrypted test](https://github.com/Attumm/redis-dict/blob/main/encrypt_tests.py).
+For storing encrypted data values, it's possible to use extended types. Take a look at this [encrypted test](https://github.com/Attumm/redis-dict/blob/main/tests/unit/encrypt_tests.py).
 
 ### Tests
 The RedisDict library includes a comprehensive suite of tests that ensure its correctness and resilience. The test suite covers various data types, edge cases, and error handling scenarios. It also employs the Hypothesis library for property-based testing, which provides fuzz testing to evaluate the implementation
@@ -325,19 +336,16 @@ The RedisDict library includes a comprehensive suite of tests that ensure its co
 ### Redis config
 To configure RedisDict using your Redis config.
 
-Configure both the host and port.
+Configure both the host and port. Or configuration with a setting dictionary.
 ```python
 dic = RedisDict(host='127.0.0.1', port=6380)
-```
 
-Configuration with a dictionary.
-```python
 redis_config = {
     'host': '127.0.0.1',
     'port': 6380,
 }
 
-dic = RedisDict(**redis_config)
+confid_dic = RedisDict(**redis_config)
 ```
 
 ## Installation
@@ -348,4 +356,3 @@ pip install redis-dict
 ### Note
 * Please be aware that this project is currently being utilized by various organizations in their production environments. If you have any questions or concerns, feel free to raise issues
 * This project only uses redis as dependency
-

redis_dict-3.0.0/pyproject.toml

@@ -0,0 +1,133 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "redis-dict"
+version = "3.0.0"
+description = "Dictionary with Redis as storage backend"
+authors = [
+    {name = "Melvin Bijman", email = "bijman.m.m@gmail.com"},
+]
+readme = "README.md"
+
+requires-python = ">=3.8"
+license = {text = "MIT"}
+dependencies = [
+    "redis>=4.0.0",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: Science/Research",
+    "Topic :: Internet",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Database",
+    "Topic :: System :: Distributed Computing",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Object Brokering",
+    "Topic :: Database :: Database Engines/Servers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Typing :: Typed",
+]
+
+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",
+]
+
+[project.optional-dependencies]
+dev = [
+    "coverage==5.5",
+    "hypothesis==6.70.1",
+
+    "mypy>=1.8.0",
+    "mypy-extensions>=1.0.0",
+    "types-pyOpenSSL>=24.0.0.0",
+    "types-redis>=4.6.0",
+    "typing_extensions>=4.5.0",
+
+    "pylama>=8.4.1",
+    "pycodestyle==2.10.0",
+    "pydocstyle==6.3.0",
+    "pyflakes==3.0.1",
+    "pylint==3.2.7",
+    "mccabe==0.7.0",
+
+    "attrs==22.2.0",
+    "cffi==1.15.1",
+    "cryptography==43.0.1",
+    "exceptiongroup==1.1.1",
+    "future==0.18.3",
+    "pycparser==2.21",
+    "snowballstemmer==2.2.0",
+    "sortedcontainers==2.4.0",
+    "tomli==2.0.1",
+    "setuptools>=68.0.0",
+    "darglint",
+    "pydocstyle",
+]
+
+docs = [
+    "sphinx",
+    "sphinx-rtd-theme",
+    "sphinx-autodoc-typehints",
+    "tomli",
+    "myst-parser",
+]
+
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+packages = ["redis_dict"]
+
+[tool.setuptools.package-data]
+redis_dict = ["py.typed"]
+
+[tool.coverage.run]
+source = ["redis_dict"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if __name__ == .__main__.:",
+    "raise NotImplementedError",
+    "if TYPE_CHECKING:",
+]
+show_missing = true
+
+[tool.mypy]
+python_version = "3.8"
+strict = true
+mypy_path = "src"
+files = ["src"]
+namespace_packages = true
+explicit_package_bases = true
+
+[tool.pylama]
+ignore = "E501,E231"
+skip = "*/.tox/*,*/.env/*,build/*"
+linters = "pycodestyle,pyflakes,mccabe"
+max_line_length = 120
+paths = ["src/redis_dict"]
+
+[project.urls]
+Homepage = "https://github.com/Attumm/redisdict"
+Documentation = "https://github.com/Attumm/redisdict#readme"
+Repository = "https://github.com/Attumm/redisdict.git"
+Changelog = "https://github.com/Attumm/redisdict/releases"

redis_dict-3.0.0/src/redis_dict/__init__.py

@@ -0,0 +1,17 @@
+"""__init__ module for redis dict."""
+from importlib.metadata import version, PackageNotFoundError
+
+from .core import RedisDict
+from .type_management import decoding_registry, encoding_registry, RedisDictJSONEncoder, RedisDictJSONDecoder
+
+__all__ = [
+    'RedisDict',
+    'decoding_registry',
+    'encoding_registry',
+    'RedisDictJSONEncoder',
+    'RedisDictJSONDecoder',
+]
+try:
+    __version__ = version("redis-dict")
+except PackageNotFoundError:
+    __version__ = "0.0.0"