oarepo-runtime 1.5.11__py3-none-any.whl → 1.5.13__py3-none-any.whl

oarepo_runtime/records/systemfields/__init__.py

@@ -1,5 +1,7 @@
 from .icu import ICUField, ICUSortField, ICUSuggestField
 from .mapping import MappingSystemFieldMixin, SystemFieldDumperExt
+from .selectors import FirstItemSelector, PathSelector, Selector
+from .synthetic import SyntheticSystemField
 
 __all__ = (
     "ICUField",
@@ -7,4 +9,8 @@ __all__ = (
     "ICUSortField",
     "MappingSystemFieldMixin",
     "SystemFieldDumperExt",
+    "SyntheticSystemField",
+    "PathSelector",
+    "Selector",
+    "FirstItemSelector",
 )

oarepo_runtime/records/systemfields/mapping.py

@@ -19,12 +19,10 @@ class MappingSystemFieldMixin:
     @classmethod
     def search_dump(cls, data, record):
         """Dump custom field."""
-        pass
 
     @classmethod
     def search_load(cls, data, record_cls):
         """Load custom field."""
-        pass
 
 
 class SystemFieldDumperExt(SearchDumperExt):

oarepo_runtime/records/systemfields/selectors.py

@@ -0,0 +1,38 @@
+from typing import List
+
+
+class Selector:
+    def select(self, record):
+        return []
+
+
+class PathSelector:
+    def __init__(self, *paths):
+        self.paths = [x.split(".") for x in paths]
+
+    def select(self, record):
+        ret = []
+        for path in self.paths:
+            for rec in getter(record, path):
+                ret.append(rec)
+        return ret
+
+
+class FirstItemSelector(PathSelector):
+    def select(self, record):
+        for rec in super().select(record):
+            return [rec]
+
+
+def getter(data, path: List):
+    if len(path) == 0:
+        if isinstance(data, list):
+            yield from data
+        else:
+            yield data
+    elif isinstance(data, dict):
+        if path[0] in data:
+            yield from getter(data[path[0]], path[1:])
+    elif isinstance(data, list):
+        for item in data:
+            yield from getter(item, path)

oarepo_runtime/records/systemfields/synthetic.py

@@ -12,20 +12,23 @@ class SyntheticSystemField(MappingSystemFieldMixin, SystemField):
         the record is being indexed.
 
         Usage:
-
-        1. Create a new class that inherits from SyntheticSystemField
-        2. Implement the _value method that returns the value of the field from a data (
-           either a dictionary or an instance of the record class)
-        3. Put the class onto the record. If you use oarepo-model-builder, add it to the model
+        1. Check if any of the provided selectors (oarepo_runtime.records.systemfields.selectors)
+           are usable for your use case. If not, create a subclass of Selector class.
+        2. Put this class onto the record. If you use oarepo-model-builder, add it to the model
            like:
            ```yaml
     record:
       record:
-        extra-code: |-2
-              # extra custom fields for facets
-              faculty = {{common.theses.synthetic_fields.FacultySystemField}}()
-              department = {{common.theses.synthetic_fields.DepartmentSystemField}}()
-              defenseYear = {{common.theses.synthetic_fields.DefenseYearSystemField}}()
+        imports:
+          - oarepo_runtime.records.systemfields.SyntheticSystemField
+          - oarepo_vocabularies.records.selectors.LevelSelector
+        fields:
+          faculty = SyntheticSystemField(selector=LevelSelector("metadata.thesis.degreeGrantors", level=1))
+          department = SyntheticSystemField(selector=LevelSelector("metadata.thesis.degreeGrantors", level=2))
+          defenseYear = |
+            SyntheticSystemField(selector=PathSelector("metadata.thesis.dateDefended"),
+                transformer=lambda x: x[:4]
+            )
            ```
 
         4. Add the extra fields to the mapping and facets. If using oarepo-model-builder, add it to the
@@ -62,13 +65,32 @@ class SyntheticSystemField(MappingSystemFieldMixin, SystemField):
            ```
     """
 
+    def __init__(self, selector=None, filter=None, map=None, key=None, **kwargs):
+        self.selector = selector
+        self.map = map
+        self.filter = filter
+        super().__init__(key=key, **kwargs)
+
     def search_dump(self, data, record):
         dt = self._value(data)
         if dt:
-            data[self.key] = dt
+            key = self.key.split(".")
+            d = data
+            for k in key[:-1]:
+                d = d.setdefault(k, {})
+            d[key[-1]] = dt
 
     def search_load(self, data, record_cls):
-        data.pop(self.key, None)
+        def remove_key(d, key):
+            if len(key) == 1:
+                d.pop(key[0], None)
+            else:
+                if not isinstance(d, dict) or key[0] not in d:
+                    return
+                remove_key(d[key[0]], key[1:])
+                if not d[key[0]]:
+                    d.pop(key[0])
+        remove_key(data, self.key.split("."))
 
     def __get__(self, record, owner=None):
         if record is None:
@@ -76,4 +98,14 @@ class SyntheticSystemField(MappingSystemFieldMixin, SystemField):
         return self._value(record)
 
     def _value(self, data):
-        raise NotImplementedError("You must implement the _value method")
+        if self.selector:
+            value = list(self.selector.select(data))
+            if self.filter:
+                value = [x for x in value if self.filter(x)]
+            if self.map:
+                value = [self.map(x) for x in value]
+                value = [x for x in value if x is not None]
+            return value
+        raise ValueError(
+            "Please either provide a selector or subclass this class and implement a _value method"
+        )

oarepo_runtime/services/config/service.py

@@ -54,8 +54,7 @@ class PermissionsPresetsConfigMixin:
         """
         registered_preset_classes = current_app.config["OAREPO_PERMISSIONS_PRESETS"]
         preset_classes = [
-            registered_preset_classes[x]
-            for x in cls._get_permissions_presets()
+            registered_preset_classes[x] for x in cls._get_permissions_presets()
         ]
         if hasattr(cls, "base_permission_policy_cls"):
             preset_classes.insert(0, cls.base_permission_policy_cls)
@@ -72,7 +71,9 @@ class PermissionsPresetsConfigMixin:
         config_key = cls._get_presents_config_key()
         if config_key in current_app.config:
             return current_app.config[config_key]
-        return cls.PERMISSIONS_PRESETS  # noqa (omitted here because of the order of mixins)
+        return (
+            cls.PERMISSIONS_PRESETS
+        )  # noqa (omitted here because of the order of mixins)
 
     @classmethod
     def _get_presents_config_key(cls):
@@ -93,5 +94,5 @@ class PermissionsPresetsConfigMixin:
         name = cls.__name__
         if name.endswith("Config"):
             name = name[:-6]
-        name = re.sub(r'(?<!^)(?=[A-Z])', '_', name).upper()
+        name = re.sub(r"(?<!^)(?=[A-Z])", "_", name).upper()
         return f"{name}_PERMISSIONS_PRESETS"

oarepo_runtime/services/results.py

@@ -1,4 +1,3 @@
-
 from invenio_records_resources.services.records.results import (
     RecordItem as BaseRecordItem,
 )

oarepo_runtime/utils/functools.py

@@ -24,9 +24,9 @@ class class_property:
             self.__name__ = info.__name__
             self.__module__ = info.__module__
 
-    def __get__(self, obj, type=None):      # NOSONAR - this is a descriptor
+    def __get__(self, obj, type=None):  # NOSONAR - this is a descriptor
         if obj and type is None:
-            type = obj.__class__            # NOSONAR - this is a descriptor
+            type = obj.__class__  # NOSONAR - this is a descriptor
         return self.__get.__get__(obj, type)()
 
     def __set__(self, obj, value):

{oarepo_runtime-1.5.11.dist-info → oarepo_runtime-1.5.13.dist-info}/METADATA

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

{oarepo_runtime-1.5.11.dist-info → oarepo_runtime-1.5.13.dist-info}/RECORD

@@ -53,22 +53,23 @@ oarepo_runtime/records/relations/base.py,sha256=XQpRt6-MfIKIClZ0IoGJr0GGl2Ru3Rcq
 oarepo_runtime/records/relations/internal.py,sha256=OTp8iJqyl80sWDk0Q0AK42l6UsxZDABspVU_GwWza9o,1556
 oarepo_runtime/records/relations/lookup.py,sha256=wi3jPfOedazOmhOMrgu50PUETc1jfSdpmjK0wvOFsEM,848
 oarepo_runtime/records/relations/pid_relation.py,sha256=zJjSf_ocFBViYsOuMMZLbQZpNZeKiOK33dPD4tk74Qo,2786
-oarepo_runtime/records/systemfields/__init__.py,sha256=JpDSVry8TWvUNGlR7AXd_D9NDLiVN2xg9qxjNit96Sw,257
+oarepo_runtime/records/systemfields/__init__.py,sha256=SPaMWM6t-azz6gZLUKvvXbOyE2_-LW6i_szQk8nhbAc,455
 oarepo_runtime/records/systemfields/featured_file.py,sha256=MbSaYR130_o5S9gEOblnChq-PVK4xGPGpSCrzwG3cwc,1720
 oarepo_runtime/records/systemfields/has_draftcheck.py,sha256=3XLRsZJWRpT4BFF1HTg6C27ECVmIcZ4RrdGzYC8S7v0,1518
 oarepo_runtime/records/systemfields/icu.py,sha256=tAwplzy9y7C9Dm7HqcGZsDu2AKqVGXhCbKLsFlgVWg8,5921
-oarepo_runtime/records/systemfields/mapping.py,sha256=VYnexDmo1p3Vc3Hp34V_h8-OHzAh4129UZFE6T-FXbM,1043
+oarepo_runtime/records/systemfields/mapping.py,sha256=tXOK_jkdY1pOUO7_VfChfDNB8UTi21GUXaidpugTnO8,1017
 oarepo_runtime/records/systemfields/record_status.py,sha256=U3kem4-JkNsT17e0iAl3HIAZ2MvO5lY_0U757aZvTKE,935
-oarepo_runtime/records/systemfields/synthetic.py,sha256=6dKPNSXDYv-iNKtgZB7_GDm0Y7ESZB3jb0aDRKPK2YA,2474
+oarepo_runtime/records/systemfields/selectors.py,sha256=bgH6oalv9rPPC-EVwt8-DdkUl7EX0UOgfynN51DZauI,882
+oarepo_runtime/records/systemfields/synthetic.py,sha256=hXBDEcyqWtytPhwypC5ZKDhF4Gr3kVoq3lhpBsUNvrY,3729
 oarepo_runtime/resources/__init__.py,sha256=v8BGrOTu_FjKzd0eozV7Q4GoGxyfybsL2cI-tbP5Pys,185
 oarepo_runtime/resources/file_resource.py,sha256=Ta3bFce7l0xwqkkOMOEu9mxbB8BbKj5HUHRHmidhnl8,414
 oarepo_runtime/resources/localized_ui_json_serializer.py,sha256=4Kle34k-_uu3Y9JJ2vAXcQ9DqYRxXgy-_iZhiFuukmE,1684
 oarepo_runtime/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oarepo_runtime/services/results.py,sha256=DsBPniwhNvOkYucS8Z0v3EC28LemY7JuZNVhl_17PhA,1500
+oarepo_runtime/services/results.py,sha256=F3A0U3MRUOYlxNglJPQeGMKdD8QNq1il106jQZ0c9gQ,1499
 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=4ox1M4fhZ5PWvYn4NoC4Gq4ORQOiih-TVjMuB4t3Weo,3868
+oarepo_runtime/services/config/service.py,sha256=8qFLIqDi2zPby4Y-vgGlf1iJIBJOsEEsaw1t8ml96H8,3880
 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
@@ -105,12 +106,12 @@ oarepo_runtime/translations/cs/LC_MESSAGES/messages.po,sha256=vGZQo5NlTtj_qsJuDw
 oarepo_runtime/translations/en/LC_MESSAGES/messages.mo,sha256=FKAl1wlg2NhtQ1-9U2dkUwcotR959j5GuUKJygCYpwI,445
 oarepo_runtime/translations/en/LC_MESSAGES/messages.po,sha256=rZ2PGvkcJbmuwrWeFX5edk0zJIzZnL83M9HSAceDP_U,1193
 oarepo_runtime/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oarepo_runtime/utils/functools.py,sha256=36XnrIiVCtL35FFLp1_UmNdgQT60cZu2C4IyNMVoads,1339
+oarepo_runtime/utils/functools.py,sha256=7V-aMkAscc5qyGawGS8jmwqfdW2Wpjxe-u8DKgB8meI,1325
 oarepo_runtime/utils/path.py,sha256=V1NVyk3m12_YLbj7QHYvUpE1wScO78bYsX1LOLeXDkI,3108
 tests/pkg_data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-oarepo_runtime-1.5.11.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
-oarepo_runtime-1.5.11.dist-info/METADATA,sha256=bQsW_ZE6ze4cMzc-CRqkHf3m-wAnbgr0ZFAs95kXJe4,4787
-oarepo_runtime-1.5.11.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-oarepo_runtime-1.5.11.dist-info/entry_points.txt,sha256=QrlXAKuPDVBinaSh_v3yO9_Nb9ZNmJCJ0VFcCW-z0Jg,327
-oarepo_runtime-1.5.11.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
-oarepo_runtime-1.5.11.dist-info/RECORD,,
+oarepo_runtime-1.5.13.dist-info/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
+oarepo_runtime-1.5.13.dist-info/METADATA,sha256=JHKX3me9P-WP93ItF4WVIfeIgB0wFFug0MYiV3cJBoA,4787
+oarepo_runtime-1.5.13.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+oarepo_runtime-1.5.13.dist-info/entry_points.txt,sha256=QrlXAKuPDVBinaSh_v3yO9_Nb9ZNmJCJ0VFcCW-z0Jg,327
+oarepo_runtime-1.5.13.dist-info/top_level.txt,sha256=bHhlkT1_RQC4IkfTQCqA3iN4KCB6cSFQlsXpQMSP-bE,21
+oarepo_runtime-1.5.13.dist-info/RECORD,,