Clarify result_storage usage with @task and @flow decorators
#19671
+57
−10
Conversation
This file contains hidden or 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
- Add Warning callout to results.mdx explaining block instances vs string references - Update @flow and @task decorator docstrings to document both patterns - Improve error messages to suggest string reference alternative Closes #16641 Co-Authored-By: [email protected] <[email protected]>
devin-ai-integration
bot
requested review from
cicdw,
desertaxle and
zzstoatzz
as code owners
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
CodSpeed Performance ReportMerging #19671 will not alter performanceComparing Summary
|
desertaxle
requested changes
Dec 8, 2025
docs/v3/advanced/results.mdx
Outdated
|
|
||
| When specifying `result_storage` in `@flow` or `@task` decorators, you have two options: | ||
|
|
||
| - **Block instances**: Must call `.save()` first, since decorators execute at import time before a server connection may be available |
Member
There was a problem hiding this comment.
Suggested change
| - **Block instances**: Must call `.save()` first, since decorators execute at import time before a server connection may be available | |
| - **Block instances**: The block instance must be saved server-side or loaded from a saved block instance before it is provided to the `@task` or `@flow` decorator. |
Contributor
Author
There was a problem hiding this comment.
Applied both suggestions - thanks for the feedback!
docs/v3/advanced/results.mdx
Outdated
| - **Block instances**: Must call `.save()` first, since decorators execute at import time before a server connection may be available | ||
| - **String references**: Use the format `"block-type-slug/block-name"` for deferred resolution at runtime | ||
|
|
||
| For testing scenarios (especially with pytest), string references are recommended since they don't require server connectivity at import time. |
Member
There was a problem hiding this comment.
Suggested change
| For testing scenarios (especially with pytest), string references are recommended since they don't require server connectivity at import time. | |
| For testing scenarios, string references are recommended since they don't require server connectivity at import time. |
desertaxle
changed the title
result_storage usage with @task and @flow decorators
- Update block instances description to be clearer - Remove pytest parenthetical from testing scenarios Co-Authored-By: [email protected] <[email protected]>
desertaxle
requested changes
Dec 8, 2025
docs/v3/advanced/results.mdx
Outdated
| other_storage_task() | ||
| ``` | ||
|
|
||
| <Warning> |
Member
There was a problem hiding this comment.
Can you make this an Info admonition instead of a Warning?
Contributor
Author
There was a problem hiding this comment.
Done - changed to Info admonition.
desertaxle
requested changes
Dec 8, 2025
desertaxle
reviewed
Dec 8, 2025
desertaxle
approved these changes
Dec 8, 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.
Addresses common user confusion around
@flowand@taskdecorators when usingresult_storagewith unsaved block instances, especially in pytest scenarios.Changes
Documentation (docs/v3/advanced/results.mdx):
result_storage:.save()first)Docstrings (flows.py, tasks.py):
result_storageparameter documentation in@flowand@taskdecorators to explain both patterns and when to use eachError messages:
Closes #16641
Checklist
<link to issue>"mint.json.Review checklist
from prefect.filesystems import LocalFileSystemis correct in the documentation exampleLink to Devin run: https://app.devin.ai/sessions/8a4d5455065443f2ac1d44b4bd4664fc
Requested by: [email protected] (@desertaxle)