Skip to content

user_settings

UserSettingsRead

Bases: BaseModel

Schema reserved for superusers

Source code in fractal_server/app/schemas/user_settings.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class UserSettingsRead(BaseModel):
    """
    Schema reserved for superusers
    """

    id: int
    ssh_host: Optional[str] = None
    ssh_username: Optional[str] = None
    ssh_private_key_path: Optional[str] = None
    ssh_tasks_dir: Optional[str] = None
    ssh_jobs_dir: Optional[str] = None
    slurm_user: Optional[str] = None
    slurm_accounts: list[str]
    project_dir: Optional[str] = None

UserSettingsUpdate

Bases: BaseModel

Schema reserved for superusers

Source code in fractal_server/app/schemas/user_settings.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
class UserSettingsUpdate(BaseModel):
    """
    Schema reserved for superusers
    """

    model_config = ConfigDict(extra="forbid")

    ssh_host: Optional[NonEmptyStr] = None
    ssh_username: Optional[NonEmptyStr] = None
    ssh_private_key_path: Optional[AbsolutePathStr] = None
    ssh_tasks_dir: Optional[AbsolutePathStr] = None
    ssh_jobs_dir: Optional[AbsolutePathStr] = None
    slurm_user: Optional[NonEmptyStr] = None
    slurm_accounts: Optional[ListUniqueNonEmptyString] = None
    project_dir: Optional[AbsolutePathStr] = None

    @field_validator("project_dir", mode="after")
    @classmethod
    def validate_project_dir(cls, value):
        if value is not None:
            validate_cmd(value)
        return value