fractal-server 2.18.0a3__py3-none-any.whl → 2.18.0a5__py3-none-any.whl

fractal_server/app/schemas/v2/__init__.py

@@ -1,25 +1,25 @@
 from .accounting import AccountingRecordRead  # noqa F401
-from .dataset import DatasetCreateV2  # noqa F401
-from .dataset import DatasetExportV2  # noqa F401
-from .dataset import DatasetImportV2  # noqa F401
-from .dataset import DatasetReadV2  # noqa F401
-from .dataset import DatasetUpdateV2  # noqa F401
-from .dumps import DatasetDumpV2  # noqa F401
-from .dumps import ProjectDumpV2  # noqa F401
-from .dumps import TaskDumpV2  # noqa F401
-from .dumps import TaskGroupDumpV2  # noqa F401
-from .dumps import WorkflowDumpV2  # noqa F401
-from .dumps import WorkflowTaskDumpV2  # noqa F401
+from .dataset import DatasetCreate  # noqa F401
+from .dataset import DatasetExport  # noqa F401
+from .dataset import DatasetImport  # noqa F401
+from .dataset import DatasetRead  # noqa F401
+from .dataset import DatasetUpdate  # noqa F401
+from .dumps import DatasetDump  # noqa F401
+from .dumps import ProjectDump  # noqa F401
+from .dumps import TaskDump  # noqa F401
+from .dumps import TaskGroupDump  # noqa F401
+from .dumps import WorkflowDump  # noqa F401
+from .dumps import WorkflowTaskDump  # noqa F401
 from .history import HistoryRunRead  # noqa F401
 from .history import HistoryRunReadAggregated  # noqa F401
 from .history import HistoryUnitRead  # noqa F401
 from .history import HistoryUnitStatus  # noqa F401
 from .history import HistoryUnitStatusWithUnset  # noqa F401
 from .history import ImageLogsRequest  # noqa F401
-from .job import JobCreateV2  # noqa F401
-from .job import JobReadV2  # noqa F401
-from .job import JobStatusTypeV2  # noqa F401
-from .job import JobUpdateV2  # noqa F401
+from .job import JobCreate  # noqa F401
+from .job import JobRead  # noqa F401
+from .job import JobStatusType  # noqa F401
+from .job import JobUpdate  # noqa F401
 from .manifest import ManifestV2  # noqa F401
 from .manifest import TaskManifestV2  # noqa F401
 from .profile import ProfileCreate  # noqa F401
@@ -27,9 +27,9 @@ from .profile import ProfileRead  # noqa F401
 from .profile import ValidProfileLocal  # noqa F401
 from .profile import ValidProfileSlurmSSH  # noqa F401
 from .profile import ValidProfileSlurmSudo  # noqa F401
-from .project import ProjectCreateV2  # noqa F401
-from .project import ProjectReadV2  # noqa F401
-from .project import ProjectUpdateV2  # noqa F401
+from .project import ProjectCreate  # noqa F401
+from .project import ProjectRead  # noqa F401
+from .project import ProjectUpdate  # noqa F401
 from .sharing import ProjectPermissions  # noqa F401
 from .sharing import ProjectGuestCreate  # noqa F401
 from .sharing import ProjectAccessRead  # noqa F401
@@ -43,36 +43,36 @@ from .resource import ResourceType  # noqa F401
 from .resource import ValidResourceLocal  # noqa F401
 from .resource import ValidResourceSlurmSSH  # noqa F401
 from .resource import ValidResourceSlurmSudo  # noqa F401
-from .status_legacy import WorkflowTaskStatusTypeV2  # noqa F401
-from .task import TaskCreateV2  # noqa F401
-from .task import TaskExportV2  # noqa F401
-from .task import TaskImportV2  # noqa F401
-from .task import TaskImportV2Legacy  # noqa F401
-from .task import TaskReadV2  # noqa F401
+from .status_legacy import WorkflowTaskStatusType  # noqa F401
+from .task import TaskCreate  # noqa F401
+from .task import TaskExport  # noqa F401
+from .task import TaskImport  # noqa F401
+from .task import TaskImportLegacy  # noqa F401
+from .task import TaskRead  # noqa F401
 from .task import TaskType  # noqa F401
