oarepo-runtime 2.0.0.dev16__tar.gz → 2.0.0.dev19__tar.gz

{oarepo_runtime-2.0.0.dev16 → oarepo_runtime-2.0.0.dev19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oarepo-runtime
-Version: 2.0.0.dev16
+Version: 2.0.0.dev19
 Summary: A set of runtime extensions of Invenio repository
 Project-URL: Homepage, https://github.com/oarepo/oarepo-runtime
 License-Expression: MIT

{oarepo_runtime-2.0.0.dev16 → oarepo_runtime-2.0.0.dev19}/oarepo_runtime/__init__.py

@@ -19,6 +19,6 @@ from .api import Model
 from .ext import OARepoRuntime
 from .proxies import current_runtime
 
-__version__ = "2.0.0dev16"
+__version__ = "2.0.0dev19"
 
 __all__ = ("Model", "OARepoRuntime", "__version__", "current_runtime")

oarepo_runtime-2.0.0.dev19/oarepo_runtime/records/systemfields/custom_fields.py

@@ -0,0 +1,63 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+"""Module to update the mapping of system fields in a record class."""
+
+from __future__ import annotations
+
+import inspect
+from typing import TYPE_CHECKING
+
+from flask import current_app
+from invenio_records.systemfields.relations import MultiRelationsField
+from invenio_vocabularies.records.systemfields.relations import CustomFieldsRelation
+
+from oarepo_runtime.records.mapping import prefixed_index, update_record_index
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
+    from invenio_records.api import RecordBase
+
+
+def update_record_system_fields_mapping_relation_field(
+    record_class: type[RecordBase],
+) -> None:
+    """Update mapping for system fields in the record class.
+
+    :param record_class: The record class which index mapping should be updated.
+    :raise search.RequestError: If there is an error while updating the mapping.
+    """
+    index = getattr(record_class, "index", None)
+    if not index:
+        return
+
+    for field_name, fld in get_mapping_relation_fields(record_class):
+        custom_fields = current_app.config.get(fld._fields_var, [])  # noqa: SLF001
+
+        props: dict[str, dict] = {}
+        mapping = {field_name: {"type": "object", "properties": props}}
+        for cf in custom_fields:
+            # get mapping
+            props[cf.name] = cf.mapping
+
+        # upload mapping
+        if props:
+            update_record_index(prefixed_index(index), {}, mapping, None)
+
+
+def get_mapping_relation_fields(
+    record_class: type[RecordBase],
+) -> Iterable[tuple[str, CustomFieldsRelation]]:
+    """Get all mapping fields from the record class."""
+    for _, relation_fields in inspect.getmembers(record_class, lambda x: isinstance(x, MultiRelationsField)):
+        yield from (
+            (field_name, relation_field)
+            for field_name, relation_field in relation_fields._original_fields.items()  # noqa: SLF001
+            if isinstance(relation_field, CustomFieldsRelation)
+        )

oarepo_runtime-2.0.0.dev19/oarepo_runtime/records/systemfields/selectors.py

@@ -0,0 +1,51 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+"""Selectors for extracting values from records based on specified paths."""
+
+from __future__ import annotations
+
+from typing import Any, Protocol
+
+
+class Selector(Protocol):
+    """Protocol for selectors that extract values from records."""
+
+    def select(self, record: dict) -> list[Any]:  # noqa: ARG002
+        """Select values from the record based on the selector's logic."""
+        return []
+
+
+class PathSelector(Selector):
+    """Selector that extracts values from records based on specified paths."""
+
+    def __init__(self, *paths: str) -> None:
+        """Initialize the PathSelector with given paths."""
+        self.paths = [x.split(".") for x in paths]
+
+    def select(self, record: dict) -> list[Any]:
+        """Select values from the record based on the specified paths."""
+        ret = []
+        for path in self.paths:
+            ret.extend(list(getter(record, path)))
+        return ret
+
+
+def getter(data: list | dict, path: list) -> Any:
+    """Recursively get values from data based on the provided path."""
+    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-2.0.0.dev16 → oarepo_runtime-2.0.0.dev19}/oarepo_runtime/services/generators.py

@@ -10,20 +10,21 @@
 
 from __future__ import annotations
 
-from abc import abstractmethod
+from abc import ABC, abstractmethod
+from itertools import chain
 from typing import TYPE_CHECKING, Any, override
 
 from invenio_records_permissions.generators import (
     ConditionalGenerator as InvenioConditionalGenerator,
 )
 from invenio_records_permissions.generators import Generator as InvenioGenerator
+from invenio_search.engine import dsl
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
 
     from flask_principal import Need
     from invenio_records_resources.records.api import Record
-    from invenio_search.engine import dsl
 
 
 class Generator(InvenioGenerator):
@@ -45,7 +46,7 @@ class Generator(InvenioGenerator):
         return super().query_filter(**kwargs)  # type: ignore[no-any-return]
 
 
