oarepo-runtime 2.0.0.dev28__py3-none-any.whl → 2.0.0.dev30__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.0dev28"
+__version__ = "2.0.0dev30"
 
 __all__ = ("Model", "OARepoRuntime", "__version__", "current_runtime")

oarepo_runtime/api.py

@@ -24,6 +24,7 @@ if TYPE_CHECKING:
     from collections.abc import Mapping
 
     from flask_babel.speaklater import LazyString
+    from flask_resources.deserializers import DeserializerMixin
     from flask_resources.responses import ResponseHandler
     from flask_resources.serializers import BaseSerializer
     from invenio_drafts_resources.records.api import Draft
@@ -92,6 +93,26 @@ class Export:
     """Description of the export format, human readable."""
 
 
+@dataclasses.dataclass
+class Import:
+    """Configuration of an import format."""
+
+    code: str
+    """Code of the import format, used to identify the import format in the URL."""
+
+    name: LazyString
+    """Name of the import format, human readable."""
+
+    mimetype: str
+    """MIME type of the import format."""
+
+    deserializer: DeserializerMixin
+    """Deserializer used to deserialize the record into the import format."""
+
+    description: LazyString | None = None
+    """Description of the import format, human readable."""
+
+
 class Model[
     S: RecordService = RecordService,
     C: RecordServiceConfig = RecordServiceConfig,
@@ -131,6 +152,7 @@ class Model[
         records_alias_enabled: bool = True,
         model_metadata: ModelMetadata | None = None,
         features: Mapping[str, Any] | None = None,
+        imports: list[Import] | None = None,
     ):
         """Initialize the model configuration.
 
@@ -155,6 +177,8 @@ class Model[
             Such models will be searchable via the `/api/records` endpoint.
         :param model_metadata: Metadata of the model.
         :param features: Features of the model. Filled by the feature presets themselves during registration.
+        :param imports: List of import formats that can be used to import the record.
+            If not provided, no imports are available.
         """
         self._code = code
         self._name = name
@@ -176,6 +200,7 @@ class Model[
         self._resource = resource
         self._resource_config = resource_config
         self._exports = exports or []
+        self._imports = imports or []
         self._model_metadata = model_metadata
         self._features = features
 
@@ -358,3 +383,8 @@ class Model[
     def features(self) -> Mapping[str, Any] | None:
         """Get a mapping of features."""
         return self._features
+
+    @property
+    def imports(self) -> list[Import]:
+        """Get all importable request body parsers."""
+        return self._imports

oarepo_runtime/proxies.py

@@ -20,6 +20,10 @@ from werkzeug.local import LocalProxy
 if TYPE_CHECKING:
     from oarepo_runtime.ext import OARepoRuntime
 
-current_runtime: LocalProxy[OARepoRuntime] = LocalProxy(lambda: current_app.extensions["oarepo-runtime"])  # type: ignore[assignment]
+    current_runtime: OARepoRuntime  # type: ignore[reportRedeclaration]
 
-current_timezone: ContextVar = ContextVar("timezone")  # idk how or exactly why to use the LocalProxy here
+# note: mypy does not understand LocalProxy[OARepoRuntime], so we type it as OARepoRuntime
+# and ignore the redeclaration error
+current_runtime = LocalProxy(lambda: current_app.extensions["oarepo-runtime"])  # type: ignore[assignment]
+
+current_timezone: ContextVar = ContextVar("timezone")

oarepo_runtime/resources/config.py

@@ -13,13 +13,14 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+from flask_resources import RequestBodyParser
 from flask_resources.responses import ResponseHandler
 from invenio_records_resources.resources.records.headers import etag_headers
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
 
-    from oarepo_runtime.api import Export
+    from oarepo_runtime.api import Export, Import
 
 
 def exports_to_response_handlers(
@@ -33,3 +34,10 @@ def exports_to_response_handlers(
         )
         for export in exports
     }
+
+
+def imports_to_request_body_parsers(
+    imports: Iterable[Import],
+) -> dict[str, RequestBodyParser]:
+    """Convert imports to a dictionary of mimetype -> request body parsers."""
+    return {import_option.mimetype: RequestBodyParser(import_option.deserializer) for import_option in imports}

{oarepo_runtime-2.0.0.dev28.dist-info → oarepo_runtime-2.0.0.dev30.dist-info}/METADATA

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

@@ -1,8 +1,8 @@
-oarepo_runtime/__init__.py,sha256=SB5ZZKCuzkUbuBlw_ngzm1suKgwrWG8OMXF4hw49T5Y,686
-oarepo_runtime/api.py,sha256=5MjhNwwjbbS7w7aql6pg8haKvqqr8QBmZBqJkWRWEw4,13237
+oarepo_runtime/__init__.py,sha256=ETP5uM63MsDXj1RW_UvU0-87uGZCq3M0LRJKBevovYQ,686
+oarepo_runtime/api.py,sha256=tLPgKv1iao2ZeL0tTJeA85019_sMW_dQAleayOeXjgI,14200
 oarepo_runtime/config.py,sha256=RUEPFn_5bKp9Wb0OY-Fb3VK30m35vF5IsLjYaQHhP3g,3838
 oarepo_runtime/ext.py,sha256=NgiRNl_hwTvEWcXnNwVh_XCPJyvwr3dZkdPmkWvN1xo,8785
-oarepo_runtime/proxies.py,sha256=JhOklHoJO8-gPamvjY6jtF9tlOrvcuBXG9kVHPO-x3Q,782
+oarepo_runtime/proxies.py,sha256=x8Y1iTP8QIzSI67s90VR0_5fvXuT1xlJXtAHsaoXFwg,903
 oarepo_runtime/py.typed,sha256=RznSCjXReEUI9zkmD25E8XniG_MvPpLBF6MyNZA8MmE,42
 oarepo_runtime/typing.py,sha256=vH8UUb4QTJowuvibwHaOOEwxx8i21LcOeplxJl0Yrew,1594
 oarepo_runtime/cli/__init__.py,sha256=H7GOeOBf0udgKWOdlAQswIMvRrD8BwcEjOVxIqP0Suw,731
@@ -19,7 +19,7 @@ oarepo_runtime/records/systemfields/mapping.py,sha256=HC9QnY6J6Ftw-DwotKUTvnyRif
 oarepo_runtime/records/systemfields/publication_status.py,sha256=1g3VXNPh0FsiPCpe-7ZuaMEF4x8ffrDrt37Rqnjp0ng,2027
 oarepo_runtime/records/systemfields/selectors.py,sha256=ijVDwAXaXTV5NtcXsrALkhddgCogLNe2eEscFr23qyg,1656
 oarepo_runtime/resources/__init__.py,sha256=voynQULXoOEviADkbOpekMphZPTAz4IOTg5BF9xPwTM,453
-oarepo_runtime/resources/config.py,sha256=hJewyZ2FlEm4TtYnQS9JsnKnA6hhtSbvo1PC24-7f7Y,980
+oarepo_runtime/resources/config.py,sha256=Lbx1QPWAJ8z1truhYntbnhGGWp2OCcwqKm6BuvPJNT0,1330
 oarepo_runtime/services/__init__.py,sha256=OGtBgEeaDTyk2RPDNXuKbU9_7egFBZr42SM0gN5FrF4,341
 oarepo_runtime/services/generators.py,sha256=8Z2QGzob4c2vaaNqhcMZsRybmwtOt30Plgf3EFmcJXw,4622
 oarepo_runtime/services/results.py,sha256=qzoIQW5-ShL1YJDgPjfTlPnsgfEZhojNehhHNTUxRgI,7120
@@ -41,8 +41,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=6HPRMOytE7UQnGd4Z21kvYTpX5p_g2TmP2_v4pwkU8w,4524
-oarepo_runtime-2.0.0.dev28.dist-info/METADATA,sha256=p_h3OTOgDOBbAPP19O2iOVtCxMf7dc48yVRcz42O1yY,4723
-oarepo_runtime-2.0.0.dev28.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oarepo_runtime-2.0.0.dev28.dist-info/entry_points.txt,sha256=rOfs8R1oXFN_dLH9zAZ6ydkvr83mDajegc6NBIRsCMQ,318
-oarepo_runtime-2.0.0.dev28.dist-info/licenses/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
-oarepo_runtime-2.0.0.dev28.dist-info/RECORD,,
+oarepo_runtime-2.0.0.dev30.dist-info/METADATA,sha256=yyR8GUfH0IbW4L0KQDM0f7QRN7QH2iu43R8JcgXiAko,4723
+oarepo_runtime-2.0.0.dev30.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oarepo_runtime-2.0.0.dev30.dist-info/entry_points.txt,sha256=rOfs8R1oXFN_dLH9zAZ6ydkvr83mDajegc6NBIRsCMQ,318
+oarepo_runtime-2.0.0.dev30.dist-info/licenses/LICENSE,sha256=h2uWz0OaB3EN-J1ImdGJZzc7yvfQjvHVYdUhQ-H7ypY,1064
+oarepo_runtime-2.0.0.dev30.dist-info/RECORD,,