reactive-caching 0.1.0__py3-none-any.whl

reactive_caching-0.1.0.dist-info/METADATA

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: reactive_caching
+Version: 0.1.0
+Summary: Provides caching for class properties.
+Author-email: rgzz666 <tt1224@hotmail.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/totowang-hhh/properties_caching.git
+Project-URL: Author's Site, https://rgzz666.top
+Keywords: caching,cache,reactive,property,attribute,attr,performance,something new,something interesting
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Reactive Caching
+
+> 2026 by rgzz666
+>
+> v0.1.0
+
+```bash
+pip3 install reactive_caching
+```
+
+**Reactive Caching is a Python module providing the ability to cache properties of a class, and automatically invalidate them on specified rules of changes in attributes.** This can avoid calculating the property everytime when calling it and keeping the data up to date.
+
+## Usage
+
+### Import the module
+
+To use the module, you must import it with:
+
+```python
+import reactive_caching
+```
+
+or if you prefer to directly use the contents:
+
+```python
+from reactive_caching import CachedClass
+```
+
+Note that the latter will be used as the example in the folowing guide.
+
+### Subclassing
+
+The class containing any cached properties must have the ability to handle them. In this project, the class get those abilities by subclassing `CachedClass` .
+
+```python
+class MyClass(CachedClass):
+    ...
+```
+
+This will redefine its `__setattr__()` , so if your class requires a customized `__setattr__()` routine, you must run `CachedClass.__setattr(name, value)` inside your routine.
+
+### `cached_property` Decorator Factory
+
+Each cached property should be decorated by a decorator which generated by `cached_property` factory. Usage shown as below:
+
+```python
+class MyClass(CachedClass):
+    ...
+    @MyClass.cached_property(watched_attrs = "-all-")
+    def a_property_that_is_calced_with_all_attributes(self) -> int:
+        ...
+        return 1
+```
+
+### Caching Rules
+
+This is a parameter of `cached_property` decorator factory, used to specify rules of the cache.
+
+Caching rules can be set to either a list of property names, or one of the keywords. Effect of each configuration will be introduced below:
+
+- **List of property names:** All attributes with name included in that list will be watched. When any of their values is changed, the cache will be flagged dirty.
+- **Keyword `-all-`:** All attributes will be watched and if any of them is changed, the cache will be flagged dirty.
+- **Keyword `-exposed-`:** All exposed attributes (those with name that does not starts with \`\_\`) will be watched. When any of their values is changed, the cache will be flagged dirty.
+
+### `on_cache_dirty` Bind
+
+If you decide to carry out a specific routine when a cache turned dirty, override `_on_cache_dirty()` function with your own when inheriting `CachedClass`. Your function should receive a parameter in type string, containing the name of the property which has its cache turned dirty, and returns `None`.
+
+```python
+class A(CachedClass):
+    ...
+    def _on_cache_dirty(prop_name: str) -> None:
+        print(f"Cached property {prop_name} got its cache dirty.")
+```
+
+### Destroying Cache
+
+If a cached object is no longer needed, you may use `destroy_cache()` to free up memory space by removing all cache-relating stuff of such object.
+
+## Copyright
+
+```
+   Copyright 2026 rgzz666
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```
+
+## Questions?
+
+For code contribution, create a pull request.
+
+For bugs and feature requests, create an issue.
+
+For questions in usage or other discussions, use GitHub Discussions.
+
+---
+
+**That's all, Good luck!**
+
+(C) 2026 rgzz666, licensed under Apache License 2.0, see [Copyright](#Copyright) section for more.

reactive_caching-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+reactive_caching.py,sha256=scZ_2NtAZg0J641QKrtDE5D3FKzrSvvbJWeLpSuFUC4,6460
+reactive_caching-0.1.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+reactive_caching-0.1.0.dist-info/METADATA,sha256=6fgLGHQlyX3c7DqoorKbgH47uFaHQWqh8sKepQ3uSwc,4651
+reactive_caching-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+reactive_caching-0.1.0.dist-info/top_level.txt,sha256=qHpJ1RI-0cjY8LHYe4bPzbbAZy8ERLhL4w1H3AybM4g,17
+reactive_caching-0.1.0.dist-info/RECORD,,

reactive_caching-0.1.0.dist-info/WHEEL

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

reactive_caching-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

reactive_caching-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+reactive_caching

reactive_caching.py

@@ -0,0 +1,157 @@
+"""Caching module for class properties, with auto invalidation."""
+
+# Copyright 2026 rgzz666
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations as _
+
+import typing as _typing
+
+import warnings as _warnings
+
+
+class CachedClass():
+    """Caching ability of a class.
+
+    Must set `self._cache_initialized` to `True` after `__init__()`
+    """
+
+    def __init_subclass__(cls) -> None:
+        """Inherit or create empty caching rule for classes."""
+        inherit: bool = True
+        if hasattr(cls, "_inherit_cache_rule"):
+            if isinstance(cls._inherit_cache_rule, bool):   # type: ignore
+                inherit = cls._inherit_cache_rule           # type: ignore
+        if cls is CachedClass:
+            inherit = False
+        cls._cached_list: dict[str, list | _typing.Literal["-all-"] | _typing.Literal["-exposed-"]]
+        if inherit:
+            inherited_rules = {}
+            for parent_cls in reversed(cls.__mro__[1:]):
+                # Override rules, the first parent class is the most prior, and last overrided
+                if issubclass(parent_cls, CachedClass):
+                    inherited_rules.update(parent_cls._cached_list)
+            cls._cached_list = inherited_rules
+        else:
+            cls._cached_list = {}
+
+    def __init__(self) -> None:
+        """Initialize a cache class."""
+        self._cache_dirty_state: dict[str, bool] = {}
+        self._cache_data: dict[str, _typing.Any] = {}
+        self._cache_alive: bool = False
+
+        for prop in type(self)._cached_list:
+            self._cache_dirty_state[prop] = True
+            self._cache_data[prop] = None
+
+        self._cache_alive = True
+
+    @classmethod
+    def _cached_property(
+        cls, 
+        watched_attrs: list[str] | _typing.Literal["-all-"] | _typing.Literal["-exposed-"]
+        ) -> _typing.Callable[[_typing.Callable], property]:
+        """Generate a decorator for cached properties.
+
+        Caching Rules
+        -------------
+        Caching rules can be set to either a list of property names, or one of the keywords. Effect 
+        of each configuration will be introduced below: 
+        - **List of property names:** All attributes with name included in that list will be 
+          watched. When any of their values is changed, the cache will be flagged dirty.
+        - **Keyword `-all-`:** All attributes will be watched and if any of them is changed, the 
+          cache will be flagged dirty.
+        - **Keyword `-exposed-`:** All exposed attributes (those with name that does not starts 
+          with `_`) will be watched. When any of their values is changed, the cache will be flagged 
+          dirty.
+        """
+
+        PropType = _typing.TypeVar("PropType")
+
+        def decorator(func: _typing.Callable[[CachedClass], PropType]) -> property:
+            cls._cached_list[func.__name__] = watched_attrs
+
+            @property
+            def wrapper(self: CachedClass) -> PropType:
+                if not self._cache_alive:
+                    _warnings.warn(
+                        "Trying to get a cached property from a destroyed cached class. This "
+                        "operation is not suggested and caching system will be bypassed."
+                        )
+                    return func(self)
+                if self._cache_dirty_state[func.__name__]:
+                    # If cache in dirty state, re-calculate it
+                    self._cache_data[func.__name__] = func(self)
+                    self._cache_dirty_state[func.__name__] = False
+                return self._cache_data[func.__name__]
+
+            return wrapper
+
+        return decorator
+
+    def _on_cache_dirty(self, prop_name: str) -> None:
+        """Customizable operations to carry out when a cache is flagged dirty. To be overrided.
+
+        To implement running a specific routine on a cache is flagged dirty, override this function 
+        when subclassing `CachedClass` with such routine.
+        """
+        return None
+
+    def __setattr__(self, name: str, value: _typing.Any) -> None:
+        """Set attr and update cache dirty state."""
+        if not self._cache_alive:
+            super().__setattr__(name, value)
+            return
+        super().__setattr__(name, value)
+        if name in [ # Ignore names used by caching system
+            "_cache_initialized", 
+            "_cached_list", 
+            "_cached_data", 
+            "_cache_dirty_state", 
+            "_cache_alive"
+            ]:
+            return
+        for prop in self._cached_list.keys():
+            if self._cache_dirty_state[prop]:
+                continue # If is already dirty, then can skip
+                # Because no need to flag a prop cache that is already dirty as dirty again
+            match self._cached_list[prop]:
+                case "-all-":
+                    self._cache_dirty_state[prop] = True
+                    self._on_cache_dirty(prop)
+                case "-exposed-":
+                    if not name.startswith("_"):
+                        self._cache_dirty_state[prop] = True
+                        self._on_cache_dirty(prop)
+                case list() | tuple():
+                    if name in self._cached_list[prop]:
+                        self._cache_dirty_state[prop] = True
+                        self._on_cache_dirty(prop)
+                case _:
+                    _warnings.warn(
+                        f"Cache rule {self._cached_list[prop]} neither a valid list nor valid "
+                        "keyword, check spelling! The cache will be regarded as dirty anyway."
+                        )
+                    self._cache_dirty_state[prop] = True
+                    self._on_cache_dirty(prop)
+                    return
+
+    def destroy_cache(self):
+        """Destroy cache."""
+        if not self._cache_alive:
+            return
+        self._cache_alive = False
+        self._cache_data.clear()
+        self._cache_dirty_state.clear()