[ADD] base_registry_cache_custom

Author: SilvioC2C

base_registry_cache_custom/README.rst

@@ -0,0 +1,118 @@
+=====================
+Registry Custom Cache
+=====================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:6c8e306992a72a18f30d78f12456cec5b1802ae1fde1c9179f122297a61c4562
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-tools/tree/17.0/base_registry_cache_custom
+    :alt: OCA/server-tools
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-tools-17-0/server-tools-17-0-base_registry_cache_custom
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module allows adding custom caches to the DBs' registries.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+Make sure you run Odoo with
+``--load=base,web,base_registry_cache_custom`` or using the Odoo
+configuration file:
+
+.. code:: ini
+
+   [options]
+   (...)
+   server_wide_modules = base,web,base_registry_cache_custom
+
+Usage
+=====
+
+If you need to create a custom cache, create a new module and:
+
+-  add this module as its dependency
+-  add a ``post_load`` hook like this:
+
+.. code:: python
+
+   from odoo.addons.base_registry_cache_custom.registry import add_custom_cache
+
+
+   def post_load():
+       add_custom_cache(name="my_cache", size=256)
+
+If you make use of multiple caches, and some of them should be
+invalidated when another one gets invalidated itself, use the ``deps``
+argument:
+
+.. code:: python
+
+   from odoo.addons.base_registry_cache_custom.registry import add_custom_cache
+
+
+   def post_load():
+       add_custom_cache(name="my_cache", size=256, deps=["my_cache.subcache"])
+       add_custom_cache(name="my_cache.subcache", size=128)
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20base_registry_cache_custom%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Camptocamp
+
+Contributors
+------------
+
+-  Silvio Gregorini <[email protected]>
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/17.0/base_registry_cache_custom>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

base_registry_cache_custom/__init__.py

@@ -0,0 +1,14 @@
+# Copyright 2025 Camptocamp SA
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/agpl)
+
+{
+    "name": "Registry Custom Cache",
+    "version": "17.0.1.0.0",
+    "category": "Tools",
+    "summary": "Add custom caches to Odoo registries",
+    "author": "Camptocamp,Odoo Community Association (OCA)",
+    "license": "LGPL-3",
+    "website": "https://github.com/OCA/server-tools",
+    "depends": ["base"],
+    "installable": True,
+}

base_registry_cache_custom/__manifest__.py

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

base_registry_cache_custom/pyproject.toml

@@ -0,0 +1,7 @@
+Make sure you run Odoo with ``--load=base,web,base_registry_cache_custom`` or using the Odoo configuration file:
+
+``` ini
+[options]
+(...)
+server_wide_modules = base,web,base_registry_cache_custom
+```

base_registry_cache_custom/readme/CONFIGURE.md

@@ -0,0 +1 @@
+- Silvio Gregorini \<<[email protected]>\>

base_registry_cache_custom/readme/CONTRIBUTORS.md

@@ -0,0 +1 @@
+This module allows adding custom caches to the DBs' registries.

base_registry_cache_custom/readme/DESCRIPTION.md

@@ -0,0 +1,24 @@
+If you need to create a custom cache, create a new module and:
+
+- add this module as its dependency
+- add a `post_load` hook like this:
+
+```python
+from odoo.addons.base_registry_cache_custom.registry import add_custom_cache
+
+
+def post_load():
+    add_custom_cache(name="my_cache", size=256)
+```
+
+If you make use of multiple caches, and some of them should be invalidated when another
+one gets invalidated itself, use the `deps` argument:
+
+```python
+from odoo.addons.base_registry_cache_custom.registry import add_custom_cache
+
+
+def post_load():
+    add_custom_cache(name="my_cache", size=256, deps=["my_cache.subcache"])
+    add_custom_cache(name="my_cache.subcache", size=128)
+```

base_registry_cache_custom/readme/USAGE.md

@@ -0,0 +1,44 @@
+# Copyright 2025 Camptocamp SA
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+import logging
+import typing
+
+from odoo.modules import registry
+from odoo.tools.lru import LRU
+from odoo.tools.misc import OrderedSet
+
+_logger = logging.getLogger(__name__)
+
+
+def add_custom_cache(name: str, size: int, deps: typing.Iterable[str] = None):
+    """Adds a custom cache into the Odoo registry
+
+    :param name: name of the custom cache to add
+    :param size: size of the custom cache (must be > 0)
+    :param deps: iterable of other cache names, to be registered for cache
+        invalidation dependencies; ``cache_name`` is always included as first item
+    """
+    _logger.info(f"Adding cache '{name}' to registries...")
+
+    # ``registry._REGISTRY_CACHES`` is used by ``registry.Registry.init()`` to
+    # initialize registries' caches (attr ``__cache``)
+    registry._REGISTRY_CACHES[name] = size
+
+    # ``registry._CACHES_BY_KEY`` is used by a variety of ``registry.Registry`` methods
+    # to handle caches dependencies
+    # NB: use an ``OrderedSet`` to avoid duplicates while keeping the dependency order
+    # (with the main cache as first item anyway), then convert to tuple for consistency
+    # w/ the standard ``registry._CACHES_BY_KEY`` structure
+    registry._CACHES_BY_KEY[name] = tuple(OrderedSet([name] + list(deps or [])))
+
+    # Update existing registries by:
+    #   - adding the custom cache to the registry (name-mangle: avoid AttributeError)
+    #   - setting up the proper signaling workflow
+    # ``registry.Registry.registries`` is a class attribute that returns an
+    # ``odoo.tools.lru.LRU`` object that maps each DB name to its ``registry.Registry``
+    # object through its variable ``d`` (which is an ``OrderedDict`` object)
+    for db_name, db_registry in registry.Registry.registries.d.items():
+        _logger.info(f"Adding cache '{name}' to '{db_name}' registry")
+        db_registry._Registry__caches[name] = LRU(size)
+        db_registry.setup_signaling()