prefect.utilities.annotations
¶
BaseAnnotation
¶
Bases: namedtuple('BaseAnnotation', field_names='value')
, ABC
, Generic[T]
Base class for Prefect annotation types.
Inherits from namedtuple
for unpacking support in another tools.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/utilities/annotations.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
|
NotSet
¶
Singleton to distinguish None
from a value that is not provided by the user.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/utilities/annotations.py
89 90 91 92 |
|
allow_failure
¶
Bases: BaseAnnotation[T]
Wrapper for states or futures.
Indicates that the upstream run for this input can be failed.
Generally, Prefect will not allow a downstream run to start if any of its inputs are failed. This annotation allows you to opt into receiving a failed input downstream.
If the input is from a failed run, the attached exception will be passed to your function.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/utilities/annotations.py
53 54 55 56 57 58 59 60 61 62 63 64 65 |
|
quote
¶
Bases: BaseAnnotation[T]
Simple wrapper to mark an expression as a different type so it will not be coerced by Prefect. For example, if you want to return a state from a flow without having the flow assume that state.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/utilities/annotations.py
68 69 70 71 72 73 74 75 76 |
|
unmapped
¶
Bases: BaseAnnotation[T]
Wrapper for iterables.
Indicates that this input should be sent as-is to all runs created during a mapping operation instead of being split.
Source code in /home/runner/work/docs/docs/prefect_source/src/prefect/utilities/annotations.py
40 41 42 43 44 45 46 47 48 49 50 |
|