resource

ResourceCreate = Annotated[Annotated[ValidResourceLocal, Tag(ResourceType.LOCAL)] | Annotated[ValidResourceSlurmSudo, Tag(ResourceType.SLURM_SUDO)] | Annotated[ValidResourceSlurmSSH, Tag(ResourceType.SLURM_SSH)], Discriminator(get_discriminator_value)] module-attribute

Schema for resources in API request bodies.

ResourceRead

Bases: BaseModel

Schema for resources in API response bodies.

Source code in fractal_server/app/schemas/v2/resource.py

class ResourceRead(BaseModel):
    """
    Schema for resources in API response bodies.
    """

    id: int
    name: str
    type: str
    prevent_new_submissions: bool
    timestamp_created: AwareDatetime

    host: str | None

    jobs_local_dir: str
    jobs_runner_config: dict[str, Any]
    jobs_slurm_python_worker: str | None
    jobs_poll_interval: int

    tasks_local_dir: str
    tasks_python_config: dict[str, Any]
    tasks_pixi_config: dict[str, Any]

ResourceType

Bases: StrEnum

Enum for the possible resource types.

Source code in fractal_server/app/schemas/v2/resource.py

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`.
    """

LOCAL = 'local' class-attribute instance-attribute

Enum entry for resource type local.

SLURM_SSH = 'slurm_ssh' class-attribute instance-attribute

Enum entry for resource type slurm_ssh.

SLURM_SUDO = 'slurm_sudo' class-attribute instance-attribute

Enum entry for resource type slurm_sudo.

ValidResourceBase

Bases: BaseModel

Base resource schema.

Source code in fractal_server/app/schemas/v2/resource.py

class ValidResourceBase(BaseModel):
    """
    Base resource schema.
    """

    type: ResourceType
    name: NonEmptyStr

    # Tasks
    tasks_python_config: TasksPythonSettings
    tasks_pixi_config: Annotated[
        dict[NonEmptyStr, Any],
        AfterValidator(cast_serialize_pixi_settings),
    ]
    tasks_local_dir: AbsolutePathStr

    # Jobs
    jobs_local_dir: AbsolutePathStr
    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 (
            self.tasks_pixi_config != {}
            and self.type == ResourceType.SLURM_SSH
            and self.tasks_pixi_config["SLURM_CONFIG"] is None
        ):
            raise ValueError("`tasks_pixi_config` must include `SLURM_CONFIG`.")
        return self

ValidResourceLocal

Bases: ValidResourceBase

Valid local resource.

ATTRIBUTE	DESCRIPTION
name	Resource name. TYPE: NonEmptyStr
type	Resource type. TYPE: Literal[LOCAL]
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. TYPE: bool
tasks_python_config	Configuration of Python interpreters used for task collection. TYPE: TasksPythonSettings
tasks_pixi_config	Configuration of pixi interpreters used for task collection. TYPE: Annotated[dict[NonEmptyStr, Any], AfterValidator(cast_serialize_pixi_settings)]
tasks_local_dir	Local base folder for task environments. TYPE: AbsolutePathStr
jobs_local_dir	Local base folder for job folders. TYPE: AbsolutePathStr
jobs_runner_config	Runner configuration. TYPE: JobRunnerConfigLocal

Source code in fractal_server/app/schemas/v2/resource.py

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

ValidResourceSlurmSSH

Bases: ValidResourceBase

Valid SLURM-SSH resource.

ATTRIBUTE	DESCRIPTION
name	Resource name TYPE: NonEmptyStr
type	Resource type. TYPE: Literal[SLURM_SSH]
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. TYPE: bool
tasks_python_config	Configuration of Python interpreters used for task collection. TYPE: TasksPythonSettings
tasks_pixi_config	Configuration of pixi interpreters used for task collection. TYPE: Annotated[dict[NonEmptyStr, Any], AfterValidator(cast_serialize_pixi_settings)]
tasks_local_dir	Local base folder for task environments. TYPE: AbsolutePathStr
jobs_local_dir	Local base folder for job folders. TYPE: AbsolutePathStr
jobs_runner_config	Runner configuration. TYPE: JobRunnerConfigSLURM
jobs_poll_interval	squeue polling interval. TYPE: int
jobs_slurm_python_worker	Python worker to be used in SLURM jobs. TYPE: AbsolutePathStr
host	Hostname or IP address of remote SLURM cluster. TYPE: NonEmptyStr

Source code in fractal_server/app/schemas/v2/resource.py

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
    jobs_runner_config: JobRunnerConfigSLURM

ValidResourceSlurmSudo

Bases: ValidResourceBase

Valid SLURM-sudo resource.

ATTRIBUTE	DESCRIPTION
name	Resource name. TYPE: NonEmptyStr
type	Resource type. TYPE: Literal[SLURM_SUDO]
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. TYPE: bool
tasks_python_config	Configuration of Python interpreters used for task collection. TYPE: TasksPythonSettings
tasks_pixi_config	Configuration of pixi interpreters used for task collection. TYPE: Annotated[dict[NonEmptyStr, Any], AfterValidator(cast_serialize_pixi_settings)]
tasks_local_dir	Local base folder for task environments. TYPE: AbsolutePathStr
jobs_local_dir	Local base folder for job folders. TYPE: AbsolutePathStr
jobs_runner_config	Runner configuration. TYPE: JobRunnerConfigSLURM
jobs_poll_interval	squeue polling interval. TYPE: int
jobs_slurm_python_worker	Python worker to be used in SLURM jobs. TYPE: AbsolutePathStr

Source code in fractal_server/app/schemas/v2/resource.py

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

cast_serialize_pixi_settings(value)

Cast/serialize round trip for tasks_pixi_config through the TasksPixiSettings schema.

PARAMETER	DESCRIPTION
value	Current tasks_pixi_config value. TYPE: dict[NonEmptyStr, Any]

Source code in fractal_server/app/schemas/v2/resource.py

def cast_serialize_pixi_settings(
    value: dict[NonEmptyStr, Any],
) -> dict[NonEmptyStr, Any]:
    """
    Cast/serialize round trip for `tasks_pixi_config` through the
    `TasksPixiSettings` schema.

    Arguments:
        value: Current `tasks_pixi_config` value.
    """
    if value != {}:
        value = TasksPixiSettings(**value).model_dump()
    return value

cast_serialize_resource(_data)

Cast/serialize round-trip for Resource data.

We use @validate_call because ResourceCreate is a Union type and it cannot be instantiated directly.

PARAMETER	DESCRIPTION
_data	TYPE: ResourceCreate

Return

Serialized version of a valid resource object.

Source code in fractal_server/app/schemas/v2/resource.py

@validate_call
def cast_serialize_resource(_data: ResourceCreate) -> dict[str, Any]:
    """
    Cast/serialize round-trip for `Resource` data.

    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.
    """
    return _data.model_dump()