The Result classes in this
prefect.engine.result package are results used internally by the Prefect pipeline to track and store results without persistence.
If you are looking for the API docs for the result subclasses you can use to enable task return value checkpointing or to store task data, see the API docs for the Result Subclasses in
prefect.engine.result.base.Result(value=None, location=None, serializer=None)[source]
A representation of the result of a Prefect task; this class contains information about the value of a task's result, a result handler specifying how to serialize or store this value securely, and a
safe_value attribute which holds information about the current "safe" representation of this result.
value (Any, optional): the value of the result
location (Union[str, Callable], optional): Possibly templated location to be used for saving the result to the destination. If a callable function is provided, it should have signature
callable(**kwargs) -> strand at write time all formatting kwargs will be passed and a fully formatted location is expected as the return value. Can be used for string formatting logic that
serializer (Serializer): a serializer that can transform Python objects to bytes and recover them. The serializer is used whenever the
Resultis writing to or reading from storage. Defaults to
Return a copy of the current result object.
Checks whether the target result exists.
Takes a set of string format key-value pairs and renders the result.location to a final location string
Create a new copy of the result object with the provided value.
Reads from the target result and returns a corresponding
Serialize and write the result to the target location.
This documentation was auto-generated from commit ffa9a6c
on February 1, 2023 at 18:44 UTC