fractal-server 2.17.1a1__py3-none-any.whl → 2.18.0__py3-none-any.whl

fractal_server/app/schemas/v2/resource.py

@@ -7,8 +7,8 @@ from typing import Self
 from pydantic import AfterValidator
 from pydantic import BaseModel
 from pydantic import Discriminator
-from pydantic import model_validator
 from pydantic import Tag
+from pydantic import model_validator
 from pydantic import validate_call
 from pydantic.types import AwareDatetime
 
@@ -21,23 +21,46 @@ from fractal_server.types import NonEmptyStr
 
 
 class ResourceType(StrEnum):
+    """
+    Enum for the possible resource types.
+    """
+
     SLURM_SUDO = "slurm_sudo"
+    """
+    Enum entry for resource type `slurm_sudo`.
+    """
+
     SLURM_SSH = "slurm_ssh"
+    """
+    Enum entry for resource type `slurm_ssh`.
+    """
+
     LOCAL = "local"
+    """
+    Enum entry for resource type `local`.
+    """
 
 
 def cast_serialize_pixi_settings(
-    v: dict[NonEmptyStr, Any],
+    value: dict[NonEmptyStr, Any],
 ) -> dict[NonEmptyStr, Any]:
     """
-    Validate current value, and enrich it with default values.
+    Cast/serialize round trip for `tasks_pixi_config` through the
+    `TasksPixiSettings` schema.
+
+    Arguments:
+        value: Current `tasks_pixi_config` value.
     """
-    if v != {}:
-        v = TasksPixiSettings(**v).model_dump()
-    return v
+    if value != {}:
+        value = TasksPixiSettings(**value).model_dump()
+    return value
 
 
-class _ValidResourceBase(BaseModel):
+class ValidResourceBase(BaseModel):
+    """
+    Base resource schema.
+    """
+
     type: ResourceType
     name: NonEmptyStr
 
@@ -54,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 (
@@ -61,27 +86,98 @@ class _ValidResourceBase(BaseModel):
             and self.type == ResourceType.SLURM_SSH
             and self.tasks_pixi_config["SLURM_CONFIG"] is None
         ):
-            raise ValueError(
-                "`tasks_pixi_config` must include `SLURM_CONFIG`."
-            )
+            raise ValueError("`tasks_pixi_config` must include `SLURM_CONFIG`.")
         return self
 
 
-class ValidResourceLocal(_ValidResourceBase):
+class ValidResourceLocal(ValidResourceBase):
+    """
+    Valid local resource.
+
+    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:
+            Configuration of `pixi` interpreters used for task collection.
+        tasks_local_dir:
+            Local base folder for task environments.
+        jobs_local_dir:
+            Local base folder for job folders.
+        jobs_runner_config:
+            Runner configuration.
+    """
+
     type: Literal[ResourceType.LOCAL]
     jobs_runner_config: JobRunnerConfigLocal
     jobs_slurm_python_worker: None = None
     host: None = None
 
 
-class ValidResourceSlurmSudo(_ValidResourceBase):
+class ValidResourceSlurmSudo(ValidResourceBase):
+    """
+    Valid SLURM-sudo resource.
+
+    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:
+            Configuration of `pixi` interpreters used for task collection.
+        tasks_local_dir:
+            Local base folder for task environments.
+        jobs_local_dir:
+            Local base folder for job folders.
+        jobs_runner_config:
+            Runner configuration.
+        jobs_poll_interval:
+            `squeue` polling interval.
+        jobs_slurm_python_worker:
+            Python worker to be used in SLURM jobs.
+    """
+
     type: Literal[ResourceType.SLURM_SUDO]
     jobs_slurm_python_worker: AbsolutePathStr
     jobs_runner_config: JobRunnerConfigSLURM
     host: None = None
 
 
