oarepo-runtime 1.10.3__py3-none-any.whl → 2.0.0.dev4__py3-none-any.whl

oarepo_runtime/records/__init__.py

@@ -1,50 +1,11 @@
-from typing import Type
-
-from deprecated import deprecated
-from invenio_records_resources.records import Record
-
-
-def select_record_for_update(record_cls: Type[Record], persistent_identifier):
-    """Select a record for update."""
-    resolved_record = record_cls.pid.resolve(persistent_identifier)
-    model_id = resolved_record.model.id
-    obj = record_cls.model_cls.query.filter_by(id=model_id).with_for_update().one()
-    return record_cls(obj.data, model=obj)
-
-
-@deprecated("Moved to oarepo_runtime.services.config.link_conditions")
-def is_published_record_function():
-    """Shortcut for links to determine if record is a published.
-
-    This function is deprecated. Use oarepo_runtime.services.config.is_published_record instead.
-    """
-    from oarepo_runtime.services.config.link_conditions import is_published_record
-
-    return is_published_record()
-
-
-@deprecated("Moved to oarepo_runtime.services.config.link_conditions")
-def is_draft_record_function():
-    """Shortcut for links to determine if record is a draft record.
-
-    This function is deprecated. Use oarepo_runtime.services.config.is_draft_record instead.
-    """
-    from oarepo_runtime.services.config.link_conditions import is_draft_record
-
-    return is_draft_record()
-
-
-@deprecated("Moved to oarepo_runtime.services.config.link_conditions")
-def has_draft_function():
-    """Shortcut for links to determine if record is either a draft or a published one with a draft associated.
-
-    This function is deprecated. Use oarepo_runtime.services.config.has_draft instead.
-    """
-    from oarepo_runtime.services.config.link_conditions import has_draft
-
-    return has_draft()
-
-
-is_published_record = is_published_record_function()
-is_draft = is_draft_record_function()
-has_draft = has_draft_function()
+#
+# 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.
+#
+"""Records module."""
+
+from __future__ import annotations

oarepo_runtime/records/drafts.py

@@ -1,13 +1,29 @@
-from invenio_records_resources.records.api import Record
+#
+# 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.
+#
+"""Record drafts."""
 
-from oarepo_runtime.datastreams.utils import get_record_service_for_record
+from __future__ import annotations
 
+from typing import TYPE_CHECKING
 
-def has_draft(record: Record) -> bool:
+if TYPE_CHECKING:
+    from invenio_records_resources.records.api import RecordBase
+
+from oarepo_runtime.proxies import current_runtime
+
+
+def has_draft(record: RecordBase) -> bool:
+    """Check if record has draft."""
     return get_draft(record) is not None
 
 
-def get_draft(record: Record) -> Record | None:
+def get_draft(record: RecordBase) -> RecordBase | None:
     """Get the draft of a published record, if it exists.
 
     A record can have a draft if:
@@ -19,24 +35,14 @@ def get_draft(record: Record) -> Record | None:
     """
     if getattr(record, "is_draft", False):
         return record
-    if not hasattr(record, "parent"):
-        return None
-    if not hasattr(record, "has_draft"):
+    if not hasattr(record, "parent") or not hasattr(record, "has_draft"):
         return None
 
-    record_service = get_record_service_for_record(record)
-    if not record_service:
-        return None
+    record_service = current_runtime.get_record_service_for_record(record)
 
     try:
-        # if there is no record service, we cannot check for draft
-        if not record_service:
-            return None
-        return next(
-            record_service.config.draft_cls.get_records_by_parent(
-                record.parent, with_deleted=False
-            )
-        )
+        parent = getattr(record, "parent", None)
+        return next(record_service.config.draft_cls.get_records_by_parent(parent, with_deleted=False))
     except StopIteration:
         # no draft found
         return None

oarepo_runtime/records/mapping.py