-from .task import TaskUpdateV2  # noqa F401
+from .task import TaskUpdate  # noqa F401
 from .task_collection import FractalUploadedFile  # noqa F401
-from .task_collection import TaskCollectCustomV2  # noqa F401
-from .task_collection import TaskCollectPipV2  # noqa F401
-from .task_group import TaskGroupActivityActionV2  # noqa F401
-from .task_group import TaskGroupActivityStatusV2  # noqa F401
-from .task_group import TaskGroupActivityV2Read  # noqa F401
-from .task_group import TaskGroupCreateV2  # noqa F401
-from .task_group import TaskGroupCreateV2Strict  # noqa F401
+from .task_collection import TaskCollectCustom  # noqa F401
+from .task_collection import TaskCollectPip  # noqa F401
+from .task_group import TaskGroupActivityAction  # noqa F401
+from .task_group import TaskGroupActivityStatus  # noqa F401
+from .task_group import TaskGroupActivityRead  # noqa F401
+from .task_group import TaskGroupCreate  # noqa F401
+from .task_group import TaskGroupCreateStrict  # noqa F401
 from .task_group import TaskGroupReadSuperuser  # noqa F401
-from .task_group import TaskGroupReadV2  # noqa F401
-from .task_group import TaskGroupUpdateV2  # noqa F401
-from .task_group import TaskGroupV2OriginEnum  # noqa F401
-from .workflow import WorkflowCreateV2  # noqa F401
-from .workflow import WorkflowExportV2  # noqa F401
-from .workflow import WorkflowImportV2  # noqa F401
-from .workflow import WorkflowReadV2  # noqa F401
-from .workflow import WorkflowReadV2WithWarnings  # noqa F401
-from .workflow import WorkflowUpdateV2  # noqa F401
-from .workflowtask import WorkflowTaskCreateV2  # noqa F401
-from .workflowtask import WorkflowTaskExportV2  # noqa F401
-from .workflowtask import WorkflowTaskImportV2  # noqa F401
-from .workflowtask import WorkflowTaskReadV2  # noqa F401
-from .workflowtask import WorkflowTaskReadV2WithWarning  # noqa F401
-from .workflowtask import WorkflowTaskReplaceV2  # noqa F401
-from .workflowtask import WorkflowTaskUpdateV2  # noqa F401
+from .task_group import TaskGroupRead  # noqa F401
+from .task_group import TaskGroupUpdate  # noqa F401
+from .task_group import TaskGroupOriginEnum  # noqa F401
+from .workflow import WorkflowCreate  # noqa F401
+from .workflow import WorkflowExport  # noqa F401
+from .workflow import WorkflowImport  # noqa F401
+from .workflow import WorkflowRead  # noqa F401
+from .workflow import WorkflowReadWithWarnings  # noqa F401
+from .workflow import WorkflowUpdate  # noqa F401
+from .workflowtask import WorkflowTaskCreate  # noqa F401
+from .workflowtask import WorkflowTaskExport  # noqa F401
+from .workflowtask import WorkflowTaskImport  # noqa F401
+from .workflowtask import WorkflowTaskRead  # noqa F401
+from .workflowtask import WorkflowTaskReadWithWarning  # noqa F401
+from .workflowtask import WorkflowTaskReplace  # noqa F401
+from .workflowtask import WorkflowTaskUpdate  # noqa F401

fractal_server/app/schemas/v2/dataset.py

@@ -4,32 +4,45 @@ from pydantic import BaseModel
 from pydantic import ConfigDict
 from pydantic import Field
 from pydantic import field_serializer
+from pydantic import model_validator
 from pydantic.types import AwareDatetime
 
-from fractal_server.app.schemas.v2.project import ProjectReadV2
+from fractal_server.app.schemas.v2.project import ProjectRead
 from fractal_server.images import SingleImage
+from fractal_server.types import AbsolutePathStr
 from fractal_server.types import NonEmptyStr
+from fractal_server.types import RelativePathStr
 from fractal_server.types import ZarrDirStr
 
 
