oarepo-runtime 1.5.9__py3-none-any.whl → 1.5.10__py3-none-any.whl

oarepo_runtime/services/config/service.py

@@ -1,14 +1,22 @@
 import inspect
+import re
 from functools import cached_property
+from typing import List, Type
 
 from flask import current_app
+from invenio_records_permissions import BasePermissionPolicy
 
 
 class PermissionsPresetsConfigMixin:
     components = tuple()
+    PERMISSIONS_PRESETS_CONFIG_KEY = None
+    # PERMISSIONS_PRESETS = []         # noqa (omitted here because of the order of mixins)
 
     @cached_property
     def permission_policy_cls(self):
+        """
+        Returns a class that contains all permissions from the presets.
+        """
         presets = self._get_preset_classes()
 
         permissions = {}
@@ -32,12 +40,51 @@ class PermissionsPresetsConfigMixin:
                 continue
             yield permission_name, permission_needs
 
-    def _get_preset_classes(self):
+    def _get_preset_classes(self) -> List[Type[BasePermissionPolicy]]:
+        """
+        Returns a list of permission presets classes to be used for this service.
+
+        The list is read from the configuration, if it exists, otherwise it returns
+        the default value from the class attribute PERMISSIONS_PRESETS.
+        """
         registered_preset_classes = current_app.config["OAREPO_PERMISSIONS_PRESETS"]
         preset_classes = [
             registered_preset_classes[x]
-            for x in self.PERMISSIONS_PRESETS  # noqa (omitted here because of the order of mixins)
+            for x in self._get_permissions_presets()
         ]
         if hasattr(self, "base_permission_policy_cls"):
             preset_classes.insert(0, self.base_permission_policy_cls)
         return preset_classes
+
+    def _get_permissions_presets(self):
+        """
+        Returns a list of names of permissions presets to be used for this service.
+
+        The list is read from the configuration, if it exists, otherwise it returns
+        the default value from the class attribute PERMISSIONS_PRESETS.
+        """
+        config_key = self._get_presents_config_key()
+        if config_key in current_app.config:
+            return current_app.config[config_key]
+        return self.PERMISSIONS_PRESETS  # noqa (omitted here because of the order of mixins)
+
+    def _get_presents_config_key(self):
+        """
+        Returns the name of the configuration key that contains the list of
+        permissions presets to be used for this service.
+
+        The key is read from the class attribute PERMISSIONS_PRESETS_CONFIG_KEY.
+        If it is not set, the key is generated from the name of the service
+        configuration class (MyServiceConfig becomes MY_SERVICE_PERMISSIONS_PRESETS).
+        """
+        if self.PERMISSIONS_PRESETS_CONFIG_KEY:
+            return self.PERMISSIONS_PRESETS_CONFIG_KEY
+
+        # use the base class of the service config file (e.g. MyServiceConfig),
+        # remove the "Config" part and convert it to snake uppercase.
+        # add "_PERMISSIONS_PRESETS" at the end.
+        name = type(self).__name__
+        if name.endswith("Config"):
+            name = name[:-6]
+        name = re.sub(r'(?<!^)(?=[A-Z])', '_', name).upper()
+        return f"{name}_PERMISSIONS_PRESETS"

{oarepo_runtime-1.5.9.dist-info → oarepo_runtime-1.5.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oarepo-runtime
-Version: 1.5.9
+Version: 1.5.10
 Summary: A set of runtime extensions of Invenio repository
 Description-Content-Type: text/markdown
 License-File: LICENSE

{oarepo_runtime-1.5.9.dist-info → oarepo_runtime-1.5.10.dist-info}/RECORD

@@ -68,7 +68,7 @@ oarepo_runtime/services/results.py,sha256=DsBPniwhNvOkYucS8Z0v3EC28LemY7JuZNVhl_
 oarepo_runtime/services/search.py,sha256=ywfwGH7oAM44WeOSjlIsY_qoCMZJ1TlTLd_NgE2ow3Y,5296
 oarepo_runtime/services/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 oarepo_runtime/services/config/permissions_presets.py,sha256=zApeA-2DYAlD--SzVz3vq_OFjq48Ko0pe08e4o2vxr4,6114
-oarepo_runtime/services/config/service.py,sha256=Uzo3rJGWljbkLcWd-E1BJOEglJHli8eUSIgFTJt9sXE,1566
+oarepo_runtime/services/config/service.py,sha256=7U-iC5Or51-T2tvWkB6WHQJ0tNVcyEKQutT1Ldl2I7w,3648
 oarepo_runtime/services/custom_fields/__init__.py,sha256=xJ7XEyMJHPfIgX5JKpgpwh7SYc9Zee2dC5oC8cm99Qc,2282
 oarepo_runtime/services/custom_fields/mappings.py,sha256=1mb8nYeUlQxbBolsKURGKUIpIV1NDb-7Mcur32jjIjg,4433
 oarepo_runtime/services/expansions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -108,9 +108,9 @@ oarepo_runtime/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hS
 oarepo_runtime/utils/functools.py,sha256=eueB-4MRv9wrOARs70ey21JvBb63gGeJV6m1fdGcnPQ,319
 oarepo_runtime/utils/path.py,sha256=V1NVyk3m12_YLbj7QHYvUpE1wScO78bYsX1LOLeXDkI,3108
 tests/pkg_data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oarepo_runtime-1.5.9.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
-oarepo_runtime-1.5.9.dist-info/METADATA,sha256=tiavNP9_ZGACPIZvyvuRs4VgInnmgH3rEaqiVCUYoRo,4786
-oarepo_runtime-1.5.9.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-oarepo_runtime-1.5.9.dist-info/entry_points.txt,sha256=QrlXAKuPDVBinaSh_v3yO9_Nb9ZNmJCJ0VFcCW-z0Jg,327
-oarepo_runtime-1.5.9.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
-oarepo_runtime-1.5.9.dist-info/RECORD,,
+oarepo_runtime-1.5.10.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
+oarepo_runtime-1.5.10.dist-info/METADATA,sha256=Bf_H3Lyi-01D9RxW8qUm0mLmt55_hLdoD26igXVsl4o,4787
+oarepo_runtime-1.5.10.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+oarepo_runtime-1.5.10.dist-info/entry_points.txt,sha256=QrlXAKuPDVBinaSh_v3yO9_Nb9ZNmJCJ0VFcCW-z0Jg,327
+oarepo_runtime-1.5.10.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
+oarepo_runtime-1.5.10.dist-info/RECORD,,