_aux_functions
Auxiliary functions to get object from the database or perform simple checks
_check_project_exists(*, project_name, user_id, db)
async
¶
Check that no other project with this name exists for this user.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_name |
str
|
Project name |
required |
user_id |
int
|
User ID |
required |
db |
AsyncSession
|
|
required |
Raises:
Type | Description |
---|---|
HTTPException(status_code=422_UNPROCESSABLE_ENTITY)
|
If such a project already exists |
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
|
_check_workflow_exists(*, name, project_id, db)
async
¶
Check that no other workflow of this project has the same name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
Workflow name |
required |
project_id |
int
|
Project ID |
required |
db |
AsyncSession
|
|
required |
Raises:
Type | Description |
---|---|
HTTPException(status_code=422_UNPROCESSABLE_ENTITY)
|
If such a workflow already exists |
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
|
_get_dataset_check_owner(*, project_id, dataset_id, user_id, db)
async
¶
Get a dataset and a project, after access control on the project
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_id |
int
|
|
required |
dataset_id |
int
|
|
required |
user_id |
int
|
|
required |
db |
AsyncSession
|
|
required |
Returns:
Type | Description |
---|---|
dict[Literal['dataset', 'project'], Union[DatasetV2, ProjectV2]]
|
Dictionary with the dataset and project objects (keys: |
Raises:
Type | Description |
---|---|
HTTPException(status_code=422_UNPROCESSABLE_ENTITY)
|
If the dataset is not associated to the project |
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
|
_get_job_check_owner(*, project_id, job_id, user_id, db)
async
¶
Get a job and a project, after access control on the project
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_id |
int
|
|
required |
job_id |
int
|
|
required |
user_id |
int
|
|
required |
db |
AsyncSession
|
|
required |
Returns:
Type | Description |
---|---|
dict[Literal['job', 'project'], Union[JobV2, ProjectV2]]
|
Dictionary with the job and project objects (keys: |
Raises:
Type | Description |
---|---|
HTTPException(status_code=422_UNPROCESSABLE_ENTITY)
|
If the job is not associated to the project |
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
|
_get_project_check_owner(*, project_id, user_id, db)
async
¶
Check that user is a member of project and return the project.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_id |
int
|
|
required |
user_id |
int
|
|
required |
db |
AsyncSession
|
|
required |
Returns:
Type | Description |
---|---|
ProjectV2
|
The project object |
Raises:
Type | Description |
---|---|
HTTPException(status_code=403_FORBIDDEN)
|
If the user is not a member of the project |
HTTPException(status_code=404_NOT_FOUND)
|
If the project does not exist |
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
|
_get_submitted_jobs_statement()
¶
Returns:
Type | Description |
---|---|
SelectOfScalar
|
A sqlmodel statement that selects all |
SelectOfScalar
|
|
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
321 322 323 324 325 326 327 328 |
|
_get_workflow_check_owner(*, workflow_id, project_id, user_id, db)
async
¶
Get a workflow and a project, after access control on the project.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
workflow_id |
int
|
|
required |
project_id |
int
|
|
required |
user_id |
int
|
|
required |
db |
AsyncSession
|
|
required |
Returns:
Type | Description |
---|---|
WorkflowV2
|
The workflow object. |
Raises:
Type | Description |
---|---|
HTTPException(status_code=404_NOT_FOUND)
|
If the workflow does not exist |
HTTPException(status_code=422_UNPROCESSABLE_ENTITY)
|
If the workflow is not associated to the project |
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
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 99 100 101 102 103 104 105 106 107 108 109 110 111 |
|
_get_workflow_task_check_owner(*, project_id, workflow_id, workflow_task_id, user_id, db)
async
¶
Check that user has access to Workflow and WorkflowTask.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
project_id |
int
|
|
required |
workflow_id |
int
|
|
required |
workflow_task_id |
int
|
|
required |
user_id |
int
|
|
required |
db |
AsyncSession
|
|
required |
Returns:
Type | Description |
---|---|
tuple[WorkflowTaskV2, WorkflowV2]
|
Tuple of WorkflowTask and Workflow objects. |
Raises:
Type | Description |
---|---|
HTTPException(status_code=404_NOT_FOUND)
|
If the WorkflowTask does not exist |
HTTPException(status_code=422_UNPROCESSABLE_ENTITY)
|
If the WorkflowTask is not associated to the Workflow |
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
|
_workflow_insert_task(*, workflow_id, task_id, meta_parallel=None, meta_non_parallel=None, args_non_parallel=None, args_parallel=None, input_filters=None, db)
async
¶
Insert a new WorkflowTask into Workflow.task_list
Parameters:
Name | Type | Description | Default |
---|---|---|---|
workflow_id |
int
|
|
required |
task_id |
int
|
|
required |
meta_parallel |
Optional[dict[str, Any]]
|
|
None
|
meta_non_parallel |
Optional[dict[str, Any]]
|
|
None
|
args_non_parallel |
Optional[dict[str, Any]]
|
|
None
|
args_parallel |
Optional[dict[str, Any]]
|
|
None
|
input_filters |
Optional[Filters]
|
|
None
|
db |
AsyncSession
|
|
required |
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 |
|
clean_app_job_list_v2(db, jobs_list)
async
¶
Remove from a job list all jobs with status different from submitted.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
db |
AsyncSession
|
Async database session |
required |
jobs_list |
list[int]
|
List of job IDs currently associated to the app. |
required |
Return
List of IDs for submitted jobs.
Source code in fractal_server/app/routes/api/v2/_aux_functions.py
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
|