-class DatasetCreateV2(BaseModel):
+class DatasetCreate(BaseModel):
     """
-    DatasetCreateV2
+    DatasetCreate
 
     Attributes:
         name:
-        zarr_dir:
+        project_dir:
+        zarr_subfolder:
     """
 
     model_config = ConfigDict(extra="forbid")
 
     name: NonEmptyStr
-    zarr_dir: ZarrDirStr | None = None
+    project_dir: AbsolutePathStr | None = None
+    zarr_subfolder: RelativePathStr | None = None
+
+    @model_validator(mode="after")
+    def validate_zarr_dir(self):
+        if (self.project_dir is None) and (self.zarr_subfolder is not None):
+            raise ValueError(
+                "Cannot provide `zarr_subfolder` without `project_dir`"
+            )
+        return self
 
 
-class DatasetReadV2(BaseModel):
+class DatasetRead(BaseModel):
     """
-    DatasetReadV2
+    DatasetRead
 
     Attributes:
         id:
@@ -44,7 +57,7 @@ class DatasetReadV2(BaseModel):
     name: str
 
     project_id: int
-    project: ProjectReadV2
+    project: ProjectRead
 
     timestamp_created: AwareDatetime
 
@@ -55,9 +68,9 @@ class DatasetReadV2(BaseModel):
         return v.isoformat()
 
 
-class DatasetUpdateV2(BaseModel):
+class DatasetUpdate(BaseModel):
     """
-    DatasetUpdateV2
+    DatasetUpdate
 
     Attributes:
         name:
