oarepo-runtime 2.0.0.dev33__py3-none-any.whl → 2.0.0.dev35__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.0dev33"
+__version__ = "2.0.0dev35"
 
 __all__ = ("Model", "OARepoRuntime", "__version__", "current_runtime")

oarepo_runtime/api.py

@@ -310,10 +310,10 @@ class Model[
     @property
     def record_json_schema(self) -> str:
         """Get the json schema of the record."""
-        schema: ConstantField[Record, str] | None = getattr(self.record_cls, "schema", None)
+        schema: ConstantField | None = getattr(self.record_cls, "schema", None)
         if schema is None:
             raise KeyError(f"Record class {self.record_cls} does not have a schema field.")  # pragma: no cover
-        return schema.value  # type: ignore[no-any-return]
+        return cast("str", schema.value)
 
     @property
     def draft_pid_type(self) -> str | None:

oarepo_runtime/info/views.py

@@ -256,7 +256,7 @@ class InfoResource(BaseResource):
             can_export: bool = True,
             can_deposit: bool = False,
         ) -> dict:
-            schema_field = cast("ConstantField[Record, str] | None", getattr(record, "schema", None))
+            schema_field = cast("ConstantField | None", getattr(record, "schema", None))
             if schema_field is not None:
                 schema_field_value = schema_field.value
                 schema_path = base_url + schema_field_value.replace("local://", "")

oarepo_runtime/records/systemfields/__init__.py

@@ -10,7 +10,12 @@
 
 from __future__ import annotations
 
+from .base import TypedSystemField
 from .mapping import MappingSystemFieldMixin
 from .publication_status import PublicationStatusSystemField
 
-__all__ = ("MappingSystemFieldMixin", "PublicationStatusSystemField")
+__all__ = (
+    "MappingSystemFieldMixin",
+    "PublicationStatusSystemField",
+    "TypedSystemField",
+)

oarepo_runtime/records/systemfields/base.py

@@ -0,0 +1,45 @@
+#
+# Copyright (c) 2025 CESNET z.s.p.o.
+#
+# This file is a part of oarepo-runtime (see https://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.
+#
+"""Base typed system field implementation."""
+
+from __future__ import annotations
+
+from typing import Any, Self, overload
+
+from invenio_records.api import Record
+from invenio_records.extensions import ExtensionMixin
+from invenio_records.systemfields import SystemField
+
+
+class TypedSystemField[R: Record = Record, V: Any = Any](SystemField, ExtensionMixin):
+    """Base class for typed system fields."""
+
+    @overload
+    def __get__(self, instance: None, owner: type[R]) -> Self: ...
+
+    @overload
+    def __get__(self, instance: R, owner: type[R]) -> V: ...
+
+    def __get__(self, instance: R | None, owner: type[R]) -> Self | V:  # type: ignore[override]
+        """Get the value of the field."""
+        if instance is None:  # pragma: no cover
+            return self  # pragma: no cover
+        raise NotImplementedError  # pragma: no cover
+
+    @overload
+    def __set__(self, instance: None, value: Self) -> None: ...
+
+    @overload
+    def __set__(self, instance: R, value: V) -> None: ...
+
+    def __set__(self, instance: R | None, value: V | Self) -> None:  # type: ignore[override]
+        """Set the value of the field."""
+        if instance is None:  # pragma: no cover
+            raise ValueError("Cannot set value on class.")  # pragma: no cover
+        raise NotImplementedError  # pragma: no cover

oarepo_runtime/records/systemfields/mapping.py

@@ -10,17 +10,15 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, override
+from typing import TYPE_CHECKING
+
+from invenio_records.api import Record
 
 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):
+class MappingSystemFieldMixin[R: Record = Record]:
     """Mixin class that provides default mapping, mapping settings, and dynamic templates for system fields."""
 
     @property
@@ -39,18 +37,14 @@ class MappingSystemFieldMixin(SystemField):
         return []
 
     # The following methods are added just for typing purposes.
-    @override
-    def pre_dump(self, record: RecordBase, data: dict, dumper: Dumper | None = None) -> None:
+    def pre_dump(self, record: R, data: dict, dumper: Dumper | None = None) -> None:
         """Dump record to the data - pre-dump phase."""
 
-    @override
-    def post_dump(self, record: RecordBase, data: dict, dumper: Dumper | None = None) -> None:
+    def post_dump(self, record: R, data: dict, dumper: Dumper | None = None) -> None:
         """Dump record to the data - post-dump phase."""
 
-    @override
     def pre_load(self, data: dict, loader: Dumper | None = None) -> None:
         """Load record from the data - pre-load phase."""
 
-    @override
-    def post_load(self, record: RecordBase, data: dict, loader: Dumper | None = None) -> None:
+    def post_load(self, record: R, data: dict, loader: Dumper | None = None) -> None:
         """Load record from the data - post-load phase."""

