oarepo-runtime 2.0.0.dev10__py3-none-any.whl → 2.0.0.dev12__py3-none-any.whl

oarepo_runtime/__init__.py

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

oarepo_runtime/api.py

@@ -27,7 +27,11 @@ if TYPE_CHECKING:
     from flask_resources.responses import ResponseHandler
     from flask_resources.serializers import BaseSerializer
     from invenio_drafts_resources.records.api import Draft
-    from invenio_records_resources.records.api import RecordBase
+    from invenio_records_resources.records.api import Record
+    from invenio_records_resources.records.systemfields.pid import (
+        ModelPIDField,
+        ModelPIDFieldContext,
+    )
     from invenio_records_resources.resources.records.config import RecordResourceConfig
     from invenio_records_resources.resources.records.resource import RecordResource
     from invenio_records_resources.services import (
@@ -72,7 +76,7 @@ class Export:
 class Model[
     S: RecordService = RecordService,
     C: RecordServiceConfig = RecordServiceConfig,
-    R: RecordBase = RecordBase,
+    R: Record = Record,
     D: Draft = Draft,
     # not sure why this is flagged by pyright as an error
     RR: RecordResource = RecordResource,  # pyright: ignore[reportGeneralTypeIssues]
@@ -242,6 +246,39 @@ class Model[
         """Get the API blueprint name for the model."""
         return cast("str", self.resource_config.blueprint_name)
 
+    @property
+    def record_pid_type(self) -> str | None:
+        """Get the PID type for the model."""
+        return self._pid_type_from_record(self.record_cls)
+
+    @property
+    def record_json_schema(self) -> str:
+        """Get the json schema of the record."""
+        return self.record_cls.schema.value  # type: ignore[attr-defined, no-any-return]
+
+    @property
+    def draft_pid_type(self) -> str | None:
+        """Get the PID type for the model."""
+        return self._pid_type_from_record(self.draft_cls)
+
+    def _pid_type_from_record(self, record_cls: type[Record] | None) -> str | None:
+        """Get the PID type from a record class, returning None if not found."""
+        if record_cls is None:
+            return None
+        pid_context: ModelPIDFieldContext | None = getattr(record_cls, "pid", None)
+        if pid_context is None:
+            # registered record has no pid field
+            return None  # pragma: no cover
+        pid_field: ModelPIDField | None = getattr(pid_context, "field", None)
+        if pid_field is None:
+            # there is no pid field in the context
+            return None  # pragma: no cover
+        pid_provider = getattr(pid_field, "_provider", None)
+        if not pid_provider:
+            # there is no pid provider in the field
+            return None  # pragma: no cover
+        return getattr(pid_provider, "pid_type", None)
+
     def api_url(self, view_name: str, **kwargs: Any) -> str:
         """Get the API URL for the model."""
         return cast("str", invenio_url_for(f"{self.api_blueprint_name}.{view_name}", **kwargs))

oarepo_runtime/cli/__init__.py

@@ -24,4 +24,4 @@ def oarepo() -> None:
 
 # register additional commands to the oarepo group
 for ep in entry_points(group="oarepo.cli"):
-    oarepo.add_command(ep.load())
+    oarepo.add_command(ep.load())  # pragma: nocover

oarepo_runtime/cli/search.py

@@ -10,13 +10,13 @@
 
 from __future__ import annotations
 
+from importlib import metadata as importlib_metadata
+
 import click
 from flask.cli import with_appcontext
 from invenio_search.cli import index, search_version_check
 from invenio_search.cli import init as original_init
 
-from oarepo_runtime.services.records.mapping import update_all_records_mappings
-
 
 @index.command()
 @click.option("--force", is_flag=True, default=False)
@@ -31,4 +31,5 @@ def init(ctx: click.Context, force: bool) -> None:
     defined inside the models.
     """
     ctx.invoke(original_init, force=force)
-    update_all_records_mappings()
+    for ep in importlib_metadata.entry_points(group="oarepo.cli.search.init"):
+        ep.load()()

oarepo_runtime/ext.py

@@ -15,13 +15,19 @@ from functools import cached_property
 from typing import TYPE_CHECKING, Any, cast
 
 from flask import current_app
+from invenio_pidstore.errors import PIDDoesNotExistError
+from invenio_pidstore.models import PersistentIdentifier
 from invenio_records_resources.proxies import current_service_registry
-from invenio_records_resources.records.api import RecordBase
+from invenio_records_resources.records.api import Record, RecordBase
 
 from . import config
 
 if TYPE_CHECKING:  # pragma: no cover
+    from collections.abc import Iterable
+    from uuid import UUID
+
     from flask import Flask
+    from invenio_drafts_resources.records.api import Draft
     from invenio_records_resources.services.base.service import Service
     from invenio_records_resources.services.records import RecordService
 
@@ -54,13 +60,104 @@ class OARepoRuntime:
         """Return the models registered in the extension."""
         return cast("dict[str, Model]", current_app.config["OAREPO_MODELS"])
 
+    @property
+    def rdm_models(self) -> Iterable[Model]:
+        """Return the RDM models registered in the extension."""
+        return [v for v in self.models.values() if v.records_alias_enabled]
+
     @cached_property
-    def models_by_record_class(self) -> dict[type[RecordBase], Model]:
+    def models_by_record_class(self) -> dict[type[Record], Model]:
         """Return a mapping of record classes to their models."""
         ret = {model.record_cls: model for model in self.models.values() if model.record_cls is not None}
         ret.update({model.draft_cls: model for model in self.models.values() if model.draft_cls is not None})
         return ret
 
+    @cached_property
+    def record_class_by_pid_type(self) -> dict[str, type[Record]]:
+        """Return a mapping of PID types to their record classes."""
+        ret: dict[str, type[Record]] = {}
+        for model in self.models.values():
+            pid_type = model.record_pid_type
+            if pid_type is not None:
+                ret[pid_type] = model.record_cls
+        return ret
+
+    @cached_property
+    def draft_class_by_pid_type(self) -> dict[str, type[Draft]]:
+        """Return a mapping of PID types to their draft classes."""
+        ret: dict[str, type[Draft]] = {}
+        for model in self.models.values():
+            pid_type = model.draft_pid_type
+            if pid_type is not None and model.draft_cls is not None:
+                ret[pid_type] = model.draft_cls
+        return ret
+
+    @cached_property
+    def model_by_pid_type(self) -> dict[str, Model]:
+        """Return a mapping of PID types to their models."""
+        ret: dict[str, Model] = {}
+        for model in self.models.values():
+            pid_type = model.record_pid_type
+            if pid_type is not None:
+                ret[pid_type] = model
+            pid_type = model.draft_pid_type
+            if pid_type is not None:
+                ret[pid_type] = model
+        return ret
+
+    @cached_property
+    def models_by_schema(self) -> dict[str, Model]:
+        """Return a mapping of schemas to their models."""
+        ret: dict[str, Model] = {}
+        for model in self.models.values():
+            if model.record_cls is not None:
+                ret[model.record_cls.schema.value] = model  # type: ignore  # noqa
+        return ret
+
+    @cached_property
+    def rdm_models_by_schema(self) -> dict[str, Model]:
+        """Return a mapping of RDM schemas to their models."""
+        return {schema: model for schema, model in self.models_by_schema.items() if model.records_alias_enabled}
+
+    def find_pid_type_from_pid(self, pid_value: str) -> str:
+        """Given a PID value, get its associated PID type.
+
+        This method requires that there are no duplicities in the PID values
+        across models.
+        """
+        return cast("str", self._filter_model_pid(pid_value=pid_value).pid_type)
+
+    def find_pid_from_uuid(self, uuid: UUID) -> PersistentIdentifier:
+        """Given an object UUID, get its associated PID."""
+        return self._filter_model_pid(object_uuid=uuid)
+
+    def _filter_model_pid(self, **filter_kwargs: Any) -> PersistentIdentifier:
+        """Filter PIDs based on the provided criteria and return only one that matches.
+
+        Select persistent identifiers from the DB and return the one that is associated
+        with any service registered within oarepo_runtime. If no such PID exists,
+        an error is raised.
+
+        If the filter matches multiple services, an error is raised.
+        """
+        pids = PersistentIdentifier.query.filter_by(**filter_kwargs).all()
+
+        filtered_pids = [pid for pid in pids if pid.pid_type in self.record_class_by_pid_type]
+        if not filtered_pids:
+            raise PIDDoesNotExistError(
+                None,
+                filter_kwargs,
+                "The pid value/record uuid is not associated with any record.",
+            )
+
+        if len(filtered_pids) > 1:
+            raise PIDDoesNotExistError(
+                None,
+                filter_kwargs,
+                f"Multiple records found for pid value/record uuid: {filtered_pids}",
+            )
+        return filtered_pids[0]
+
     @property
     def services(self) -> dict[str, Service]:
         """Return the services registered in the extension."""
@@ -82,3 +179,20 @@ class OARepoRuntime:
                 model = self.models_by_record_class[t]
                 return model.service
         raise KeyError(f"No service found for record class '{record_cls.__name__}'.")
+
+    @cached_property
+    def published_indices(self) -> set[str]:
+        """Return the set of published indices."""
+        indices = set()
+        for model in self.models.values():
+            indices.add(model.record_cls.index.search_alias)  # type: ignore[attr-defined]
+        return indices
+
+    @cached_property
+    def draft_indices(self) -> set[str]:
+        """Return the set of draft indices."""
+        indices = set()
+        for model in self.models.values():
+            if model.draft_cls is not None:
+                indices.add(model.draft_cls.index.search_alias)  # type: ignore[attr-defined]
+        return indices

oarepo_runtime/records/pid_providers.py

@@ -23,7 +23,8 @@ else:
 class UniversalPIDMixin(RecordIdProviderV2):
     """Mixin class to handle creation and management of universal PIDs for records."""
 
-    unpid_pid_type = "unpid"
+    unpid_pid_type = "recid"
+    """Setting this to recid so that RDM can use it."""
     unpid_default_status = PIDStatus.REGISTERED
 
     @classmethod

{oarepo_runtime-2.0.0.dev10.dist-info → oarepo_runtime-2.0.0.dev12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oarepo-runtime
-Version: 2.0.0.dev10
+Version: 2.0.0.dev12
 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.dev10.dist-info → oarepo_runtime-2.0.0.dev12.dist-info}/RECORD

@@ -1,15 +1,15 @@
-oarepo_runtime/__init__.py,sha256=SLhcLrgpH3Ok2tdONg43Mv1K6w88gDaE_rOFkiKshkk,686
-oarepo_runtime/api.py,sha256=P_y8b5AFES0ssv6x_GDg4MtD6TIfoNsOAVMMoiRM560,10330
+oarepo_runtime/__init__.py,sha256=cUIeG2E4Jh0zema7HEQV6ejcTszVyS1-9iVD0XobEjI,686
+oarepo_runtime/api.py,sha256=b4v9YTPLK5EsEXzKuEqnymh148GwxCKNpy34kpxWYrI,11842
 oarepo_runtime/config.py,sha256=RUEPFn_5bKp9Wb0OY-Fb3VK30m35vF5IsLjYaQHhP3g,3838
-oarepo_runtime/ext.py,sha256=AMb5pMnCSbqIpPyP99YUKlf9vopz_b2ZW-RnvfsEVlk,3254
+oarepo_runtime/ext.py,sha256=JbbqMM2H0Sq-umN4506wTpAbo5og954u-8MdG0U-ysU,7833
 oarepo_runtime/proxies.py,sha256=PXaRiBh5qs5-h8M81cJOgtqypFQcYUSjiSn2TLSujRw,648
 oarepo_runtime/py.typed,sha256=RznSCjXReEUI9zkmD25E8XniG_MvPpLBF6MyNZA8MmE,42
-oarepo_runtime/cli/__init__.py,sha256=CgxpiSTZ6-EMSKXzVl3PUa0ClXKzpmWFmjZJnJsxKWg,712
-oarepo_runtime/cli/search.py,sha256=yqYHZauXsDBPpN4odYsPOWNQ9xWmAofQ407EAyqx6CY,1137
+oarepo_runtime/cli/__init__.py,sha256=H7GOeOBf0udgKWOdlAQswIMvRrD8BwcEjOVxIqP0Suw,731
+oarepo_runtime/cli/search.py,sha256=4fHkrjltUUPVUzJiuWaiWxTk62rIYxal3_3jRsZVMmI,1175
 oarepo_runtime/records/__init__.py,sha256=AbWzmVCY7MhrpdEeI0e3lKzeugPMUSo8T08-NBVeig4,339
 oarepo_runtime/records/drafts.py,sha256=CS-dUkrylNwscgBGfDyhwGBRCzwsyT6AA3Mhu40ShbY,1607
 oarepo_runtime/records/mapping.py,sha256=SJbSzerT1645a93-3-Fgz_i3anzFNlrZqbjjwW2ctKs,2660
-oarepo_runtime/records/pid_providers.py,sha256=pVXVeYmAsXy-IEdM2zHZ7UWkAnzXg1gtssfLc9QZbPA,1717
+oarepo_runtime/records/pid_providers.py,sha256=DSpbVB2Z5GxnjhoY7_WJLfUfrr1UsArJye7CXPfEkNI,1773
 oarepo_runtime/records/systemfields/__init__.py,sha256=g-u408qyNnsbUTpDtVVwlcyiJaO68GTjDN0W9rXs9pk,524
 oarepo_runtime/records/systemfields/mapping.py,sha256=66OQavKewJEUMkghymOxvskIO0LUSP2E-MbHryeT5Nk,1968
 oarepo_runtime/records/systemfields/publication_status.py,sha256=1g3VXNPh0FsiPCpe-7ZuaMEF4x8ffrDrt37Rqnjp0ng,2027
@@ -29,8 +29,8 @@ oarepo_runtime/services/records/mapping.py,sha256=y3oeToKEnaRYpMV3q2-2cXNzyzyL3X
 oarepo_runtime/services/schema/__init__.py,sha256=jgAPI_uKC6Ug4KQWnwQVg3-aNaw-eHja323AUFo5ELo,351
 oarepo_runtime/services/schema/i18n.py,sha256=9D1zOQaPKAnYzejB0vO-m2BJYnam0N0Lrq4jID7twfE,3174
 oarepo_runtime/services/schema/i18n_ui.py,sha256=DbusphhGDeaobTt4nuwNgKZ6Houlu4Sv3SuMGkdjRRY,3582
-oarepo_runtime-2.0.0.dev10.dist-info/METADATA,sha256=TTuUBQJsqsf8KzL-KXi-tr8UfiI6fxQgby1do30C4Hw,4495
-oarepo_runtime-2.0.0.dev10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oarepo_runtime-2.0.0.dev10.dist-info/entry_points.txt,sha256=by146BvBlFEJn0MWGJj6pzt-VKFKEALhjh1tloNMtow,198
-oarepo_runtime-2.0.0.dev10.dist-info/licenses/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
-oarepo_runtime-2.0.0.dev10.dist-info/RECORD,,
+oarepo_runtime-2.0.0.dev12.dist-info/METADATA,sha256=fmp7MHpzCupK6BCiZoTBCws1V5gqeLsG1Ol6kcEwVgU,4495
+oarepo_runtime-2.0.0.dev12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oarepo_runtime-2.0.0.dev12.dist-info/entry_points.txt,sha256=rOfs8R1oXFN_dLH9zAZ6ydkvr83mDajegc6NBIRsCMQ,318
+oarepo_runtime-2.0.0.dev12.dist-info/licenses/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
+oarepo_runtime-2.0.0.dev12.dist-info/RECORD,,

{oarepo_runtime-2.0.0.dev10.dist-info → oarepo_runtime-2.0.0.dev12.dist-info}/entry_points.txt

@@ -6,3 +6,6 @@ oarepo_runtime = oarepo_runtime.ext:OARepoRuntime
 
 [invenio_base.apps]
 oarepo_runtime = oarepo_runtime.ext:OARepoRuntime
+
+[oarepo.cli.search.init]
+runtime_update_mappings = oarepo_runtime.services.records.mapping:update_all_records_mappings