prefect.states
¶
AwaitingRetry
¶
Convenience function for creating AwaitingRetry
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a AwaitingRetry state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
599 600 601 602 603 604 605 606 607 608 609 |
|
Cancelled
¶
Convenience function for creating Cancelled
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Cancelled state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
545 546 547 548 549 550 551 |
|
Cancelling
¶
Convenience function for creating Cancelling
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Cancelling state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
536 537 538 539 540 541 542 |
|
Completed
¶
Convenience function for creating Completed
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Completed state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
500 501 502 503 504 505 506 |
|
Crashed
¶
Convenience function for creating Crashed
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Crashed state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
527 528 529 530 531 532 533 |
|
Failed
¶
Convenience function for creating Failed
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Failed state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
518 519 520 521 522 523 524 |
|
Late
¶
Convenience function for creating Late
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Late state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
621 622 623 624 625 626 627 628 629 |
|
Paused
¶
Convenience function for creating Paused
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Paused state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 |
|
Pending
¶
Convenience function for creating Pending
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Pending state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
554 555 556 557 558 559 560 |
|
Retrying
¶
Convenience function for creating Retrying
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Retrying state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
612 613 614 615 616 617 618 |
|
Running
¶
Convenience function for creating Running
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Running state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
509 510 511 512 513 514 515 |
|
Scheduled
¶
Convenience function for creating Scheduled
states.
Returns:
Name | Type | Description |
---|---|---|
State |
State
|
a Scheduled state |
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 |
|
exception_to_crashed_state
async
¶
Takes an exception that occurs outside of user code and converts it to a 'Crash' exception with a 'Crashed' state.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
exception_to_failed_state
async
¶
Convenience function for creating Failed
states from exceptions
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
|
get_state_exception
async
¶
If not given a FAILED or CRASHED state, this raise a value error.
If the state result is a state, its exception will be returned.
If the state result is an iterable of states, the exception of the first failure will be returned.
If the state result is a string, a wrapper exception will be returned with the string as the message.
If the state result is null, a wrapper exception will be returned with the state message attached.
If the state result is not of a known type, a TypeError
will be returned.
When a wrapper exception is returned, the type will be:
- FailedRun
if the state type is FAILED.
- CrashedRun
if the state type is CRASHED.
- CancelledRun
if the state type is CANCELLED.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 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 |
|
get_state_result
¶
Get the result from a state.
See State.result()
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
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 64 65 66 67 68 69 70 71 |
|
is_state
¶
Check if the given object is a state instance
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
395 396 397 398 399 400 401 402 403 |
|
is_state_iterable
¶
Check if a the given object is an iterable of states types
Supported iterables are: - set - list - tuple
Other iterables will return False
even if they contain states.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
|
raise_state_exception
async
¶
Given a FAILED or CRASHED state, raise the contained exception.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
384 385 386 387 388 389 390 391 392 |
|
return_value_to_state
async
¶
Given a return value from a user's function, create a State
the run should
be placed in.
- If data is returned, we create a 'COMPLETED' state with the data
- If a single, manually created state is returned, we use that state as given (manual creation is determined by the lack of ids)
- If an upstream state or iterable of upstream states is returned, we apply the aggregate rule
The aggregate rule says that given multiple states we will determine the final state such that:
- If any states are not COMPLETED the final state is FAILED
- If all of the states are COMPLETED the final state is COMPLETED
- The states will be placed in the final state
data
attribute
Callers should resolve all futures into states before passing return values to this function.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/states.py
218 219 220 221 222 223 224 225 226 227 228 229 230 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 275 276 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 |
|