Add PrefectFuture implementation for flow runs
#17234
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CodSpeed Performance ReportMerging #17234 will not alter performanceComparing Summary
|
cicdw
reviewed
Feb 21, 2025
src/prefect/futures.py
Outdated
| return self._task_run_id | ||
|
|
||
| @property | ||
| def state(self) -> State: | ||
| """The current state of the task run associated with this future""" | ||
| warnings.warn( | ||
| "The state property of PrefectFuture is deprecated and will be removed in a future release. " | ||
| "If you are subclassing PrefectFuture, please implement the state property in your subclass.", |
There was a problem hiding this comment.
is it worth pointing these folks to the new class?
There was a problem hiding this comment.
and is the plan for these to raise NotImplemented errors in the future?
There was a problem hiding this comment.
Yeah, I can point to the new class. The plan is to remove these methods from PrefectFuture and let subclasses manage their implementation.
zzstoatzz
reviewed
Feb 21, 2025
cicdw
approved these changes
Feb 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a
PrefectFutureimplementation for tracking flow run execution that works similarly to thePrefectDistributedFuturefor task runs. To support the operation of the newPrefectFlowRunFuture, this PR also adds aFlowRunWaiterto monitor the execution of flow runs via events.To make the inheritance hierarchy of
PrefectFuturemake a little more sense, I also added aPrefectTaskRunFutureclass to hold some of the implementations that were onPrefectFutureso thatPrefectFuturecan be purely an interface and not a Frankenstein class. The implementations onPrefectFutruehave been deprecated and should be removed in a later release. This should only affect users that might be subclassingPrefectFuture.This new future type will be used to track flow runs submitted to remote infrastructure via a worker.
Related to #17194