oarepo_runtime/records/systemfields/publication_status.py

@@ -10,18 +10,18 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, override
+from typing import TYPE_CHECKING, Self, override
 
-from invenio_records.systemfields import SystemField
+from invenio_records.api import Record
 
+from .base import TypedSystemField
 from .mapping import MappingSystemFieldMixin
 
 if TYPE_CHECKING:
-    from invenio_records.api import RecordBase
     from invenio_records.dumpers import Dumper
 
 
-class PublicationStatusSystemField(MappingSystemFieldMixin, SystemField):
+class PublicationStatusSystemField(MappingSystemFieldMixin, TypedSystemField[Record, str]):
     """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.
@@ -41,21 +41,20 @@ class PublicationStatusSystemField(MappingSystemFieldMixin, SystemField):
         }
 
     @override
-    def post_load(self, record: RecordBase, data: dict, loader: Dumper | None = None) -> None:
+    def post_load(self, record: Record, 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
+    def post_dump(self, record: Record, data: dict, dumper: Dumper | None = None) -> None:
         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:
+    @override
+    def __get__(self, instance: Record | None, owner: type[Record]) -> Self | str:  # type: ignore[override]
         """Access the attribute."""
-        if record is None:
+        if instance is None:
             return self
-        return "draft" if getattr(record, "is_draft", False) else "published"
+        return "draft" if getattr(instance, "is_draft", False) else "published"

{oarepo_runtime-2.0.0.dev33.dist-info → oarepo_runtime-2.0.0.dev35.dist-info}/METADATA

@@ -1,15 +1,15 @@
 Metadata-Version: 2.4
 Name: oarepo-runtime
-Version: 2.0.0.dev33
+Version: 2.0.0.dev35
 Summary: A set of runtime extensions of Invenio repository
 Project-URL: Homepage, https://github.com/oarepo/oarepo-runtime
 License-Expression: MIT
 License-File: LICENSE
 Requires-Python: <3.14,>=3.13
 Requires-Dist: langcodes>=3.5.0
+Requires-Dist: oarepo-invenio-typing-stubs>=0.1.0
 Requires-Dist: oarepo[rdm,tests]<15,>=13
 Provides-Extra: dev
-Requires-Dist: oarepo-invenio-typing-stubs>=0.1.0; extra == 'dev'
 Requires-Dist: pytest>=7.1.2; extra == 'dev'
 Provides-Extra: oarepo13
 Requires-Dist: oarepo[rdm]<14,>=13; extra == 'oarepo13'

{oarepo_runtime-2.0.0.dev33.dist-info → oarepo_runtime-2.0.0.dev35.dist-info}/RECORD

@@ -1,5 +1,5 @@
-oarepo_runtime/__init__.py,sha256=Yyknq93rocqlDSiPoWRbMXKm60R9oaLNgvJ3nO3ABMY,686
-oarepo_runtime/api.py,sha256=tLPgKv1iao2ZeL0tTJeA85019_sMW_dQAleayOeXjgI,14200
+oarepo_runtime/__init__.py,sha256=VGinT5vziEg9nmT32QIwedHQ1YgRBlV5EXie4fjixkM,686
+oarepo_runtime/api.py,sha256=6AHyFnf0Cg1nfhGaQFMPjynVvrp1UURo8vX5vb5LvC4,14169
 oarepo_runtime/config.py,sha256=RUEPFn_5bKp9Wb0OY-Fb3VK30m35vF5IsLjYaQHhP3g,3838
 oarepo_runtime/ext.py,sha256=NgiRNl_hwTvEWcXnNwVh_XCPJyvwr3dZkdPmkWvN1xo,8785
 oarepo_runtime/proxies.py,sha256=x8Y1iTP8QIzSI67s90VR0_5fvXuT1xlJXtAHsaoXFwg,903
@@ -8,15 +8,16 @@ oarepo_runtime/typing.py,sha256=vH8UUb4QTJowuvibwHaOOEwxx8i21LcOeplxJl0Yrew,1594
 oarepo_runtime/cli/__init__.py,sha256=H7GOeOBf0udgKWOdlAQswIMvRrD8BwcEjOVxIqP0Suw,731
 oarepo_runtime/cli/search.py,sha256=4fHkrjltUUPVUzJiuWaiWxTk62rIYxal3_3jRsZVMmI,1175
 oarepo_runtime/info/__init__.py,sha256=qRG3mSyoiw7sKm9StiuBJs6l15HrdAQ4sphsAQsJtQc,336
-oarepo_runtime/info/views.py,sha256=-ZBKkJgzaaYDU5cS7DuG5Cem4M42ohQ-LN6BaCXjo1I,16967
+oarepo_runtime/info/views.py,sha256=JwESs-KVq163OBeqWVwfy0RU4WXR_MBolVR7W-dGtm0,16954
 oarepo_runtime/records/__init__.py,sha256=AbWzmVCY7MhrpdEeI0e3lKzeugPMUSo8T08-NBVeig4,339
 oarepo_runtime/records/drafts.py,sha256=b45ROjd9lwy6ratrpAruimcKvQmJradk5JgILoBAHmY,1965
 oarepo_runtime/records/mapping.py,sha256=fn6M208axxBqHtRV6qKQukwUw1z0hq_KF4qfuB2rr98,2630
 oarepo_runtime/records/pid_providers.py,sha256=DE8uW-QmJumA9OqWksDOydezjJ9LLC296CRa0zDrlEc,1747
-oarepo_runtime/records/systemfields/__init__.py,sha256=g-u408qyNnsbUTpDtVVwlcyiJaO68GTjDN0W9rXs9pk,524
+oarepo_runtime/records/systemfields/__init__.py,sha256=tJzOOQ8dBlCyD8tCAriIUZggZ73UjMyMOp6IlSV-Tb4,594
+oarepo_runtime/records/systemfields/base.py,sha256=EWSdVsWePkdwksRQ9yaMMk9Mrhicw-ZE0vdApn2EjWQ,1602
 oarepo_runtime/records/systemfields/custom_fields.py,sha256=PEoaCEnvanysFQAaqTtD9-VwaBmnFkoP2pmpCl9ZFfI,2237
-oarepo_runtime/records/systemfields/mapping.py,sha256=HC9QnY6J6Ftw-DwotKUTvnyRif7XHhMKdZfSTDJJqSk,1880
-oarepo_runtime/records/systemfields/publication_status.py,sha256=1g3VXNPh0FsiPCpe-7ZuaMEF4x8ffrDrt37Rqnjp0ng,2027
+oarepo_runtime/records/systemfields/mapping.py,sha256=GcNp_-Ho3G8nk4-SXgoWWk_IPdGsM0LZ-DBl5fnYJvE,1699
+oarepo_runtime/records/systemfields/publication_status.py,sha256=5D8L_-Wsf-Or-Er7EhuOnwzXfGY28TRPTg1XmMEKxM8,1995
 oarepo_runtime/records/systemfields/selectors.py,sha256=ijVDwAXaXTV5NtcXsrALkhddgCogLNe2eEscFr23qyg,1656
 oarepo_runtime/resources/__init__.py,sha256=voynQULXoOEviADkbOpekMphZPTAz4IOTg5BF9xPwTM,453
 oarepo_runtime/resources/config.py,sha256=Lbx1QPWAJ8z1truhYntbnhGGWp2OCcwqKm6BuvPJNT0,1330
@@ -41,8 +42,8 @@ oarepo_runtime/services/schema/__init__.py,sha256=jgAPI_uKC6Ug4KQWnwQVg3-aNaw-eH
 oarepo_runtime/services/schema/i18n.py,sha256=9D1zOQaPKAnYzejB0vO-m2BJYnam0N0Lrq4jID7twfE,3174
 oarepo_runtime/services/schema/i18n_ui.py,sha256=DbusphhGDeaobTt4nuwNgKZ6Houlu4Sv3SuMGkdjRRY,3582
 oarepo_runtime/services/schema/ui.py,sha256=Y_jBO-fowkpOgceWz8aqJSJAUiAnKLGSIuNpjNLnp8Q,4612
-oarepo_runtime-2.0.0.dev33.dist-info/METADATA,sha256=I1Ojqa6TlUdZEkdhaG4i8CqqzQzvU_ZemZoPGFLLmfk,4723
-oarepo_runtime-2.0.0.dev33.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oarepo_runtime-2.0.0.dev33.dist-info/entry_points.txt,sha256=rOfs8R1oXFN_dLH9zAZ6ydkvr83mDajegc6NBIRsCMQ,318
-oarepo_runtime-2.0.0.dev33.dist-info/licenses/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
-oarepo_runtime-2.0.0.dev33.dist-info/RECORD,,
+oarepo_runtime-2.0.0.dev35.dist-info/METADATA,sha256=xI4aL-6OK_IN3C5QVz-uXcuKH48Tw9h80-ZvJOFUoFI,4707
+oarepo_runtime-2.0.0.dev35.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oarepo_runtime-2.0.0.dev35.dist-info/entry_points.txt,sha256=rOfs8R1oXFN_dLH9zAZ6ydkvr83mDajegc6NBIRsCMQ,318
+oarepo_runtime-2.0.0.dev35.dist-info/licenses/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
+oarepo_runtime-2.0.0.dev35.dist-info/RECORD,,