@@ -0,0 +1,84 @@
+#
+# 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 collections.abc import Iterable
+from typing import TYPE_CHECKING, Any
+
+from invenio_search import current_search_client
+from invenio_search.engine import dsl
+from invenio_search.utils import build_alias_name
+
+from oarepo_runtime.records.systemfields.mapping import MappingSystemFieldMixin
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable
+
+    from invenio_records.api import RecordBase
+
+
+def prefixed_index(index: dsl.Index) -> dsl.Index:
+    """Return a prefixed index for the given index."""
+    return dsl.Index(
+        build_alias_name(
+            index._name,  # type: ignore[attr-defined]  # noqa: SLF001
+        ),
+        using=current_search_client,  # pyright: ignore[reportArgumentType]
+    )
+
+
+def update_record_system_fields_mapping(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 fld in get_mapping_fields(record_class):
+        # get mapping
+        mapping = fld.mapping
+        settings = fld.mapping_settings
+        dynamic_templates = fld.dynamic_templates
+
+        # upload mapping
+        update_record_index(prefixed_index(index), settings, mapping, dynamic_templates)
+
+
+def update_record_index(
+    record_index: dsl.Index,
+    settings: dict,
+    mapping: dict,
+    dynamic_templates: list | None = None,
+) -> None:
+    """Update the index mapping for the given record index."""
+    if settings:
+        record_index.close()
+        record_index.put_settings(body=settings)
+        record_index.open()
+
+    body: dict[str, Any] = {}
+    if mapping:
+        body["properties"] = mapping
+    if dynamic_templates:
+        body["dynamic_templates"] = dynamic_templates
+    if body:
+        record_index.put_mapping(body=body)
+
+
+def get_mapping_fields(
+    record_class: type[RecordBase],
+) -> Iterable[MappingSystemFieldMixin]:
+    """Get all mapping fields from the record class."""
+    return (attr for _, attr in inspect.getmembers(record_class, lambda x: isinstance(x, MappingSystemFieldMixin)))

oarepo_runtime/records/pid_providers.py

@@ -1,17 +1,53 @@
+#
+# 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.
+#
+"""PID providers."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Self, cast
+
 from invenio_pidstore.models import PersistentIdentifier, PIDStatus
 
+if TYPE_CHECKING:
+    from invenio_pidstore.providers.recordid_v2 import RecordIdProviderV2
+else:
+    RecordIdProviderV2 = object
+
+
+class UniversalPIDMixin(RecordIdProviderV2):
+    """Mixin class to handle creation and management of universal PIDs for records."""
 
-class UniversalPIDMixin:
     unpid_pid_type = "unpid"
     unpid_default_status = PIDStatus.REGISTERED
 
     @classmethod
-    def create(cls, object_type=None, object_uuid=None, options=None, **kwargs):
-        pid = super().create(
-            object_type=object_type, object_uuid=object_uuid, options=options, **kwargs
+    def create(  # type: ignore[override]
+        cls,
+        object_type: str | None = None,
+        object_uuid: str | None = None,
+        options: dict | None = None,
+        **kwargs: Any,
+    ) -> Self:
+        """Create PID for a given object and store it."""
+        pid = cast(
+            "Self",
+            super().create(
+                object_type=object_type,
+                object_uuid=object_uuid,
+                options=options,
+                **kwargs,
+            ),
         )
-        assert pid.pid.pid_value is not None
-        control_pid = PersistentIdentifier.create(
+        if pid.pid.pid_value is None:
+            raise ValueError("PID value cannot be None.")  # pragma: no cover
+
+        PersistentIdentifier.create(
             cls.unpid_pid_type,
             pid.pid.pid_value,
             pid_provider=None,
@@ -19,4 +55,4 @@ class UniversalPIDMixin:
             object_uuid=object_uuid,
             status=cls.unpid_default_status,
         )
-        return pid
+        return pid

oarepo_runtime/records/systemfields/__init__.py

@@ -1,34 +1,16 @@
-from .icu import (
-    FulltextIndexField,
-    ICUField,
-    ICUSearchField,
-    ICUSortField,
-    ICUSuggestField,
-    TermIndexField,
-)
-from .mapping import MappingSystemFieldMixin, SystemFieldDumperExt
-from .selectors import (
-    FilteredSelector,
-    FirstItemSelector,
-    MultiSelector,
-    PathSelector,
-    Selector,
-)
-from .synthetic import SyntheticSystemField
+#
+# 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.
+#
+"""Records system fields."""
 
-__all__ = (
-    "ICUField",
-    "ICUSuggestField",
-    "ICUSortField",
-    "ICUSearchField",
-    "FulltextIndexField",
-    "MappingSystemFieldMixin",
-    "SystemFieldDumperExt",
-    "SyntheticSystemField",
-    "PathSelector",
-    "Selector",
-    "FirstItemSelector",
-    "FilteredSelector",
-    "MultiSelector",
-    "TermIndexField",
-)
+from __future__ import annotations
+
+from .mapping import MappingSystemFieldMixin
+from .publication_status import PublicationStatusSystemField
+
+__all__ = ("MappingSystemFieldMixin", "PublicationStatusSystemField")

oarepo_runtime/records/systemfields/mapping.py

@@ -1,39 +1,56 @@
-import inspect
+#
+# 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.
+#
+"""System fields mapping."""
 
-from invenio_records.dumpers import SearchDumperExt
+from __future__ import annotations
 
+from typing import TYPE_CHECKING, override
+
+if TYPE_CHECKING:
+    from invenio_records.api import RecordBase
+    from invenio_records.dumpers import Dumper
+    from invenio_records.systemfields import SystemField
+else:
+    SystemField = object
+
+
+class MappingSystemFieldMixin(SystemField):
+    """Mixin class that provides default mapping, mapping settings, and dynamic templates for system fields."""
 
-class MappingSystemFieldMixin:
     @property
-    def mapping(self):
+    def mapping(self) -> dict:
+        """Return the default mapping for the system field."""
         return {}
 
     @property
-    def mapping_settings(self):
+    def mapping_settings(self) -> dict:
+        """Return the default mapping settings for the system field."""
         return {}
 
     @property
-    def dynamic_templates(self):
+    def dynamic_templates(self) -> list:
+        """Return the default dynamic templates for the system field."""
         return []
 
-    def search_dump(self, data, record):
-        """Dump custom field."""
-
-    def search_load(self, data, record_cls):
-        """Load custom field."""
+    # The following methods are added just for typing purposes.
+    @override
+    def pre_dump(self, record: RecordBase, data: dict, dumper: Dumper | None = None) -> None:  # type: ignore[misc]
+        """Dump record to the data - pre-dump phase."""
 
+    @override
+    def post_dump(self, record: RecordBase, data: dict, dumper: Dumper | None = None) -> None:  # type: ignore[misc]
+        """Dump record to the data - post-dump phase."""
 
-class SystemFieldDumperExt(SearchDumperExt):
-    def dump(self, record, data):
-        """Dump custom fields."""
-        for cf in inspect.getmembers(
-            type(record), lambda x: isinstance(x, MappingSystemFieldMixin)
-        ):
-            cf[1].search_dump(data, record=record)
+    @override
+    def pre_load(self, data: dict, loader: Dumper | None = None) -> None:  # type: ignore[misc]
+        """Load record from the data - pre-load phase."""
 
-    def load(self, data, record_cls):
-        """Load custom fields."""
-        for cf in inspect.getmembers(
-            record_cls, lambda x: isinstance(x, MappingSystemFieldMixin)
-        ):
-            cf[1].search_load(data, record_cls=record_cls)
+    @override
+    def post_load(self, record: RecordBase, data: dict, loader: Dumper | None = None) -> None:  # type: ignore[misc]
+        """Load record from the data - post-load phase."""

oarepo_runtime/records/systemfields/publication_status.py

@@ -0,0 +1,61 @@
+#
+# 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.
+#
+"""Record status module."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, override
+
+from invenio_records.systemfields import SystemField
+
+from .mapping import MappingSystemFieldMixin
+
+if TYPE_CHECKING:
+    from invenio_records.api import RecordBase
+    from invenio_records.dumpers import Dumper
+
+
+class PublicationStatusSystemField(MappingSystemFieldMixin, SystemField):
+    """A system field to track the status of a record (either 'draft' or 'published').
+
+    The default key for this field is 'publication_status', but it can be customized.
+    """
+
+    def __init__(self, key: str | None = "publication_status"):
+        """Initialize the system field with an optional key."""
+        super().__init__(key)
+
+    @property
+    def mapping(self) -> dict:
+        """Return the mapping for the field in the search index."""
+        return {
+            self.key: {
+                "type": "keyword",
+            },
+        }
+
+    @override
+    def post_load(self, record: RecordBase, data: dict, loader: Dumper | None = None) -> None:
+        data.pop(self.key, None)
+
+    @override
+    def post_dump(self, record: RecordBase, data: dict, dumper: Dumper | None = None) -> None:
+        if self.key is None:
+            return  # pragma: no cover
+        if not self.attr_name:
+            raise ValueError(  # pragma: no cover
+                "attr_name must be set for PublicationStatusSystemField"
+            )
+        data[self.key] = getattr(record, self.attr_name)
+
+    def __get__(self, record: RecordBase | None, owner: Any = None) -> Any:
+        """Access the attribute."""
+        if record is None:
+            return self
+        return "draft" if getattr(record, "is_draft", False) else "published"

oarepo_runtime/services/__init__.py

@@ -0,0 +1,12 @@
+#
+# 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 module."""
+
+from __future__ import annotations

oarepo_runtime/services/config/__init__.py

@@ -1,35 +1,29 @@
-from .draft_link import DraftLink
+#
+# 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.
+#
+"""Service config module."""
+
+from __future__ import annotations
+
 from .link_conditions import (
     has_draft,
     has_draft_permission,
-    has_file_permission,
     has_permission,
-    has_permission_file_service,
     has_published_record,
-    is_draft_record,
     is_published_record,
 )
-from .permissions_presets import (
-    AuthenticatedPermissionPolicy,
-    EveryonePermissionPolicy,
-    OaiHarvesterPermissionPolicy,
-    ReadOnlyPermissionPolicy,
-)
-from .service import PermissionsPresetsConfigMixin
+from .permissions import EveryonePermissionPolicy
 
 __all__ = (
-    "PermissionsPresetsConfigMixin",
-    "OaiHarvesterPermissionPolicy",
-    "ReadOnlyPermissionPolicy",
     "EveryonePermissionPolicy",
-    "AuthenticatedPermissionPolicy",
-    "is_published_record",
-    "is_draft_record",
     "has_draft",
+    "has_draft_permission",
     "has_permission",
-    "has_permission_file_service",
-    "has_file_permission",
     "has_published_record",
-    "has_draft_permission",
-    "DraftLink",
+    "is_published_record",
 )