oarepo-runtime 2.0.0.dev29__tar.gz → 2.0.0.dev30__tar.gz

{oarepo_runtime-2.0.0.dev29 → oarepo_runtime-2.0.0.dev30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oarepo-runtime
-Version: 2.0.0.dev29
+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.dev29 → oarepo_runtime-2.0.0.dev30}/oarepo_runtime/__init__.py

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

{oarepo_runtime-2.0.0.dev29 → oarepo_runtime-2.0.0.dev30}/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-2.0.0.dev29 → oarepo_runtime-2.0.0.dev30}/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}