Use output DTO and ignore all unknown fields

Author: jl-wynen

src/scitacean/_base_model.py

@@ -10,7 +10,6 @@
 from datetime import datetime
 from typing import (
     Any,
-    ClassVar,
     TypeVar,
     overload,
 )
@@ -48,50 +47,6 @@ class DatasetType(str, Enum):  # type: ignore[no-redef]
 class BaseModel(pydantic.BaseModel):
     """Base class for Pydantic models for communication with SciCat."""
 
-    model_config = pydantic.ConfigDict(
-        extra="forbid",
-    )
-
-    _user_mask: ClassVar[tuple[str, ...]]
-    _masked_fields: ClassVar[tuple[str, ...] | None] = None
-
-    # Some schemas contain fields that we don't want to use in Scitacean.
-    # Normally, omitting them from the model would result in an error when
-    # building a model from the JSON returned by SciCat.
-    # The following subclass hook allows models to mark fields as masked.
-    # Those will be silently dropped by __init__.
-    # Note also the comment for _IGNORED_KWARGS below.
-    def __init_subclass__(
-        cls, /, masked: Iterable[str] | None = None, **kwargs: Any
-    ) -> None:
-        super().__init_subclass__(**kwargs)
-        cls._user_mask = tuple(masked) if masked is not None else ()
-
-    def __init__(self, **kwargs: Any) -> None:
-        self._delete_ignored_args(kwargs)
-        super().__init__(**kwargs)
-
-    def _delete_ignored_args(self, args: dict[str, Any]) -> None:
-        if self._masked_fields is None:
-            self._init_mask(self)
-        for key in self._masked_fields:  # type: ignore[union-attr]
-            args.pop(key, None)
-
-    # Initializing the mask requires the field names which
-    # are only available on instances.
-    # So initialization needs to be deferred until the first instantiation of the model.
-    # The mask is cached afterward.
-    @classmethod
-    def _init_mask(cls: type[ModelType], instance: ModelType) -> None:
-        def get_name(name: str, field: Any) -> Any:
-            return field.alias if field.alias is not None else name
-
-        field_names = {
-            get_name(name, field) for name, field in instance.model_fields.items()
-        }
-        default_mask = tuple(key for key in _IGNORED_KWARGS if key not in field_names)
-        cls._masked_fields = cls._user_mask + default_mask
-
     @classmethod
     def user_model_type(cls) -> type[BaseUserModel] | None:
         """Return the user model type for this model.

src/scitacean/_dataset_fields.py

@@ -101,14 +101,12 @@
 from .thumbnail import Thumbnail
 
 
-# TODO remove extra masks after API v4
-class DownloadDataset(
-    BaseModel, masked=("history", "proposalId", "sampleId", "instrumentId")
-):
+class DownloadDataset(BaseModel):
     contactEmail: str | None = None
     creationLocation: str | None = None
     creationTime: datetime | None = None
     inputDatasets: list[PID] | None = None
+    investigator: str | None = None
     numberOfFilesArchived: NonNegativeInt | None = None
     owner: str | None = None
     ownerGroup: str | None = None
@@ -127,7 +125,7 @@ class DownloadDataset(
     description: str | None = None
     endTime: datetime | None = None
     instrumentGroup: str | None = None
-    instrumentIds: list[str] | None = None
+    instrumentId: str | None = None
     isPublished: bool | None = None
     jobLogData: str | None = None
     jobParameters: dict[str, Any] | None = None
@@ -141,9 +139,10 @@ class DownloadDataset(
     ownerEmail: str | None = None
     packedSize: NonNegativeInt | None = None
     pid: PID | None = None
-    proposalIds: list[str] | None = None
+    proposalId: str | None = None
     relationships: list[DownloadRelationship] | None = None
-    sampleIds: list[str] | None = None
+    runNumber: str | None = None
+    sampleId: str | None = None
     sharedWith: list[str] | None = None
     size: NonNegativeInt | None = None
     sourceFolderHost: str | None = None
@@ -167,25 +166,6 @@ def _validate_emails(cls, value: Any) -> Any:
     def _validate_orcids(cls, value: Any) -> Any:
         return validate_orcids(value)
 
-    # TODO remove after API v4
-    @pydantic.field_validator("sampleIds", mode="before")
-    def _validate_sample_ids(cls, value: Any) -> Any:
-        if value == [None]:
-            return []
-        return value
-
-    @pydantic.field_validator("proposalIds", mode="before")
-    def _validate_proposal_ids(cls, value: Any) -> Any:
-        if value == [None]:
-            return []
-        return value
-
-    @pydantic.field_validator("instrumentIds", mode="before")
-    def _validate_instrument_ids(cls, value: Any) -> Any:
-        if value == [None]:
-            return []
-        return value
-
 
 class UploadDerivedDataset(BaseModel):
     contactEmail: str
@@ -198,7 +178,6 @@ class UploadDerivedDataset(BaseModel):
     sourceFolder: RemotePath
     type: DatasetType
     usedSoftware: list[str]
-    datasetName: str
     accessGroups: list[str] | None = None
     classification: str | None = None
     comment: str | None = None
@@ -211,12 +190,14 @@ class UploadDerivedDataset(BaseModel):
     keywords: list[str] | None = None
     license: str | None = None
     scientificMetadata: dict[str, Any] | None = None
+    datasetName: str | None = None
     numberOfFiles: NonNegativeInt | None = None
     orcidOfOwner: str | None = None
     ownerEmail: str | None = None
     packedSize: NonNegativeInt | None = None
     proposalId: str | None = None
     relationships: list[UploadRelationship] | None = None
+    runNumber: str | None = None
     sharedWith: list[str] | None = None
     size: NonNegativeInt | None = None
     sourceFolderHost: str | None = None
@@ -241,15 +222,14 @@ class UploadRawDataset(BaseModel):
     creationLocation: str
     creationTime: datetime
     inputDatasets: list[PID]
+    investigator: str
     numberOfFilesArchived: NonNegativeInt
     owner: str
     ownerGroup: str
     principalInvestigator: str
     sourceFolder: RemotePath
     type: DatasetType
     usedSoftware: list[str]
-    datasetName: str
-    investigator: str | None = None
     accessGroups: list[str] | None = None
     classification: str | None = None
     comment: str | None = None
@@ -265,12 +245,14 @@ class UploadRawDataset(BaseModel):
     keywords: list[str] | None = None
     license: str | None = None
     scientificMetadata: dict[str, Any] | None = None
+    datasetName: str | None = None
     numberOfFiles: NonNegativeInt | None = None
     orcidOfOwner: str | None = None
     ownerEmail: str | None = None
     packedSize: NonNegativeInt | None = None
     proposalId: str | None = None
     relationships: list[UploadRelationship] | None = None
+    runNumber: str | None = None
     sampleId: str | None = None
     sharedWith: list[str] | None = None
     size: NonNegativeInt | None = None

src/scitacean/model.py

@@ -142,6 +142,7 @@
         sourceFolder=RemotePath("/hex/raw1"),
         type=DatasetType.RAW,
         principalInvestigator="investigator 1",
+        investigator="investigator 1",
         creationLocation="UU",
         proposalId="p0124",
         inputDatasets=[],
@@ -159,6 +160,7 @@
         sourceFolder=RemotePath("/hex/raw2"),
         type=DatasetType.RAW,
         principalInvestigator="investigator 2",
+        investigator="investigator 2",
         creationLocation="UU",
         proposalId="p0124",
         inputDatasets=[],
@@ -176,6 +178,7 @@
         sourceFolder=RemotePath("/hex/raw3"),
         type=DatasetType.RAW,
         principalInvestigator="investigator 1",
+        investigator="investigator 1",
         creationLocation="UU",
         proposalId="p0124",
         inputDatasets=[],
@@ -193,6 +196,7 @@
         sourceFolder=RemotePath("/hex/raw4"),
         type=DatasetType.RAW,
         principalInvestigator="investigator X",
+        investigator="investigator X",
         creationLocation="UU",
         inputDatasets=[],
         usedSoftware=[],

src/scitacean/testing/backend/seed.py

@@ -10,7 +10,7 @@
 import dateutil.parser
 import pydantic
 import pytest
-from hypothesis import assume, given, settings
+from hypothesis import given, settings
 from hypothesis import strategies as st
 
 from scitacean import PID, Dataset, DatasetType
@@ -354,6 +354,7 @@ def test_make_raw_model() -> None:
         owner="Ponder Stibbons;Mustrum Ridcully",
         ownerGroup="faculty",
         principalInvestigator="my principal investigator",
+        investigator="my principal investigator",
         sourceFolder=RemotePath("/hex/source62"),
         type=DatasetType.RAW,
         scientificMetadata=None,
@@ -404,67 +405,6 @@ def test_make_derived_model() -> None:
     assert dset.make_upload_model() == expected
 
 
-@pytest.mark.parametrize(
-    "field",
-    (
-        f
-        for f in Dataset.fields(dataset_type="derived", read_only=False)
-        if not f.used_by_raw and f.name not in _UNGENERATABLE_FIELDS
-    ),
-    ids=lambda f: f.name,
-)
-@given(st.data())
-@settings(max_examples=10)
-def test_make_raw_model_raises_if_derived_field_set(
-    field: Dataset.Field, data: st.DataObject
-) -> None:
-    dset = Dataset(
-        type="raw",
-        contact_email="[email protected]",
-        creation_time="2142-04-02T16:44:56",
-        owner="Mustrum Ridcully",
-        owner_group="faculty",
-        principal_investigator="[email protected]",
-        source_folder=RemotePath("/hex/source62"),
-    )
-    val = data.draw(st.from_type(field.type))
-    assume(val is not None)
-    with pytest.raises(pydantic.ValidationError):
-        dset.make_upload_model()
-
-
-@pytest.mark.parametrize(
-    "field",
-    (
-        f
-        for f in Dataset.fields(dataset_type="raw", read_only=False)
-        if not f.used_by_derived and f.name not in _UNGENERATABLE_FIELDS
-    ),
-    ids=lambda f: f.name,
-)
-@given(st.data())
-@settings(max_examples=10)
-def test_make_derived_model_raises_if_raw_field_set(
-    field: Dataset.Field, data: st.DataObject
-) -> None:
-    dset = Dataset(
-        type="derived",
-        contact_email="[email protected]",
-        creation_time="2142-04-02T16:44:56",
-        owner="Ponder Stibbons",
-        owner_group="faculty",
-        investigator="[email protected]",
-        source_folder=RemotePath("/hex/source62"),
-        input_datasets=[PID(pid="623-122")],
-        used_software=["scitacean", "magick"],
-    )
-    val = data.draw(st.from_type(field.type))
-    assume(val is not None)
-    setattr(dset, field.name, val)
-    with pytest.raises(pydantic.ValidationError):
-        dset.make_upload_model()
-
-
 @pytest.mark.parametrize("field", ["contact_email", "owner_email"])
 def test_email_validation(field: Dataset.Field) -> None:
     dset = Dataset(

tests/dataset_fields_test.py

@@ -43,7 +43,7 @@ def raw_download_model() -> model.DownloadDataset:
         description="Some shady data",
         endTime=parse_datetime("1995-08-03T00:00:00Z"),
         instrumentGroup="professors",
-        instrumentIds=["0000-aa"],
+        instrumentId="0000-aa",
         isPublished=True,
         jobLogData=None,
         jobParameters=None,
@@ -55,8 +55,8 @@ def raw_download_model() -> model.DownloadDataset:
         ownerEmail="[email protected]",
         packedSize=0,
         pid=PID.parse("123.cc/948.f7.2a"),
-        proposalIds=["33.dc"],
-        sampleIds=["bac.a4"],
+        proposalId="33.dc",
+        sampleId="bac.a4",
         sharedWith=["librarian"],
         size=400,
         sourceFolderHost="ftp://uu.am/data",
@@ -111,7 +111,7 @@ def derived_download_model() -> model.DownloadDataset:
         description="Dubiously analyzed data",
         endTime=None,
         instrumentGroup="professors",
-        instrumentIds=None,
+        instrumentId=None,
         isPublished=True,
         jobLogData="process interrupted",
         jobParameters={"nodes": 4},
@@ -123,8 +123,8 @@ def derived_download_model() -> model.DownloadDataset:
         ownerEmail="[email protected]",
         packedSize=0,
         pid=PID.parse("123.cc/948.f7.2a"),
-        proposalIds=None,
-        sampleIds=None,
+        proposalId=None,
+        sampleId=None,
         sharedWith=["librarian"],
         size=400,
         sourceFolderHost="ftp://uu.am/data",
@@ -365,11 +365,8 @@ def test_dataset_models_roundtrip(initial: Dataset) -> None:
     # TODO remove in API v4
     rebuilt.investigator = initial.investigator
     rebuilt.proposal_id = initial.proposal_id
-    initial._proposal_ids = rebuilt.proposal_ids  # type: ignore[assignment]
     rebuilt.sample_id = initial.sample_id
-    initial._sample_ids = rebuilt.sample_ids  # type: ignore[assignment]
     rebuilt.instrument_id = initial.instrument_id
-    initial._instrument_ids = rebuilt.instrument_ids  # type: ignore[assignment]
 
     assert initial == rebuilt
 

tests/dataset_test.py

@@ -182,6 +182,7 @@ def test_raw_dataset_default_values(
         owner=scicat_access.user.username,
         ownerGroup=scicat_access.user.group,
         principalInvestigator="[email protected]",
+        investigator="[email protected]",
         sourceFolder=RemotePath("/source/folder"),
         type=DatasetType.RAW,
         usedSoftware=["software1"],
@@ -207,15 +208,15 @@ def test_raw_dataset_default_values(
     assert finalized.createdAt  # some non-empty str
     assert finalized.createdBy  # some non-empty str
     assert finalized.classification  # some non-empty str
-    assert finalized.instrumentIds == []
+    assert finalized.instrumentId is None
     assert finalized.isPublished is False
     assert finalized.keywords == []
     assert finalized.numberOfFiles == 0
     assert finalized.numberOfFilesArchived == 0
     assert finalized.packedSize == 0
     assert finalized.pid  # some non-empty str
-    assert finalized.proposalIds == []
-    assert finalized.sampleIds == []
+    assert finalized.proposalId is None
+    assert finalized.sampleId is None
     assert finalized.scientificMetadata == {}
     assert finalized.sharedWith == []
     assert finalized.size == 0
@@ -271,7 +272,7 @@ def test_fields_override_masks() -> None:
     assert not hasattr(mod, "_id")
 
 
-def test_fields_override_masks_att() -> None:
+def test_fields_override_masks_attachment() -> None:
     # 'id' is masked but the model has a field 'id' without alias
     mod = DownloadAttachment(  # type: ignore[call-arg]
         _id="abc",