@@ -67,10 +80,9 @@ class DatasetUpdateV2(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     name: NonEmptyStr = None
-    zarr_dir: ZarrDirStr | None = None
 
 
-class DatasetImportV2(BaseModel):
+class DatasetImport(BaseModel):
     """
     Class for `Dataset` import.
 
@@ -89,7 +101,7 @@ class DatasetImportV2(BaseModel):
     images: list[SingleImage] = Field(default_factory=list)
 
 
-class DatasetExportV2(BaseModel):
+class DatasetExport(BaseModel):
     """
     Class for `Dataset` export.
 

fractal_server/app/schemas/v2/dumps.py

@@ -13,17 +13,17 @@ from pydantic import ConfigDict
 from pydantic import Field
 
 from .task import TaskType
-from .task_group import TaskGroupV2OriginEnum
+from .task_group import TaskGroupOriginEnum
 
 
-class ProjectDumpV2(BaseModel):
+class ProjectDump(BaseModel):
     model_config = ConfigDict(extra="forbid")
     id: int
     name: str
     timestamp_created: str
 
 
-class TaskDumpV2(BaseModel):
+class TaskDump(BaseModel):
     id: int
     name: str
     type: TaskType
@@ -37,7 +37,7 @@ class TaskDumpV2(BaseModel):
     output_types: dict[str, bool]
 
 
-class WorkflowTaskDumpV2(BaseModel):
+class WorkflowTaskDump(BaseModel):
     """
     We do not include 'model_config = ConfigDict(extra="forbid")'
     because legacy data may include 'input_filters' field and we want to avoid
@@ -51,10 +51,10 @@ class WorkflowTaskDumpV2(BaseModel):
     type_filters: dict[str, bool]
 
     task_id: int | None = None
-    task: TaskDumpV2 | None = None
+    task: TaskDump | None = None
 
 
-class WorkflowDumpV2(BaseModel):
+class WorkflowDump(BaseModel):
     model_config = ConfigDict(extra="forbid")
     id: int
     name: str
@@ -62,7 +62,7 @@ class WorkflowDumpV2(BaseModel):
     timestamp_created: str
 
 
-class DatasetDumpV2(BaseModel):
+class DatasetDump(BaseModel):
     """
     We do not include 'model_config = ConfigDict(extra="forbid")' because
     legacy data may include 'type_filters' or 'attribute_filters' and we
@@ -76,9 +76,9 @@ class DatasetDumpV2(BaseModel):
     zarr_dir: str
 
 
-class TaskGroupDumpV2(BaseModel):
+class TaskGroupDump(BaseModel):
     id: int
-    origin: TaskGroupV2OriginEnum
+    origin: TaskGroupOriginEnum
     pkg_name: str
     version: str | None = None
     python_version: str | None = None

fractal_server/app/schemas/v2/job.py

@@ -10,15 +10,15 @@ from pydantic.types import AwareDatetime
 from pydantic.types import NonNegativeInt
 from pydantic.types import StrictStr
 
-from fractal_server.app.schemas.v2.dumps import DatasetDumpV2
-from fractal_server.app.schemas.v2.dumps import ProjectDumpV2
-from fractal_server.app.schemas.v2.dumps import WorkflowDumpV2
+from fractal_server.app.schemas.v2.dumps import DatasetDump
+from fractal_server.app.schemas.v2.dumps import ProjectDump
+from fractal_server.app.schemas.v2.dumps import WorkflowDump
 from fractal_server.types import AttributeFilters
 from fractal_server.types import NonEmptyStr
 from fractal_server.types import TypeFilters
 
 
-class JobStatusTypeV2(StrEnum):
+class JobStatusType(StrEnum):
     """
     Define the available job statuses
 
@@ -39,7 +39,7 @@ class JobStatusTypeV2(StrEnum):
     FAILED = "failed"
 
 
-class JobCreateV2(BaseModel):
+class JobCreate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     first_task_index: NonNegativeInt | None = None
@@ -65,16 +65,16 @@ class JobCreateV2(BaseModel):
         return values
 
 
-class JobReadV2(BaseModel):
+class JobRead(BaseModel):
     id: int
     project_id: int | None = None
-    project_dump: ProjectDumpV2
+    project_dump: ProjectDump
     user_email: str
     slurm_account: str | None = None
     workflow_id: int | None = None
-    workflow_dump: WorkflowDumpV2
+    workflow_dump: WorkflowDump
     dataset_id: int | None = None
-    dataset_dump: DatasetDumpV2
+    dataset_dump: DatasetDump
     start_timestamp: AwareDatetime
     end_timestamp: AwareDatetime | None = None
     status: str
@@ -100,7 +100,7 @@ class JobReadV2(BaseModel):
             return v.isoformat()
 
 
-class JobUpdateV2(BaseModel):
+class JobUpdate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
-    status: JobStatusTypeV2
+    status: JobStatusType

fractal_server/app/schemas/v2/project.py

@@ -8,13 +8,13 @@ from pydantic.types import AwareDatetime
 from fractal_server.types import NonEmptyStr
 
 
-class ProjectCreateV2(BaseModel):
+class ProjectCreate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     name: NonEmptyStr
 
 
-class ProjectReadV2(BaseModel):
+class ProjectRead(BaseModel):
     id: int
     name: str
     timestamp_created: AwareDatetime
@@ -24,7 +24,7 @@ class ProjectReadV2(BaseModel):
         return v.isoformat()
 
 
-class ProjectUpdateV2(BaseModel):
+class ProjectUpdate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     name: NonEmptyStr = None

fractal_server/app/schemas/v2/resource.py

@@ -77,6 +77,8 @@ class ValidResourceBase(BaseModel):
     jobs_runner_config: dict[NonEmptyStr, Any]
     jobs_poll_interval: int = 5
 
+    prevent_new_submissions: bool = False
+
     @model_validator(mode="after")
     def _pixi_slurm_config(self) -> Self:
         if (
@@ -95,6 +97,9 @@ class ValidResourceLocal(ValidResourceBase):
     Attributes:
         name: Resource name.
         type: Resource type.
+        prevent_new_submissions:
+            When set to true: Prevent new job submissions and stop execution of
+            ongoing jobs as soon as the current task is complete.
         tasks_python_config:
             Configuration of Python interpreters used for task collection.
         tasks_pixi_config:
@@ -105,7 +110,6 @@ class ValidResourceLocal(ValidResourceBase):
             Local base folder for job folders.
         jobs_runner_config:
             Runner configuration.
-
     """
 
     type: Literal[ResourceType.LOCAL]
@@ -121,6 +125,9 @@ class ValidResourceSlurmSudo(ValidResourceBase):
     Attributes:
         name: Resource name.
         type: Resource type.
+        prevent_new_submissions:
+            When set to true: Prevent new job submissions and stop execution of
+            ongoing jobs as soon as the current task is complete.
         tasks_python_config:
             Configuration of Python interpreters used for task collection.
         tasks_pixi_config:
@@ -150,6 +157,9 @@ class ValidResourceSlurmSSH(ValidResourceBase):
     Attributes:
         name: Resource name
         type: Resource type.
+        prevent_new_submissions:
+            When set to true: Prevent new job submissions and stop execution of
+            ongoing jobs as soon as the current task is complete.
         tasks_python_config:
             Configuration of Python interpreters used for task collection.
         tasks_pixi_config:
@@ -198,10 +208,9 @@ class ResourceRead(BaseModel):
     """
 
     id: int
-
-    type: str
-
     name: str
+    type: str
+    prevent_new_submissions: bool
     timestamp_created: AwareDatetime
 
     host: str | None

fractal_server/app/schemas/v2/status_legacy.py

@@ -4,7 +4,7 @@ from pydantic import BaseModel
 from pydantic import Field
 
 
-class WorkflowTaskStatusTypeV2(StrEnum):
+class WorkflowTaskStatusType(StrEnum):
     """
     Define the available values for the status of a `WorkflowTask`.
 
@@ -23,7 +23,7 @@ class WorkflowTaskStatusTypeV2(StrEnum):
     FAILED = "failed"
 
 
-class LegacyStatusReadV2(BaseModel):
+class LegacyStatusRead(BaseModel):
     """
     Response type for the
     `/project/{project_id}/status/` endpoint
@@ -31,5 +31,5 @@ class LegacyStatusReadV2(BaseModel):
 
     status: dict[
         str,
-        WorkflowTaskStatusTypeV2,
+        WorkflowTaskStatusType,
     ] = Field(default_factory=dict)

fractal_server/app/schemas/v2/task.py

@@ -29,7 +29,7 @@ class TaskType(StrEnum):
     PARALLEL = "parallel"
 
 
-class TaskCreateV2(BaseModel):
+class TaskCreate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     name: NonEmptyStr
@@ -90,7 +90,7 @@ class TaskCreateV2(BaseModel):
         return self
 
 
-class TaskReadV2(BaseModel):
+class TaskRead(BaseModel):
     id: int
     name: str
     type: TaskType
@@ -117,7 +117,7 @@ class TaskReadV2(BaseModel):
     tags: list[str]
 
 
-class TaskUpdateV2(BaseModel):
+class TaskUpdate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     command_parallel: NonEmptyStr = None
@@ -131,7 +131,7 @@ class TaskUpdateV2(BaseModel):
     tags: ListUniqueNonEmptyString | None = None
 
 
-class TaskImportV2(BaseModel):
+class TaskImport(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     pkg_name: NonEmptyStr
@@ -139,11 +139,11 @@ class TaskImportV2(BaseModel):
     name: NonEmptyStr
 
 
-class TaskImportV2Legacy(BaseModel):
+class TaskImportLegacy(BaseModel):
     source: NonEmptyStr
 
 
-class TaskExportV2(BaseModel):
+class TaskExport(BaseModel):
     pkg_name: NonEmptyStr
     version: NonEmptyStr | None = None
     name: NonEmptyStr

fractal_server/app/schemas/v2/task_collection.py

@@ -21,9 +21,9 @@ class FractalUploadedFile(BaseModel):
     contents: bytes
 
 
-class TaskCollectPipV2(BaseModel):
+class TaskCollectPip(BaseModel):
     """
-    TaskCollectPipV2 class
+    TaskCollectPip class
 
     This class only encodes the attributes required to trigger a
     task-collection operation. Other attributes (that are assigned *during*
@@ -91,7 +91,7 @@ class TaskCollectPipV2(BaseModel):
         return value
 
 
-class TaskCollectCustomV2(BaseModel):
+class TaskCollectCustom(BaseModel):
     """
     Attributes:
         manifest: Manifest of a Fractal task package (this is typically the
@@ -99,7 +99,7 @@ class TaskCollectCustomV2(BaseModel):
         python_interpreter: Absolute path to the Python interpreter to be used
             for running tasks.
         name: A name identifying this package, that will fill the
-            `TaskGroupV2.pkg_name` column.
+            `TaskGroup.pkg_name` column.
         package_root: The folder where the package is installed.
             If not provided, it will be extracted via `pip show`
             (requires `package_name` to be set).

fractal_server/app/schemas/v2/task_group.py

@@ -7,40 +7,40 @@ from pydantic import Field
 from pydantic import field_serializer
 from pydantic.types import AwareDatetime
 
-from fractal_server.app.schemas.v2.task import TaskReadV2
+from fractal_server.app.schemas.v2.task import TaskRead
 from fractal_server.types import AbsolutePathStr
 from fractal_server.types import DictStrStr
 from fractal_server.types import NonEmptyStr
 
 
-class TaskGroupV2OriginEnum(StrEnum):
+class TaskGroupOriginEnum(StrEnum):
     PYPI = "pypi"
     WHEELFILE = "wheel-file"
     PIXI = "pixi"
     OTHER = "other"
 
 
-class TaskGroupActivityStatusV2(StrEnum):
+class TaskGroupActivityStatus(StrEnum):
     PENDING = "pending"
     ONGOING = "ongoing"
     FAILED = "failed"
     OK = "OK"
 
 
-class TaskGroupActivityActionV2(StrEnum):
+class TaskGroupActivityAction(StrEnum):
     COLLECT = "collect"
     DEACTIVATE = "deactivate"
     REACTIVATE = "reactivate"
     DELETE = "delete"
 
 
-class TaskGroupCreateV2(BaseModel):
+class TaskGroupCreate(BaseModel):
     model_config = ConfigDict(extra="forbid")
     user_id: int
     resource_id: int
     user_group_id: int | None = None
     active: bool = True
-    origin: TaskGroupV2OriginEnum
+    origin: TaskGroupOriginEnum
     pkg_name: str
     version: str | None = None
     python_version: NonEmptyStr = None
@@ -54,9 +54,9 @@ class TaskGroupCreateV2(BaseModel):
     pinned_package_versions_post: DictStrStr = Field(default_factory=dict)
 
 
-class TaskGroupCreateV2Strict(TaskGroupCreateV2):
+class TaskGroupCreateStrict(TaskGroupCreate):
     """
-    A strict version of TaskGroupCreateV2, to be used for task collection.
+    A strict version of TaskGroupCreate, to be used for task collection.
     """
 
     path: AbsolutePathStr
@@ -65,14 +65,14 @@ class TaskGroupCreateV2Strict(TaskGroupCreateV2):
     python_version: NonEmptyStr
 
 
-class TaskGroupReadV2(BaseModel):
+class TaskGroupRead(BaseModel):
     id: int
-    task_list: list[TaskReadV2]
+    task_list: list[TaskRead]
 
     user_id: int
     user_group_id: int | None = None
 
-    origin: TaskGroupV2OriginEnum
+    origin: TaskGroupOriginEnum
     pkg_name: str
     version: str | None = None
     python_version: str | None = None
@@ -96,16 +96,16 @@ class TaskGroupReadV2(BaseModel):
         return v.isoformat()
 
 
-class TaskGroupReadSuperuser(TaskGroupReadV2):
+class TaskGroupReadSuperuser(TaskGroupRead):
     resource_id: int
 
 
-class TaskGroupUpdateV2(BaseModel):
+class TaskGroupUpdate(BaseModel):
     model_config = ConfigDict(extra="forbid")
     user_group_id: int | None = None
 
 
-class TaskGroupActivityV2Read(BaseModel):
+class TaskGroupActivityRead(BaseModel):
     id: int
     user_id: int
     taskgroupv2_id: int | None = None
@@ -113,8 +113,8 @@ class TaskGroupActivityV2Read(BaseModel):
     timestamp_ended: AwareDatetime | None = None
     pkg_name: str
     version: str
-    status: TaskGroupActivityStatusV2
-    action: TaskGroupActivityActionV2
+    status: TaskGroupActivityStatus
+    action: TaskGroupActivityAction
     log: str | None = None
 
     @field_serializer("timestamp_started")