-class ConditionalGenerator(InvenioConditionalGenerator):
+class ConditionalGenerator(InvenioConditionalGenerator, ABC):
     """Typed conditional generator.
 
     This class will be removed when invenio has proper type stubs.
@@ -58,7 +59,7 @@ class ConditionalGenerator(InvenioConditionalGenerator):
     @abstractmethod
     def _condition(self, **kwargs: Any) -> bool:
         """Condition to choose generators set."""
-        raise NotImplementedError  # pragma: nocover
+        raise NotImplementedError  # pragma: no cover
 
     def _generators(self, record: Record, **kwargs: Any) -> Sequence[InvenioGenerator]:
         """Get the "then" or "else" generators."""
@@ -72,6 +73,52 @@ class ConditionalGenerator(InvenioConditionalGenerator):
     def excludes(self, **kwargs: Any) -> Sequence[Need]:  # type: ignore[override]
         return super().excludes(**kwargs)  # type: ignore[no-any-return]
 
+    @abstractmethod
+    def _query_instate(self, **context: Any) -> dsl.query.Query:
+        raise NotImplementedError  # pragma: no cover
+
     @override
-    def query_filter(self, **kwargs: Any) -> dsl.query.Query:  # type: ignore[reportIncompatibleMethodOverride]
-        return super().query_filter(**kwargs)  # type: ignore[no-any-return]
+    def query_filter(self, **context: Any) -> dsl.query.Query:  # type: ignore[reportIncompatibleMethodOverride]
+        """Apply then or else filter."""
+        then_query = super()._make_query(self.then_, **context)
+        else_query = super()._make_query(self.else_, **context)
+
+        q_instate = self._query_instate(**context)
+        q_outstate = ~q_instate
+
+        if then_query and else_query:
+            ret = (q_instate & then_query) | (q_outstate & else_query)
+        elif then_query:
+            ret = q_instate & then_query
+        elif else_query:
+            ret = q_outstate & else_query
+        else:
+            ret = dsl.Q("match_none")
+
+        return ret
+
+
+class AggregateGenerator(Generator, ABC):
+    """Superclass for generators aggregating multiple generators."""
+
+    @abstractmethod
+    def _generators(self, **context: Any) -> Sequence[InvenioGenerator]:
+        """Return the generators."""
+        raise NotImplementedError  # pragma: no cover
+
+    @override
+    def needs(self, **context: Any) -> Sequence[Need]:
+        """Get the needs from the policy."""
+        needs = [generator.needs(**context) for generator in self._generators(**context)]
+        return list(chain.from_iterable(needs))
+
+    @override
+    def excludes(self, **context: Any) -> Sequence[Need]:
+        """Get the excludes from the policy."""
+        excludes = [generator.excludes(**context) for generator in self._generators(**context)]
+        return list(chain.from_iterable(excludes))
+
+    @override
+    def query_filter(self, **context: Any) -> dsl.query.Query:
+        """Search filters."""
+        return ConditionalGenerator._make_query(self._generators(**context), **context)  # noqa SLF001 # type: ignore[reportReturnType]

oarepo_runtime-2.0.0.dev19/oarepo_runtime/services/records/custom_fields.py

@@ -0,0 +1,44 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+"""Services for updating custom fields mappings in opensearch."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from invenio_records_resources.services.records import (
+    RecordService,
+    RecordServiceConfig,
+)
+
+from oarepo_runtime import current_runtime
+from oarepo_runtime.records.systemfields.custom_fields import (
+    update_record_system_fields_mapping_relation_field,
+)
+
+if TYPE_CHECKING:
+    from invenio_records_resources.services.base import Service
+
+
+def update_all_records_mappings_relation_fields() -> None:
+    """Update all mappings for the registered record classes."""
+    service: Service
+    for service in current_runtime.services.values():
+        if not isinstance(service, RecordService):
+            continue
+
+        config: RecordServiceConfig = service.config
+
+        record_class = getattr(config, "record_cls", None)
+        if record_class:
+            update_record_system_fields_mapping_relation_field(record_class)
+
+        draft_class = getattr(config, "draft_cls", None)
+        if draft_class:
+            update_record_system_fields_mapping_relation_field(draft_class)

oarepo_runtime-2.0.0.dev19/oarepo_runtime/typing.py

@@ -0,0 +1,60 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see http://github.com/oarepo/oarepo-runtime).
+#
+# oarepo-runtime is free software; you can redistribute it and/or modify it
+# under the terms of the MIT License; see LICENSE file for more details.
+#
+
+"""Module for typing related functionality."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+
+def require_kwargs(*kwargs_names: str) -> Any:
+    """Wrap function to require specific kwargs in a function call.
+
+    This decorator is used to fix typing errors in inherited classes where the base class defines kwargs and the
+    inherited class needs to access a specific kwarg.
+
+    Example:
+    ```python
+    # base class
+    class ConditionalGenerator(
+        InvenioConditionalGenerator, ABC
+    ):
+        @abstractmethod
+        def _condition(
+            self, **kwargs: Any
+        ) -> bool: ...
+
+
+    # inherited class
+    class IfRecordHasField(
+        ConditionalGenerator
+    ):
+        @override
+        @require_kwargs("field")
+        def _condition(
+            self, *, field, **kwargs: Any
+        ) -> bool: ...
+    ```
+
+    """
+
+    def wrapper(f: Callable) -> Callable:
+        def wrapped_f(*args: Any, **kwargs: Any) -> Any:
+            for kwarg_name in kwargs_names:
+                if kwarg_name not in kwargs:
+                    raise ValueError(f"Keyword argument {kwarg_name} not found in function call.")
+            return f(*args, **kwargs)
+
+        return wrapped_f
+
+    return wrapper