prefect 3.6.27.dev2__tar.gz → 3.6.27.dev3__tar.gz

prefect-3.6.27.dev3/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: prefect
+Version: 3.6.27.dev3
+Summary: Workflow orchestration and management.
+Project-URL: Changelog, https://github.com/PrefectHQ/prefect/releases
+Project-URL: Documentation, https://docs.prefect.io
+Project-URL: Source, https://github.com/PrefectHQ/prefect
+Project-URL: Tracker, https://github.com/PrefectHQ/prefect/issues
+Author-email: "Prefect Technologies, Inc." <help@prefect.io>
+License: Apache-2.0
+License-File: LICENSE
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: <3.15,>=3.10
+Requires-Dist: aiosqlite<1.0.0,>=0.17.0
+Requires-Dist: alembic<2.0.0,>=1.7.5
+Requires-Dist: amplitude-analytics<2.0.0,>=1.2.1
+Requires-Dist: anyio<5.0.0,>=4.4.0
+Requires-Dist: apprise<2.0.0,>=1.1.0
+Requires-Dist: asgi-lifespan<3.0,>=1.0
+Requires-Dist: asyncpg<1.0.0,>=0.23
+Requires-Dist: cachetools<8.0,>=5.3
+Requires-Dist: click<9,>=8.0
+Requires-Dist: cloudpickle<4.0,>=2.0
+Requires-Dist: coolname<5.0.0,>=1.0.4
+Requires-Dist: cryptography>=36.0.1
+Requires-Dist: cyclopts>=4.8.0
+Requires-Dist: dateparser<2.0.0,>=1.1.1
+Requires-Dist: docker<8.0,>=4.0
+Requires-Dist: exceptiongroup>=1.0.0
+Requires-Dist: fastapi<1.0.0,>=0.111.0
+Requires-Dist: fsspec>=2022.5.0
+Requires-Dist: graphviz>=0.20.1
+Requires-Dist: griffe<3.0.0,>=0.49.0
+Requires-Dist: httpcore<2.0.0,>=1.0.5
+Requires-Dist: httpx[http2]!=0.23.2,>=0.23
+Requires-Dist: humanize<5.0.0,>=4.9.0
+Requires-Dist: jinja2-humanize-extension>=0.4.0
+Requires-Dist: jinja2<4.0.0,>=3.1.6
+Requires-Dist: jsonpatch<2.0,>=1.32
+Requires-Dist: jsonschema<5.0.0,>=4.18.0
+Requires-Dist: opentelemetry-api<2.0.0,>=1.27.0
+Requires-Dist: orjson<4.0,>=3.7
+Requires-Dist: packaging<26.1,>=21.3
+Requires-Dist: pathspec>=0.8.0
+Requires-Dist: pendulum<4,>=3.1.0; python_version < '3.13'
+Requires-Dist: pluggy>=1.6.0
+Requires-Dist: prometheus-client>=0.20.0
+Requires-Dist: pydantic!=2.11.0,!=2.11.1,!=2.11.2,!=2.11.3,!=2.11.4,<3.0.0,>=2.10.1
+Requires-Dist: pydantic-core<3.0.0,>=2.12.0
+Requires-Dist: pydantic-extra-types<3.0.0,>=2.8.2
+Requires-Dist: pydantic-settings!=2.9.0,<3.0.0,>2.2.1
+Requires-Dist: pydocket>=0.19.0
+Requires-Dist: python-dateutil<3.0.0,>=2.8.2
+Requires-Dist: python-slugify<9.0,>=5.0
+Requires-Dist: pytz<2027,>=2021.1
+Requires-Dist: pyyaml<7.0.0,>=5.4.1
+Requires-Dist: readchar<5.0.0,>=4.0.0
+Requires-Dist: rfc3339-validator<0.2.0,>=0.1.4
+Requires-Dist: rich<15.0,>=11.0
+Requires-Dist: ruamel-yaml-clib>=0.2.8; platform_python_implementation == 'CPython'
+Requires-Dist: ruamel-yaml>=0.17.0
+Requires-Dist: semver>=3.0.4
+Requires-Dist: sniffio<2.0.0,>=1.3.0
+Requires-Dist: sqlalchemy[asyncio]<3.0.0,>=2.0
+Requires-Dist: toml>=0.10.0
+Requires-Dist: typing-extensions<5.0.0,>=4.10.0
+Requires-Dist: uvicorn!=0.29.0,>=0.14.0
+Requires-Dist: websockets<17.0,>=15.0.1
+Requires-Dist: whenever<0.11.0,>=0.7.3; python_version >= '3.13'
+Provides-Extra: aws
+Requires-Dist: prefect-aws>=0.5.8; extra == 'aws'
+Provides-Extra: azure
+Requires-Dist: prefect-azure>=0.4.0; extra == 'azure'
+Provides-Extra: bitbucket
+Requires-Dist: prefect-bitbucket>=0.3.0; extra == 'bitbucket'
+Provides-Extra: buildx
+Requires-Dist: python-on-whales>=0.81; extra == 'buildx'
+Provides-Extra: bundles
+Requires-Dist: uv>=0.6.0; extra == 'bundles'
+Provides-Extra: dask
+Requires-Dist: prefect-dask>=0.3.0; extra == 'dask'
+Provides-Extra: databricks
+Requires-Dist: prefect-databricks>=0.3.0; extra == 'databricks'
+Provides-Extra: dbt
+Requires-Dist: prefect-dbt>=0.6.0; extra == 'dbt'
+Provides-Extra: docker
+Requires-Dist: prefect-docker>=0.6.0; extra == 'docker'
+Provides-Extra: email
+Requires-Dist: prefect-email>=0.4.0; extra == 'email'
+Provides-Extra: gcp
+Requires-Dist: prefect-gcp>=0.6.0; extra == 'gcp'
+Provides-Extra: github
+Requires-Dist: prefect-github>=0.3.0; extra == 'github'
+Provides-Extra: gitlab
+Requires-Dist: prefect-gitlab>=0.3.0; extra == 'gitlab'
+Provides-Extra: kubernetes
+Requires-Dist: prefect-kubernetes>=0.4.0; extra == 'kubernetes'
+Provides-Extra: otel
+Requires-Dist: opentelemetry-distro<1.0.0,>=0.48b0; extra == 'otel'
+Requires-Dist: opentelemetry-exporter-otlp<2.0.0,>=1.27.0; extra == 'otel'
+Requires-Dist: opentelemetry-instrumentation-logging<1.0.0,>=0.48b0; extra == 'otel'
+Requires-Dist: opentelemetry-instrumentation-system-metrics<1.0.0,>=0.48b0; extra == 'otel'
+Requires-Dist: opentelemetry-instrumentation<1.0.0,>=0.48b0; extra == 'otel'
+Requires-Dist: opentelemetry-test-utils<1.0.0,>=0.48b0; extra == 'otel'
+Provides-Extra: ray
+Requires-Dist: prefect-ray>=0.4.0; extra == 'ray'
+Provides-Extra: redis
+Requires-Dist: prefect-redis>=0.2.0; extra == 'redis'
+Provides-Extra: shell
+Requires-Dist: prefect-shell>=0.3.0; extra == 'shell'
+Provides-Extra: slack
+Requires-Dist: prefect-slack>=0.3.0; extra == 'slack'
+Provides-Extra: snowflake
+Requires-Dist: prefect-snowflake>=0.28.0; extra == 'snowflake'
+Provides-Extra: sqlalchemy
+Requires-Dist: prefect-sqlalchemy>=0.5.0; extra == 'sqlalchemy'
+Description-Content-Type: text/markdown
+
+<p align="center"><img src="https://github.com/PrefectHQ/prefect/assets/3407835/c654cbc6-63e8-4ada-a92a-efd2f8f24b85" width=1000></p>
+
+<p align="center">
+    <a href="https://pypi.org/project/prefect/" alt="PyPI version">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect?color=0052FF&labelColor=090422" />
+    </a>
+    <a href="https://pypi.org/project/prefect/" alt="PyPI downloads/month">
+        <img alt="Downloads" src="https://img.shields.io/pypi/dm/prefect?color=0052FF&labelColor=090422" />
+    </a>
+    <a href="https://github.com/prefecthq/prefect/" alt="Stars">
+        <img src="https://img.shields.io/github/stars/prefecthq/prefect?color=0052FF&labelColor=090422" />
+    </a>
+    <a href="https://github.com/prefecthq/prefect/pulse" alt="Activity">
+        <img src="https://img.shields.io/github/commit-activity/m/prefecthq/prefect?color=0052FF&labelColor=090422" />
+    </a>
+    <br>
+    <a href="https://prefect.io/slack" alt="Slack">
+        <img src="https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack" />
+    </a>
+    <a href="https://www.youtube.com/c/PrefectIO/" alt="YouTube">
+        <img src="https://img.shields.io/badge/youtube-watch_videos-red.svg?color=0052FF&labelColor=090422&logo=youtube" />
+    </a>
+</p>
+
+
+<p align="center">
+    <a href="https://docs.prefect.io/v3/get-started/index?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none">
+        Installation
+    </a>
+    ·
+    <a href="https://docs.prefect.io/v3/get-started/quickstart?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none">
+        Quickstart
+    </a>
+    ·
+    <a href="https://docs.prefect.io/v3/how-to-guides/workflows/write-and-run?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none">
+        Build workflows
+    </a>
+    ·
+    <a href="https://docs.prefect.io/v3/concepts/deployments?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none">
+        Deploy workflows
+    </a>
+    ·
+    <a href="https://app.prefect.cloud/?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none">
+        Prefect Cloud
+    </a>
+</p>
+
+# Prefect
+
+Prefect is a workflow orchestration framework for building data pipelines in Python.
+It's the simplest way to elevate a script into a production workflow.
+With Prefect, you can build resilient, dynamic data pipelines that react to the world around them and recover from unexpected changes.
+
+With just a few lines of code, data teams can confidently automate any data process with features such as scheduling, caching, retries, and event-based automations.
+
+Workflow activity is tracked and can be monitored with a self-hosted [Prefect server](https://docs.prefect.io/latest/manage/self-host/?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none) instance or managed [Prefect Cloud](https://www.prefect.io/cloud-vs-oss?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none) dashboard.
+
+> [!TIP]
+> Prefect flows can handle retries, dependencies, and even complex branching logic
+> 
+> [Check our docs](https://docs.prefect.io/v3/get-started/index?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none) or see the example below to learn more!
+
+## Getting started
+
+Prefect requires Python 3.10+. To [install the latest version of Prefect](https://docs.prefect.io/v3/get-started/install), run one of the following commands:
+
+```bash
+pip install -U prefect
+```
+
+```bash
+uv add prefect
+```
+
+Then create and run a Python file that uses Prefect `flow` and `task` decorators to orchestrate and observe your workflow - in this case, a simple script that fetches the number of GitHub stars from a repository:
+
+```python
+from prefect import flow, task
+import httpx
+
+
+@task(log_prints=True)
+def get_stars(repo: str):
+    url = f"https://api.github.com/repos/{repo}"
+    count = httpx.get(url).json()["stargazers_count"]
+    print(f"{repo} has {count} stars!")
+
+
+@flow(name="GitHub Stars")
+def github_stars(repos: list[str]):
+    for repo in repos:
+        get_stars(repo)
+
+
+# run the flow!
+if __name__ == "__main__":
+    github_stars(["PrefectHQ/prefect"])
+```
+
+Fire up a Prefect server and open the UI at http://localhost:4200 to see what happened:
+
+```bash
+prefect server start
+```
+
+To run your workflow on a schedule, turn it into a deployment and schedule it to run every minute by changing the last line of your script to the following:
+
+```python
+if __name__ == "__main__":
+    github_stars.serve(
+        name="first-deployment",
+        cron="* * * * *",
+        parameters={"repos": ["PrefectHQ/prefect"]}
+    )
+```
+
+You now have a process running locally that is looking for scheduled deployments!
+Additionally you can run your workflow manually from the UI or CLI. You can even run deployments in response to [events](https://docs.prefect.io/latest/automate/?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none).
+
+> [!TIP]
+> Where to go next - check out our [documentation](https://docs.prefect.io/v3/get-started/index?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none) to learn more about:
+> - [Deploying flows to production environments](https://docs.prefect.io/v3/deploy?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none)
+> - [Adding error handling and retries](https://docs.prefect.io/v3/develop/write-tasks#retries?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none)
+> - [Integrating with your existing tools](https://docs.prefect.io/integrations/integrations?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none)
+> - [Setting up team collaboration features](https://docs.prefect.io/v3/manage/cloud/manage-users/manage-teams#manage-teams?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none)
+
+
+## Prefect Cloud
+
+Prefect Cloud provides workflow orchestration for the modern data enterprise. By automating over 200 million data tasks monthly, Prefect empowers diverse organizations — from Fortune 50 leaders such as Progressive Insurance to innovative disruptors such as Cash App — to increase engineering productivity, reduce pipeline errors, and cut data workflow compute costs.
+
+Read more about Prefect Cloud [here](https://www.prefect.io/cloud-vs-oss?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none) or sign up to [try it for yourself](https://app.prefect.cloud?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none).
+
+## prefect-client
+
+If your use case is geared towards communicating with Prefect Cloud or a remote Prefect server, check out our
+[prefect-client](https://pypi.org/project/prefect-client/). It is a lighter-weight option for accessing client-side functionality in the Prefect SDK and is ideal for use in ephemeral execution environments.
+
+## Connect & Contribute
+Join a thriving community of over 25,000 practitioners who solve data challenges with Prefect. Prefect's community is built on collaboration, technical innovation, and continuous improvement.
+
+### Community Resources
+🌐 **[Explore the Documentation](https://docs.prefect.io)** - Comprehensive guides and API references  
+💬 **[Join the Slack Community](https://prefect.io/slack)** - Connect with thousands of practitioners  
+🤝 **[Contribute to Prefect](https://docs.prefect.io/contribute/)** - Help shape the future of the project  
+ 🔌 **[Support or create a new Prefect integration](https://docs.prefect.io/contribute/contribute-integrations)** - Extend Prefect's capabilities   
+📋 **[Tail the Dev Log](https://dev-log.prefect.io/)** - Prefect's open source development blog
+
+### Stay Informed
+📥 **[Subscribe to our Newsletter](https://prefect.io/newsletter)** - Get the latest Prefect news and updates  
+📣 **[X](https://x.com/PrefectIO)** and **[Bluesky](https://bsky.app/profile/prefect.io)** - Latest updates and announcements  
+📺 **[YouTube](https://www.youtube.com/@PrefectIO)** - Video tutorials and webinars  
+📱 **[LinkedIn](https://www.linkedin.com/company/prefect)** - Professional networking and company news  
+
+Your contributions, questions, and ideas make Prefect better every day. Whether you're reporting bugs, suggesting features, or improving documentation, your input is invaluable to the Prefect community.
+

prefect-3.6.27.dev3/src/prefect/AGENTS.md

@@ -0,0 +1,57 @@
+# Core Prefect SDK
+
+The foundation for building and executing workflows with Python. This covers the SDK layer — decorators, engines, state management, and client-side abstractions.
+
+## Public API
+
+There is no formal public/private boundary beyond the `_` prefix convention. Modules and functions prefixed with `_` are internal. Everything else is considered public and requires backward compatibility.
+
+## Entry Points
+
+- `flows.py` / `tasks.py` — `@flow` and `@task` decorator definitions. The primary user-facing API.
+- `flow_engine.py` / `task_engine.py` — Async execution engines that orchestrate runs. **Critical invariant:** both sync and async engine paths must be kept in lockstep. Changes to one must be mirrored in the other.
+- `states.py` — State objects and transition logic
+- `results.py` — Result persistence and retrieval
+- `futures.py` — `PrefectFuture` for async task results
+- `task_runners.py` — Task runner implementations (`ThreadPoolTaskRunner`, `ProcessPoolTaskRunner`)
+- `transactions.py` — Transaction support
+- `context.py` — Runtime context management and dependency injection
+
+## Key Contracts
+
+- **Engine ordering matters.** The engines apply features (retries, caching, result persistence, transactions) in a specific order. Changing the order or forgetting a feature in one engine path is the most common source of breakage.
+- **Sync and async must stay in sync.** Both `flow_engine.py` and `task_engine.py` have sync and async paths. Any behavior change must be applied to both.
+- **Flow and task engines advance state differently.** The flow engine makes blocking API calls to the server to propose and advance states. The task engine emits `prefect.task_run.*` events (delivered via WebSockets) but advances state locally through `set_state` calls with polling/backoff — do not assume the two engines work the same way.
+- **Flow state transitions go through the server.** The flow engine proposes states to the server, which accepts or rejects them via orchestration rules. The task engine, by contrast, manages state transitions locally via `set_state` and emits `prefect.task_run.*` events — it does not propose states to the server.
+- **`ProcessPoolTaskRunner` requires picklable data across subprocess boundaries.** `PrefectFuture` objects are not picklable and cannot be passed to worker subprocesses. Any `wait_for` futures must be waited on in the parent process and converted to `State` objects before submission. The subprocess task engine handles `State` objects via `resolve_to_final_result`, which raises `UpstreamTaskError` for non-completed upstreams.
+- **`ProcessPoolTaskRunner` instances may be deserialized without `__init__` running.** When a runner is pickled and restored in a subprocess, `__init__` is not called, so instance attributes set there may be absent. Access any such attribute via `getattr(self, "_attr", default)` rather than `self._attr` directly — both in the property getter and in `duplicate()`. The `subprocess_message_processor_factories` property demonstrates the required pattern.
+
+## Logging
+
+Use `get_logger()` from `prefect.logging` instead of raw `logging.getLogger()` — it adds API key obfuscation and places loggers under the `"prefect."` namespace.
+
+- General library code → `get_logger(__name__)`
+- SDK core modules (flows, tasks, engine) → `get_logger("flows")`, `get_logger("engine")`, etc.
+- Worker implementations → `get_worker_logger(self)`
+- Infrastructure orchestrating a run (engines) → `flow_run_logger(flow_run)` / `task_run_logger(task_run)`
+- Workers/runners needing child loggers → `.getChild("worker"|"runner", extra={...})` on a run logger
+- Code that may run inside or outside a run (concurrency, transactions, blocks) → try `get_run_logger()`, fall back to `get_logger(...)`
+- Raw `logging.getLogger()` only inside `src/prefect/logging/` (circular imports) or configuring third-party loggers
+
+## Related
+
+- `client/` → HTTP client for server communication (see client/AGENTS.md)
+- `server/` → Orchestration backend (see server/AGENTS.md)
+- `cli/` → Command-line interface (see cli/AGENTS.md)
+- `events/` → Event system and automations (see events/AGENTS.md)
+- `settings/` → Configuration system (see settings/AGENTS.md)
+- `concurrency/` → Concurrency slot acquisition and lease management (see concurrency/AGENTS.md)
+- `logging/` → Logging handlers, API log shipping, and run-context loggers (see logging/AGENTS.md)
+- `runner/` → Thin facade over extracted single-responsibility classes for local flow run execution (see runner/AGENTS.md)
+- `deployments/` → YAML-driven deployment lifecycle: project init, build/push/pull steps, and triggering remote flow runs (see deployments/AGENTS.md)
+- `utilities/` → Cross-cutting helpers: async utils, schema hydration, callables introspection, and more (see utilities/AGENTS.md)
+- `blocks/` → Server-persisted configuration objects for external service credentials and settings (see blocks/AGENTS.md)
+- `workers/` → Work-pool-based execution layer: polls for flow runs, dispatches to infrastructure (see workers/AGENTS.md)
+- `docker/` → `DockerImage` class for building and pushing Docker images during deployment
+- `telemetry/` → OS-level resource metric collection and run telemetry
+- `testing/` → Test utilities shipped with the SDK: `prefect_test_harness`, assertion helpers, and reusable fixtures (see testing/AGENTS.md)

prefect-3.6.27.dev3/src/prefect/_build_info.py

@@ -0,0 +1,5 @@
+# Generated by versioningit
+__version__ = "3.6.27.dev3"
+__build_date__ = "2026-04-15 08:41:54.802434+00:00"
+__git_commit__ = "d6d1648642e592b9bf0ceb80d973fb3f83380c38"
+__dirty__ = False

prefect-3.6.27.dev3/src/prefect/_states.py

@@ -0,0 +1,316 @@
+"""
+Private module containing sync versions of state functions.
+
+These functions are used internally by the sync task engine to avoid
+run_coro_as_sync overhead on Windows.
+"""
+
+from __future__ import annotations
+
+import datetime
+import sys
+import uuid
+from types import GeneratorType
+from typing import TYPE_CHECKING, Any, Optional
+
+import anyio
+import httpx
+import sniffio
+
+try:
+    _AnyioNoEventLoopError: type[BaseException] = anyio.NoEventLoopError
+except AttributeError:
+    # anyio < 4.11.0 doesn't have NoEventLoopError; in older versions,
+    # sniffio.AsyncLibraryNotFoundError is raised instead.
+    class _AnyioNoEventLoopError(Exception):  # type: ignore[no-redef]
+        pass
+
+
+from prefect.client.schemas.objects import State, StateType
+from prefect.exceptions import MissingContextError, TerminationSignal
+from prefect.logging.loggers import get_logger, get_run_logger
+from prefect.states import (
+    Completed,
+    Crashed,
+    Failed,
+    StateGroup,
+    format_exception,
+    is_state_iterable,
+)
+from prefect.utilities.collections import ensure_iterable
+
+if TYPE_CHECKING:
+    import logging
+
+    from prefect.results import (
+        R,
+        ResultStore,
+    )
+
+logger: "logging.Logger" = get_logger("states")
+
+
+def exception_to_crashed_state_sync(
+    exc: BaseException,
+    result_store: Optional["ResultStore"] = None,
+) -> State:
+    """
+    Sync version of exception_to_crashed_state.
+
+    Takes an exception that occurs _outside_ of user code and converts it to a
+    'Crash' exception with a 'Crashed' state.
+    """
+    state_message = None
+
+    # Check for anyio cancellation - but only if we're in an async context.
+    # anyio.get_cancelled_exc_class() requires an active async backend;
+    # calling it from sync-only code raises an error. Since anyio cancellation
+    # exceptions can only occur in async contexts anyway, we can safely skip
+    # this check when no async backend is running.
+    # anyio 4.12+ raises anyio.NoEventLoopError, older versions raise
+    # sniffio.AsyncLibraryNotFoundError. Catch both for compatibility.
+    # TODO: remove sniffio handling once anyio lower bound is >=4.12.1
+    try:
+        cancelled_exc_class = anyio.get_cancelled_exc_class()
+        is_anyio_cancelled = isinstance(exc, cancelled_exc_class)
+    except (sniffio.AsyncLibraryNotFoundError, _AnyioNoEventLoopError):
+        is_anyio_cancelled = False
+
+    if is_anyio_cancelled:
+        state_message = "Execution was cancelled by the runtime environment."
+
+    elif isinstance(exc, KeyboardInterrupt):
+        state_message = "Execution was aborted by an interrupt signal."
+
+    elif isinstance(exc, TerminationSignal):
+        state_message = "Execution was aborted by a termination signal."
+
+    elif isinstance(exc, SystemExit):
+        state_message = "Execution was aborted by Python system exit call."
+
+    elif isinstance(exc, (httpx.TimeoutException, httpx.ConnectError)):
+        try:
+            request: httpx.Request = exc.request
+        except RuntimeError:
+            # The request property is not set
+            state_message = (
+                "Request failed while attempting to contact the server:"
+                f" {format_exception(exc)}"
+            )
+        else:
+            # TODO: We can check if this is actually our API url
+            state_message = f"Request to {request.url} failed: {format_exception(exc)}."
+
+    else:
+        state_message = (
+            "Execution was interrupted by an unexpected exception:"
+            f" {format_exception(exc)}"
+        )
+
+    if result_store:
+        key = uuid.uuid4().hex
+        data = result_store.create_result_record(exc, key=key)
+    else:
+        # Attach the exception for local usage, will not be available when retrieved
+        # from the API
+        data = exc
+
+    return Crashed(message=state_message, data=data)
+
+
+def exception_to_failed_state_sync(
+    exc: Optional[BaseException] = None,
+    result_store: Optional["ResultStore"] = None,
+    write_result: bool = False,
+    **kwargs: Any,
+) -> State[BaseException]:
+    """
+    Sync version of exception_to_failed_state.
+
+    Convenience function for creating `Failed` states from exceptions
+    """
+    try:
+        local_logger = get_run_logger()
+    except MissingContextError:
+        local_logger = logger
+
+    if not exc:
+        _, exc, _ = sys.exc_info()
+        if exc is None:
+            raise ValueError(
+                "Exception was not passed and no active exception could be found."
+            )
+    else:
+        pass
+
+    if result_store:
+        key = uuid.uuid4().hex
+        data = result_store.create_result_record(exc, key=key)
+        if write_result:
+            try:
+                result_store.persist_result_record(data)
+            except Exception as nested_exc:
+                local_logger.warning(
+                    "Failed to write result: %s Execution will continue, but the result has not been written",
+                    nested_exc,
+                )
+    else:
+        # Attach the exception for local usage, will not be available when retrieved
+        # from the API
+        data = exc
+
+    existing_message = kwargs.pop("message", "")
+    if existing_message and not existing_message.endswith(" "):
+        existing_message += " "
+
+    # TODO: Consider if we want to include traceback information, it is intentionally
+    #       excluded from messages for now
+    message = existing_message + format_exception(exc)
+
+    state = Failed(data=data, message=message, **kwargs)
+    state.state_details.retriable = False
+
+    return state
+
+
+def return_value_to_state_sync(
+    retval: "R",
+    result_store: "ResultStore",
+    key: Optional[str] = None,
+    expiration: Optional[datetime.datetime] = None,
+    write_result: bool = False,
+) -> "State[R]":
+    """
+    Sync version of return_value_to_state.
+
+    Given a return value from a user's function, create a `State` the run should
+    be placed in.
+
+    - If data is returned, we create a 'COMPLETED' state with the data
+    - If a single, manually created state is returned, we use that state as given
+        (manual creation is determined by the lack of ids)
+    - If an upstream state or iterable of upstream states is returned, we apply the
+        aggregate rule
+
+    The aggregate rule says that given multiple states we will determine the final state
+    such that:
+
+    - If any states are not COMPLETED the final state is FAILED
+    - If all of the states are COMPLETED the final state is COMPLETED
+    - The states will be placed in the final state `data` attribute
+
+    Callers should resolve all futures into states before passing return values to this
+    function.
+    """
+    from prefect.results import (
+        ResultRecord,
+        ResultRecordMetadata,
+    )
+
+    try:
+        local_logger = get_run_logger()
+    except MissingContextError:
+        local_logger = logger
+
+    if (
+        isinstance(retval, State)
+        # Check for manual creation
+        and not retval.state_details.flow_run_id
+        and not retval.state_details.task_run_id
+    ):
+        state = retval
+        # Unless the user has already constructed a result explicitly, use the store
+        # to update the data to the correct type
+        if not isinstance(state.data, (ResultRecord, ResultRecordMetadata)):
+            result_record = result_store.create_result_record(
+                state.data,
+                key=key,
+                expiration=expiration,
+            )
+            if write_result:
+                try:
+                    result_store.persist_result_record(result_record)
+                except Exception as exc:
+                    local_logger.warning(
+                        "Encountered an error while persisting result: %s Execution will continue, but the result has not been persisted",
+                        exc,
+                    )
+            state.data = result_record
+        return state
+
+    # Determine a new state from the aggregate of contained states
+    if isinstance(retval, State) or is_state_iterable(retval):
+        states = StateGroup(ensure_iterable(retval))
+
+        # Determine the new state type
+        if states.all_completed():
+            new_state_type = StateType.COMPLETED
+        elif states.any_cancelled():
+            new_state_type = StateType.CANCELLED
+        elif states.any_paused():
+            new_state_type = StateType.PAUSED
+        else:
+            new_state_type = StateType.FAILED
+
+        # Generate a nice message for the aggregate
+        if states.all_completed():
+            message = "All states completed."
+        elif states.any_cancelled():
+            message = f"{states.cancelled_count}/{states.total_count} states cancelled."
+        elif states.any_paused():
+            message = f"{states.paused_count}/{states.total_count} states paused."
+        elif states.any_failed():
+            message = f"{states.fail_count}/{states.total_count} states failed."
+        elif not states.all_final():
+            message = (
+                f"{states.not_final_count}/{states.total_count} states are not final."
+            )
+        else:
+            message = "Given states: " + states.counts_message()
+
+        # TODO: We may actually want to set the data to a `StateGroup` object and just
+        #       allow it to be unpacked into a tuple and such so users can interact with
+        #       it
+        result_record = result_store.create_result_record(
+            retval,
+            key=key,
+            expiration=expiration,
+        )
+        if write_result:
+            try:
+                result_store.persist_result_record(result_record)
+            except Exception as exc:
+                local_logger.warning(
+                    "Encountered an error while persisting result: %s Execution will continue, but the result has not been persisted",
+                    exc,
+                )
+        return State(
+            type=new_state_type,
+            message=message,
+            data=result_record,
+        )
+
+    # Generators aren't portable, implicitly convert them to a list.
+    if isinstance(retval, GeneratorType):
+        data = list(retval)
+    else:
+        data = retval
+
+    # Otherwise, they just gave data and this is a completed retval
+    if isinstance(data, ResultRecord):
+        return Completed(data=data)
+    else:
+        result_record = result_store.create_result_record(
+            data,
+            key=key,
+            expiration=expiration,
+        )
+        if write_result:
+            try:
+                result_store.persist_result_record(result_record)
+            except Exception as exc:
+                local_logger.warning(
+                    "Encountered an error while persisting result: %s Execution will continue, but the result has not been persisted",
+                    exc,
+                )
+        return Completed(data=result_record)