profile

ProfileRead

Bases: BaseModel

Profile schema for GET endpoints.

ATTRIBUTE	DESCRIPTION
id	TYPE: int
name	TYPE: str
resource_id	TYPE: int
resource_type	TYPE: str
username	TYPE: str | None
ssh_key_path	TYPE: str | None
jobs_remote_dir	TYPE: str | None
tasks_remote_dir	TYPE: str | None

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

class ProfileRead(BaseModel):
    """
    Profile schema for GET endpoints.

    Attributes:
        id:
        name:
        resource_id:
        resource_type:
        username:
        ssh_key_path:
        jobs_remote_dir:
        tasks_remote_dir:
    """

    id: int
    name: str
    resource_id: int
    resource_type: str
    username: str | None = None
    ssh_key_path: str | None = None
    jobs_remote_dir: str | None = None
    tasks_remote_dir: str | None = None

ValidProfileLocal

Bases: BaseModel

Valid local profile.

ATTRIBUTE	DESCRIPTION
name	Profile name. TYPE: NonEmptyStr
resource_type	Type of the corresponding resource. TYPE: ResourceType

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

class ValidProfileLocal(BaseModel):
    """
    Valid local profile.

    Attributes:
        name: Profile name.
        resource_type: Type of the corresponding resource.
    """

    name: NonEmptyStr
    resource_type: ResourceType
    username: None = None
    ssh_key_path: None = None
    jobs_remote_dir: None = None
    tasks_remote_dir: None = None

ValidProfileSlurmSSH

Bases: BaseModel

Valid SLURM/sudo profile.

ATTRIBUTE	DESCRIPTION
name	Profile name. TYPE: NonEmptyStr
resource_type	Type of the corresponding resource. TYPE: ResourceType
username	SLURM user to impersonate (e.g. as in ssh username@cluster sbatch /some/script.sh). TYPE: NonEmptyStr
ssh_key_path	Local path of SSH private key for user username. TYPE: AbsolutePathStr
tasks_remote_dir	Base folder for task environments on the remote SLURM cluster. TYPE: AbsolutePathStr
jobs_remote_dir	Base folder for job directories on the remote SLURM cluster. TYPE: AbsolutePathStr

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

class ValidProfileSlurmSSH(BaseModel):
    """
    Valid SLURM/sudo profile.

    Attributes:
        name: Profile name.
        resource_type: Type of the corresponding resource.
        username:
            SLURM user to impersonate (e.g. as in
            `ssh username@cluster sbatch /some/script.sh`).
        ssh_key_path:
            Local path of SSH private key for user `username`.
        tasks_remote_dir:
            Base folder for task environments on the remote SLURM cluster.
        jobs_remote_dir:
            Base folder for job directories on the remote SLURM cluster.
    """

    name: NonEmptyStr
    resource_type: ResourceType
    username: NonEmptyStr
    ssh_key_path: AbsolutePathStr
    jobs_remote_dir: AbsolutePathStr
    tasks_remote_dir: AbsolutePathStr

ValidProfileSlurmSudo

Bases: BaseModel

Valid SLURM/sudo profile.

ATTRIBUTE	DESCRIPTION
name	Profile name. TYPE: NonEmptyStr
resource_type	Type of the corresponding resource. TYPE: ResourceType
username	SLURM user to impersonate (e.g. as in sudo -u username sbatch /some/script.sh). TYPE: NonEmptyStr

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

class ValidProfileSlurmSudo(BaseModel):
    """
    Valid SLURM/sudo profile.

    Attributes:
        name: Profile name.
        resource_type: Type of the corresponding resource.
        username:
            SLURM user to impersonate (e.g. as in
            `sudo -u username sbatch /some/script.sh`).
    """

    name: NonEmptyStr
    resource_type: ResourceType
    username: NonEmptyStr
    ssh_key_path: None = None
    jobs_remote_dir: None = None
    tasks_remote_dir: None = None

cast_serialize_profile(_data)

Cast/serialize round-trip for Profile data.

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

Return

Serialized version of a valid profile object.

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

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

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

    Return:
        Serialized version of a valid profile object.
    """
    return _data.model_dump()