Skip to content

dataset

DatasetExportV2

Bases: BaseModel

Class for Dataset export.

Attributes:

Name Type Description
name str
zarr_dir str
images list[SingleImage]
Source code in fractal_server/app/schemas/v2/dataset.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
class DatasetExportV2(BaseModel):
    """
    Class for `Dataset` export.

    Attributes:
        name:
        zarr_dir:
        images:
    """

    name: str
    zarr_dir: str
    images: list[SingleImage]

DatasetImportV2

Bases: BaseModel

Class for Dataset import.

We are dropping model_config = ConfigDict(extra="forbid") so that any kind of legacy filters can be included in the payload, and ignored in the API.

Attributes:

Name Type Description
name str
zarr_dir str
images list[SingleImage]
Source code in fractal_server/app/schemas/v2/dataset.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
class DatasetImportV2(BaseModel):
    """
    Class for `Dataset` import.

    We are dropping `model_config = ConfigDict(extra="forbid")` so that any
    kind of legacy filters can be included in the payload, and ignored in the
    API.

    Attributes:
        name:
        zarr_dir:
        images:
    """

    name: str
    zarr_dir: str
    images: list[SingleImage] = Field(default_factory=list)

    @field_validator("zarr_dir")
    @classmethod
    def normalize_zarr_dir(cls, v: str) -> str:
        return normalize_url(v)