-class ValidResourceSlurmSSH(_ValidResourceBase):
+class ValidResourceSlurmSSH(ValidResourceBase):
+    """
+    Valid SLURM-SSH resource.
+
+    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:
+            Configuration of `pixi` interpreters used for task collection.
+        tasks_local_dir:
+            Local base folder for task environments.
+        jobs_local_dir:
+            Local base folder for job folders.
+        jobs_runner_config:
+            Runner configuration.
+        jobs_poll_interval:
+            `squeue` polling interval.
+        jobs_slurm_python_worker:
+            Python worker to be used in SLURM jobs.
+        host:
+            Hostname or IP address of remote SLURM cluster.
+    """
+
     type: Literal[ResourceType.SLURM_SSH]
     host: NonEmptyStr
     jobs_slurm_python_worker: AbsolutePathStr
@@ -101,14 +197,20 @@ ResourceCreate = Annotated[
     | Annotated[ValidResourceSlurmSSH, Tag(ResourceType.SLURM_SSH)],
     Discriminator(get_discriminator_value),
 ]
+"""
+Schema for resources in API request bodies.
+"""
 
 
 class ResourceRead(BaseModel):
-    id: int
-
-    type: str
+    """
+    Schema for resources in API response bodies.
+    """
 
+    id: int
     name: str
+    type: str
+    prevent_new_submissions: bool
     timestamp_created: AwareDatetime
 
     host: str | None
@@ -131,6 +233,9 @@ def cast_serialize_resource(_data: ResourceCreate) -> dict[str, Any]:
     We use `@validate_call` because `ResourceCreate` is a `Union` type and it
     cannot be instantiated directly.
 
