Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update results settings to match new docstring format #7142

Merged
merged 1 commit into from
Oct 12, 2022
Merged

Update results settings to match new docstring format #7142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions src/prefect/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,8 +323,8 @@ def warn_on_database_password_value_without_usage(values):
PREFECT_RESULTS_DEFAULT_SERIALIZER = Setting(
str,
default="pickle",
description="The default serializer to use when not otherwise specified.",
)
"""The default serializer to use when not otherwise specified."""

PREFECT_LOCAL_STORAGE_PATH = Setting(
Path,
Expand Down Expand Up @@ -434,23 +434,18 @@ def warn_on_database_password_value_without_usage(values):
prefetched. Defaults to `10`.
"""

PREFECT_ASYNC_FETCH_STATE_RESULT = Setting(
bool,
default=False,
description=textwrap.dedent(
"""
Determines whether `State.result()` fetches results automatically or not.
In Prefect 2.6.0, the `State.result()` method was updated to be async
to faciliate automatic retrieval of results from storage which means when
writing async code you must `await` the call. For backwards compatibility,
the result is not retrieved by default for async users. You may opt into this
per call by passing `fetch=True` or toggle this setting to change the behavior
globally.
This setting does not affect users writing synchronous tasks and flows.
This setting does not affect retrieval of results when using `Future.result()`.
"""
),
)
PREFECT_ASYNC_FETCH_STATE_RESULT = Setting(bool, default=False)
"""
Determines whether `State.result()` fetches results automatically or not.
In Prefect 2.6.0, the `State.result()` method was updated to be async
to faciliate automatic retrieval of results from storage which means when
writing async code you must `await` the call. For backwards compatibility,
the result is not retrieved by default for async users. You may opt into this
per call by passing `fetch=True` or toggle this setting to change the behavior
globally.
This setting does not affect users writing synchronous tasks and flows.
This setting does not affect retrieval of results when using `Future.result()`.
"""

PREFECT_ORION_BLOCKS_REGISTER_ON_START = Setting(
bool,
Expand Down