New dynoptimdict,examples,LICENSE,pyproject.toml; Update README.md

Author: leoweyr

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present, leoweyr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,15 @@
-# Python-DynOptimDict
- 
+# Dynoptimdict
+[![PyPI Latest Release](https://img.shields.io/pypi/v/dynoptimdict.svg)](https://pypi.org/project/dynoptimdict/)
+[![Package Status](https://img.shields.io/pypi/status/dynoptimdict.svg)](https://pypi.org/project/dynoptimdict/)
+[![License](https://img.shields.io/pypi/l/dynoptimdict.svg)](https://github.com/leoweyr/Python-Dynoptimdict/blob/main/LICENSE)
+[![Downloads](https://static.pepy.tech/personalized-badge/dynoptimdict?period=total&units=international_system&left_color=grey&right_color=green&left_text=pypi%20downloads)](https://pepy.tech/project/dynoptimdict)
+
+A dynamic data dict class that inherits and overrides the built-in dict class for special purposes. That provides real-time access to dynamic data, while still allowing the option to get only the specified data without calculating all. It adheres to the concept of program optimization which avoids loading if not used, saving both memory and time.
+
+## ⚖️License
+
+[MIT](https://github.com/leoweyr/Python-Dynoptimdict/blob/main/LICENSE)
+
+## 📗Documentation
+
+The basic usage is similar to that of Python built-in `dict`, please refer to the code example for specific differences: https://github.com/leoweyr/Python-Dynoptimdict/tree/main/examples

dynoptimdict/__init__.py

@@ -0,0 +1,7 @@
+from .dynamic_data_dict import (
+    DynamicDataDict
+)
+
+__all__ = [
+    "DynamicDataDict"
+]

dynoptimdict/dynamic_data_dict.py

@@ -0,0 +1,36 @@
+class DynamicDataDict(dict):
+    def __init__(self):
+        self.__get_value_operate_queue = []
+        self.__get_value_operate_arg_list = []
+
+    def __repr__(self):  # Called when the object does not use the dictionary access operator, which is distinguished from calling method:special<__getitem__>.
+        self.__get_value(None)  # Get all dynamic data.
+        return super().__repr__()
+
+    def __getitem__(self, key):
+        self.__get_value(key)  # Get the specified dynamic data.
+        return super().__getitem__(key)
+
+    def __setitem__(self, dynamic_data_name, get_dynamic_data_func: callable):
+        self.__get_value_operate_queue.append(self.__get_value_operate)
+        self.__get_value_operate_arg_list.append((dynamic_data_name, get_dynamic_data_func))
+
+    def keys(self):
+        self.__get_value(None)
+        return super().keys()
+
+    def values(self):
+        self.__get_value(None)
+        return super().values()
+
+    def items(self):
+        self.__get_value(None)
+        return super().items()
+
+    def __get_value_operate(self, key, dynamic_data_name, get_dynamic_data_func: callable):
+        if key == dynamic_data_name or key is None:
+            super().__setitem__(dynamic_data_name, get_dynamic_data_func())
+
+    def __get_value(self, key):
+        for get_value_operate, get_value_operate_arg in zip(self.__get_value_operate_queue, self.__get_value_operate_arg_list):
+            get_value_operate(key, get_value_operate_arg[0], get_value_operate_arg[1])

examples/whether_to_use_the_dictionary_access_operator.py

@@ -0,0 +1,44 @@
+import time
+from dynoptimdict import DynamicDataDict
+
+
+def get_status_data_1():
+    time.sleep(1)  # Here is just assuming this function takes 1 second to perform the calculation before returning the result.
+    return "data_1_example"  # Must have a return value.
+
+
+def get_status_data_2():
+    time.sleep(10)  # In the same way, here is just a hypothesis, for the convenience of comparison later.
+    return "data_2_example"
+
+
+def get_status_data_3():
+    time.sleep(100)  # The same is just an assumption.
+    return "data_3_example"
+
+
+class MyClass:
+    @property
+    def status(self):
+        status = DynamicDataDict()
+        '''
+        The following steps are necessary. If you want to obtain data from the dynamic data dict in real time, you must 
+        define function which is used to get related data, and then pass in its function pointer through the method of 
+        adding key-value pairs to dict. 
+         
+        '''
+        status["data_1"] = get_status_data_1
+        status["data_2"] = get_status_data_2
+        status["data_3"] = get_status_data_3
+
+        return status
+
+
+def main():
+    obj = MyClass()
+    obj.status["data_1"]  # Only get the specified data, it takes 1 second, and achieve the optimized effect.
+    obj.status  # Get all data, it takes about 100 + 10 + 1 seconds.
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -0,0 +1,21 @@
+[tool.poetry]
+name = "dynoptimdict"
+version = "1.0.0"
+description = "A dynamic data dict class that inherits and overrides the built-in dict class for special purposes. That provides real-time access to dynamic data, while still allowing the option to get only the specified data without calculating all. It adheres to the concept of program optimization which avoids loading if not used, saving both memory and time."
+license = "MIT"
+authors = ["leoweyr <leoweyr@foxmail.com>"]
+readme = "README.md"
+repository = "https://github.com/leoweyr/Python-Dynoptimdict"
+classifiers = [
+    "Development Status :: 3 - Alpha"
+]
+packages = [{include = "dynoptimdict"}]
+
+
+[tool.poetry.dependencies]
+python = "^3.8"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"