Skip to content

user_settings

UserSettingsRead

Bases: BaseModel

Schema reserved for superusers

Source code in fractal_server/app/schemas/user_settings.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
class UserSettingsUpdate(BaseModel):
    """
    Schema reserved for superusers
    """

    model_config = ConfigDict(extra="forbid")

    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: Optional[list[StrictStr]] = None
    project_dir: Optional[str] = None

    _ssh_host = field_validator("ssh_host")(
        classmethod(valstr("ssh_host", accept_none=True))
    )
    _ssh_username = field_validator("ssh_username")(
        classmethod(valstr("ssh_username", accept_none=True))
    )
    _ssh_private_key_path = field_validator("ssh_private_key_path")(
        classmethod(
            val_absolute_path("ssh_private_key_path", accept_none=True)
        )
    )

    _ssh_tasks_dir = field_validator("ssh_tasks_dir")(
        classmethod(val_absolute_path("ssh_tasks_dir", accept_none=True))
    )
    _ssh_jobs_dir = field_validator("ssh_jobs_dir")(
        classmethod(val_absolute_path("ssh_jobs_dir", accept_none=True))
    )

    _slurm_user = field_validator("slurm_user")(
        classmethod(valstr("slurm_user", accept_none=True))
    )

    @field_validator("slurm_accounts")
    @classmethod
    def slurm_accounts_validator(cls, value):
        if value is None:
            return value
        for i, item in enumerate(value):
            value[i] = valstr(f"slurm_accounts[{i}]")(cls, item)
        return val_unique_list("slurm_accounts")(cls, value)

    @field_validator("project_dir")
    @classmethod
    def project_dir_validator(cls, value):
        if value is None:
            return None
        validate_cmd(value)
        return val_absolute_path("project_dir")(cls, value)