+    Args:
+        _data:
+
     Return:
         Serialized version of a valid resource object.
     """

fractal_server/app/schemas/v2/sharing.py

@@ -0,0 +1,99 @@
+from enum import StrEnum
+
+from pydantic import BaseModel
+
+
+class ProjectPermissions(StrEnum):
+    """
+    Available permissions for accessing Project
+    Attributes:
+        READ:
+        WRITE:
+        EXECUTE:
+    """
+
+    READ = "r"
+    WRITE = "rw"
+    EXECUTE = "rwx"
+
+
+class ProjectGuestCreate(BaseModel):
+    """
+    Request body for project-sharing invitation.
+
+    Attributes:
+        permissions:
+    """
+
+    permissions: ProjectPermissions
+
+
+class ProjectGuestRead(BaseModel):
+    """
+    Information about a guest.
+
+    Attributes:
+        email: Guest email.
+        is_verified: Project/guest verification status.
+        permissions: Guest permissions for project.
+    """
+
+    email: str
+    is_verified: bool
+    permissions: str
+
+
+class ProjectGuestUpdate(BaseModel):
+    """
+    Request body for updating permissions of an existing guest.
+
+    Attributes:
+        permissions: New permissions for guest.
+    """
+
+    permissions: ProjectPermissions
+
+
+class ProjectAccessRead(BaseModel):
+    """
+    Project-access information for current user.
+
+    Attributes:
+        is_owner: Whether current user is owner.
+        permissions: Current user permissions.
+        owner_email: Email of project owner
+    """
+
+    is_owner: bool
+    permissions: str
+    owner_email: str
+
+
+class ProjectInvitationRead(BaseModel):
+    """
+    Info about a pending invitation.
+
+    Attributes:
+        project_id:
+        project_name:
+        owner_email:
+        guest_permissions:
+    """
+
+    project_id: int
+    project_name: str
+    owner_email: str
+    guest_permissions: str
+
+
+class LinkUserProjectRead(BaseModel):
+    # User info
+    user_id: int
+    user_email: str
+    # Project info
+    project_id: int
+    project_name: str
+    # Permissions
+    is_verified: bool
+    is_owner: bool
+    permissions: str

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

@@ -14,7 +14,6 @@ from fractal_server.types import ListUniqueNonEmptyString
 from fractal_server.types import NonEmptyStr
 from fractal_server.types import TypeFilters
 
-
 logger = set_logger(__name__)
 
 
@@ -30,7 +29,7 @@ class TaskType(StrEnum):
     PARALLEL = "parallel"
 
 
-class TaskCreateV2(BaseModel):
+class TaskCreate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     name: NonEmptyStr
@@ -91,7 +90,7 @@ class TaskCreateV2(BaseModel):
         return self
 
 
-class TaskReadV2(BaseModel):
+class TaskRead(BaseModel):
     id: int
     name: str
     type: TaskType
@@ -118,7 +117,7 @@ class TaskReadV2(BaseModel):
     tags: list[str]
 
 
-class TaskUpdateV2(BaseModel):
+class TaskUpdate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     command_parallel: NonEmptyStr = None
@@ -132,7 +131,7 @@ class TaskUpdateV2(BaseModel):
     tags: ListUniqueNonEmptyString | None = None
 
 
-class TaskImportV2(BaseModel):
+class TaskImport(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     pkg_name: NonEmptyStr
@@ -140,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*
@@ -86,12 +86,12 @@ class TaskCollectPipV2(BaseModel):
     def validate_pinned_package_versions(cls, value):
         if value is not None:
             for pkg, version in value.items():
-                validate_cmd(pkg)
+                validate_cmd(pkg, allow_char="[]")
                 validate_cmd(version)
         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")

fractal_server/app/schemas/v2/workflow.py

@@ -5,29 +5,29 @@ from pydantic import ConfigDict
 from pydantic import field_serializer
 from pydantic.types import AwareDatetime
 
-from fractal_server.app.schemas.v2.project import ProjectReadV2
-from fractal_server.app.schemas.v2.workflowtask import WorkflowTaskExportV2
-from fractal_server.app.schemas.v2.workflowtask import WorkflowTaskImportV2
-from fractal_server.app.schemas.v2.workflowtask import WorkflowTaskReadV2
+from fractal_server.app.schemas.v2.project import ProjectRead
+from fractal_server.app.schemas.v2.workflowtask import WorkflowTaskExport
+from fractal_server.app.schemas.v2.workflowtask import WorkflowTaskImport
+from fractal_server.app.schemas.v2.workflowtask import WorkflowTaskRead
 from fractal_server.app.schemas.v2.workflowtask import (
-    WorkflowTaskReadV2WithWarning,
+    WorkflowTaskReadWithWarning,
 )
 from fractal_server.types import ListUniqueNonNegativeInt
 from fractal_server.types import NonEmptyStr
 
 
-class WorkflowCreateV2(BaseModel):
+class WorkflowCreate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     name: NonEmptyStr
 
 
-class WorkflowReadV2(BaseModel):
+class WorkflowRead(BaseModel):
     id: int
     name: str
     project_id: int
-    task_list: list[WorkflowTaskReadV2]
-    project: ProjectReadV2
+    task_list: list[WorkflowTaskRead]
+    project: ProjectRead
     timestamp_created: AwareDatetime
 
     @field_serializer("timestamp_created")
@@ -35,18 +35,18 @@ class WorkflowReadV2(BaseModel):
         return v.isoformat()
 
 
-class WorkflowReadV2WithWarnings(WorkflowReadV2):
-    task_list: list[WorkflowTaskReadV2WithWarning]
+class WorkflowReadWithWarnings(WorkflowRead):
+    task_list: list[WorkflowTaskReadWithWarning]
 
 
-class WorkflowUpdateV2(BaseModel):
+class WorkflowUpdate(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     name: NonEmptyStr = None
     reordered_workflowtask_ids: ListUniqueNonNegativeInt | None = None
 
 
-class WorkflowImportV2(BaseModel):
+class WorkflowImport(BaseModel):
     """
     Class for `Workflow` import.
 
@@ -56,10 +56,10 @@ class WorkflowImportV2(BaseModel):
 
     model_config = ConfigDict(extra="forbid")
     name: NonEmptyStr
-    task_list: list[WorkflowTaskImportV2]
+    task_list: list[WorkflowTaskImport]
 
 
-class WorkflowExportV2(BaseModel):
+class WorkflowExport(BaseModel):
     """
     Class for `Workflow` export.
 
@@ -68,4 +68,4 @@ class WorkflowExportV2(BaseModel):
     """
 
     name: str
-    task_list: list[WorkflowTaskExportV2]
+    task_list: list[WorkflowTaskExport]