prefect-client 3.4.7.dev5__tar.gz → 3.4.7.dev7__tar.gz

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prefect-client
-Version: 3.4.7.dev5
+Version: 3.4.7.dev7
 Summary: Workflow orchestration and management.
 Project-URL: Changelog, https://github.com/PrefectHQ/prefect/releases
 Project-URL: Documentation, https://docs.prefect.io

prefect_client-3.4.7.dev7/src/prefect/_build_info.py

@@ -0,0 +1,5 @@
+# Generated by versioningit
+__version__ = "3.4.7.dev7"
+__build_date__ = "2025-06-24 08:09:27.221869+00:00"
+__git_commit__ = "3614ff28a5600b1965c957a04e880aaf38442ad5"
+__dirty__ = False

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/client/orchestration/__init__.py

@@ -101,10 +101,11 @@ from prefect.client.schemas.filters import (
     WorkQueueFilterName,
 )
 from prefect.client.schemas.objects import (
-    Constant,
+    TaskRunResult,
+    FlowRunResult,
     Parameter,
+    Constant,
     TaskRunPolicy,
-    TaskRunResult,
     WorkQueue,
     WorkQueueStatusDetail,
 )
@@ -778,13 +779,7 @@ class PrefectClient(
         task_inputs: Optional[
             dict[
                 str,
-                list[
-                    Union[
-                        TaskRunResult,
-                        Parameter,
-                        Constant,
-                    ]
-                ],
+                list[Union[TaskRunResult, FlowRunResult, Parameter, Constant]],
             ]
         ] = None,
     ) -> TaskRun:
@@ -1440,6 +1435,7 @@ class SyncPrefectClient(
                 list[
                     Union[
                         TaskRunResult,
+                        FlowRunResult,
                         Parameter,
                         Constant,
                     ]

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/client/orchestration/_deployments/client.py

@@ -297,7 +297,7 @@ class DeploymentClient(BaseClient):
             deployment_id: the deployment ID of interest
 
         Returns:
-            a [Deployment model][prefect.client.schemas.objects.Deployment] representation of the deployment
+            a Deployment model representation of the deployment
         """
 
         from prefect.client.schemas.responses import DeploymentResponse
@@ -961,7 +961,7 @@ class DeploymentAsyncClient(BaseAsyncClient):
             deployment_id: the deployment ID of interest
 
         Returns:
-            a [Deployment model][prefect.client.schemas.objects.Deployment] representation of the deployment
+            a Deployment model representation of the deployment
         """
 
         from prefect.client.schemas.responses import DeploymentResponse

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/client/orchestration/_flows/client.py

@@ -31,7 +31,7 @@ class FlowClient(BaseClient):
         Create a flow in the Prefect API.
 
         Args:
-            flow: a [Flow][prefect.flows.Flow] object
+            flow: a `Flow` object
 
         Raises:
             httpx.RequestError: if a flow was not created for any reason
@@ -78,7 +78,7 @@ class FlowClient(BaseClient):
             flow_id: the flow ID of interest
 
         Returns:
-            a [Flow model][prefect.client.schemas.objects.Flow] representation of the flow
+            a Flow model representation of the flow
         """
         response = self.request("GET", "/flows/{id}", path_params={"id": flow_id})
         from prefect.client.schemas.objects import Flow
@@ -190,7 +190,7 @@ class FlowAsyncClient(BaseAsyncClient):
         Create a flow in the Prefect API.
 
         Args:
-            flow: a [Flow][prefect.flows.Flow] object
+            flow: a `Flow` object
 
         Raises:
             httpx.RequestError: if a flow was not created for any reason
@@ -237,7 +237,7 @@ class FlowAsyncClient(BaseAsyncClient):
             flow_id: the flow ID of interest
 
         Returns:
-            a [Flow model][prefect.client.schemas.objects.Flow] representation of the flow
+            a Flow model representation of the flow
         """
         response = await self.request("GET", "/flows/{id}", path_params={"id": flow_id})
         from prefect.client.schemas.objects import Flow

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/client/schemas/__init__.py

@@ -11,11 +11,12 @@ if TYPE_CHECKING:
         BlockType,
         FlowRun,
         FlowRunPolicy,
+        FlowRunResult,
         State,
         StateDetails,
         StateType,
         TaskRun,
-        TaskRunInput,
+        RunInput,
         TaskRunPolicy,
         TaskRunResult,
         Workspace,
@@ -36,6 +37,7 @@ _public_api = {
     "DEFAULT_BLOCK_SCHEMA_VERSION": (__package__, ".objects"),
     "FlowRun": (__package__, ".objects"),
     "FlowRunPolicy": (__package__, ".objects"),
+    "FlowRunResult": (__package__, ".objects"),
     "OrchestrationResult": (__package__, ".responses"),
     "SetStateStatus": (__package__, ".responses"),
     "State": (__package__, ".objects"),
@@ -60,6 +62,7 @@ __all__ = [
     "DEFAULT_BLOCK_SCHEMA_VERSION",
     "FlowRun",
     "FlowRunPolicy",
+    "FlowRunResult",
     "OrchestrationResult",
     "SetStateStatus",
     "State",
@@ -70,7 +73,7 @@ __all__ = [
     "StateRejectDetails",
     "StateType",
     "TaskRun",
-    "TaskRunInput",
+    "RunInput",
     "TaskRunPolicy",
     "TaskRunResult",
     "Workspace",

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/client/schemas/actions.py

@@ -443,6 +443,7 @@ class TaskRunCreate(ActionBaseModel):
         list[
             Union[
                 objects.TaskRunResult,
+                objects.FlowRunResult,
                 objects.Parameter,
                 objects.Constant,
             ]

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/client/schemas/filters.py

@@ -462,6 +462,9 @@ class DeploymentFilterId(PrefectBaseModel):
     any_: Optional[List[UUID]] = Field(
         default=None, description="A list of deployment ids to include"
     )
+    not_any_: Optional[List[UUID]] = Field(
+        default=None, description="A list of deployment ids to exclude"
+    )
 
 
 class DeploymentFilterName(PrefectBaseModel):

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/client/schemas/objects.py

@@ -81,6 +81,11 @@ DEFAULT_BLOCK_SCHEMA_VERSION: Literal["non-versioned"] = "non-versioned"
 DEFAULT_AGENT_WORK_POOL_NAME: Literal["default-agent-pool"] = "default-agent-pool"
 
 
+class RunType(AutoEnum):
+    FLOW_RUN = "flow_run"
+    TASK_RUN = "task_run"
+
+
 class StateType(AutoEnum):
     """Enumeration of state types."""
 
@@ -164,7 +169,6 @@ class ConcurrencyLimitConfig(PrefectBaseModel):
 class StateDetails(PrefectBaseModel):
     flow_run_id: Optional[UUID] = None
     task_run_id: Optional[UUID] = None
-    # for task runs that represent subflows, the subflow's run ID
     child_flow_run_id: Optional[UUID] = None
     scheduled_time: Optional[DateTime] = None
     cache_key: Optional[str] = None
@@ -182,6 +186,16 @@ class StateDetails(PrefectBaseModel):
     # Captures the trace_id and span_id of the span where this state was created
     traceparent: Optional[str] = None
 
+    def to_run_result(
+        self, run_type: RunType
+    ) -> Optional[Union[FlowRunResult, TaskRunResult]]:
+        if run_type == run_type.FLOW_RUN and self.flow_run_id:
+            return FlowRunResult(id=self.flow_run_id)
+        elif run_type == run_type.TASK_RUN and self.task_run_id:
+            return TaskRunResult(id=self.task_run_id)
+        else:
+            return None
+
 
 def data_discriminator(x: Any) -> str:
     if isinstance(x, dict) and "storage_key" in x:
@@ -734,7 +748,7 @@ class TaskRunPolicy(PrefectBaseModel):
         return validate_not_negative(v)
 
 
-class TaskRunInput(PrefectBaseModel):
+class RunInput(PrefectBaseModel):
     """
     Base class for classes that represent inputs to task runs, which
     could include, constants, parameters, or other task runs.
@@ -747,21 +761,26 @@ class TaskRunInput(PrefectBaseModel):
         input_type: str
 
 
-class TaskRunResult(TaskRunInput):
+class TaskRunResult(RunInput):
     """Represents a task run result input to another task run."""
 
     input_type: Literal["task_run"] = "task_run"
     id: UUID
 
 
-class Parameter(TaskRunInput):
+class FlowRunResult(RunInput):
+    input_type: Literal["flow_run"] = "flow_run"
+    id: UUID
+
+
+class Parameter(RunInput):
     """Represents a parameter input to a task run."""
 
     input_type: Literal["parameter"] = "parameter"
     name: str
 
 
-class Constant(TaskRunInput):
+class Constant(RunInput):
     """Represents constant input value to a task run."""
 
     input_type: Literal["constant"] = "constant"
@@ -811,7 +830,9 @@ class TaskRun(TimeSeriesBaseModel, ObjectBaseModel):
     state_id: Optional[UUID] = Field(
         default=None, description="The id of the current task run state."
     )
-    task_inputs: dict[str, list[Union[TaskRunResult, Parameter, Constant]]] = Field(
+    task_inputs: dict[
+        str, list[Union[TaskRunResult, FlowRunResult, Parameter, Constant]]
+    ] = Field(
         default_factory=dict,
         description=(
             "Tracks the source of inputs to a task run. Used for internal bookkeeping. "

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/context.py

@@ -34,6 +34,7 @@ from prefect._internal.compatibility.migration import getattr_migration
 from prefect.assets import Asset
 from prefect.client.orchestration import PrefectClient, SyncPrefectClient, get_client
 from prefect.client.schemas import FlowRun, TaskRun
+from prefect.client.schemas.objects import RunType
 from prefect.events.worker import EventsWorker
 from prefect.exceptions import MissingContextError
 from prefect.results import (
@@ -363,7 +364,7 @@ class EngineContext(RunContext):
         flow: The flow instance associated with the run
         flow_run: The API metadata for the flow run
         task_runner: The task runner instance being used for the flow run
-        task_run_results: A mapping of result ids to task run states for this flow run
+        run_results: A mapping of result ids to run states for this flow run
         log_prints: Whether to log print statements from the flow run
         parameters: The parameters passed to the flow run
         detached: Flag indicating if context has been serialized and sent to remote infrastructure
@@ -394,9 +395,10 @@ class EngineContext(RunContext):
     # Counter for flow pauses
     observed_flow_pauses: dict[str, int] = Field(default_factory=dict)
 
-    # Tracking for result from task runs in this flow run for dependency tracking
-    # Holds the ID of the object returned by the task run and task run state
-    task_run_results: dict[int, State] = Field(default_factory=dict)
+    # Tracking for result from task runs and sub flows in this flow run for
+    # dependency tracking. Holds the ID of the object returned by
+    # the run and state
+    run_results: dict[int, tuple[State, RunType]] = Field(default_factory=dict)
 
     # Tracking information needed to track asset linage between
     # tasks and materialization

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/flow_engine.py

@@ -105,7 +105,7 @@ from prefect.utilities.callables import (
 from prefect.utilities.collections import visit_collection
 from prefect.utilities.engine import (
     capture_sigterm,
-    link_state_to_result,
+    link_state_to_flow_run_result,
     propose_state,
     propose_state_sync,
     resolve_to_final_result,
@@ -338,6 +338,7 @@ class FlowRunEngine(BaseFlowRunEngine[P, R]):
             self._return_value, State
         ):
             _result = self._return_value
+            link_state_to_flow_run_result(self.state, _result)
 
             if asyncio.iscoroutine(_result):
                 # getting the value for a BaseResult may return an awaitable
@@ -373,6 +374,7 @@ class FlowRunEngine(BaseFlowRunEngine[P, R]):
         self.set_state(terminal_state)
         self._return_value = resolved_result
 
+        link_state_to_flow_run_result(terminal_state, resolved_result)
         self._telemetry.end_span_on_success()
 
         return result
@@ -903,6 +905,7 @@ class AsyncFlowRunEngine(BaseFlowRunEngine[P, R]):
             self._return_value, State
         ):
             _result = self._return_value
+            link_state_to_flow_run_result(self.state, _result)
 
             if asyncio.iscoroutine(_result):
                 # getting the value for a BaseResult may return an awaitable
@@ -1426,7 +1429,7 @@ def run_generator_flow_sync(
                     while True:
                         gen_result = next(gen)
                         # link the current state to the result for dependency tracking
-                        link_state_to_result(engine.state, gen_result)
+                        link_state_to_flow_run_result(engine.state, gen_result)
                         yield gen_result
                 except StopIteration as exc:
                     engine.handle_success(exc.value)
@@ -1468,7 +1471,7 @@ async def run_generator_flow_async(
                         # can't use anext in Python < 3.10
                         gen_result = await gen.__anext__()
                         # link the current state to the result for dependency tracking
-                        link_state_to_result(engine.state, gen_result)
+                        link_state_to_flow_run_result(engine.state, gen_result)
                         yield gen_result
                 except (StopAsyncIteration, GeneratorExit) as exc:
                     await engine.handle_success(None)

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/flows.py

@@ -1,5 +1,5 @@
 """
-Module containing the base workflow class and decorator - for most use cases, using the [`@flow` decorator][prefect.flows.flow] is preferred.
+Module containing the base workflow class and decorator - for most use cases, using the `@flow` decorator is preferred.
 """
 
 from __future__ import annotations
@@ -145,9 +145,6 @@ class Flow(Generic[P, R]):
     """
     A Prefect workflow definition.
 
-    !!! note
-        We recommend using the [`@flow` decorator][prefect.flows.flow] for most use-cases.
-
     Wraps a function with an entrypoint to the Prefect engine. To preserve the input
     and output types, we use the generic type variables `P` and `R` for "Parameters" and
     "Returns" respectively.
@@ -500,23 +497,29 @@ class Flow(Generic[P, R]):
 
             Create a new flow from an existing flow and update the name:
 
-            >>> @flow(name="My flow")
-            >>> def my_flow():
-            >>>     return 1
-            >>>
-            >>> new_flow = my_flow.with_options(name="My new flow")
+            ```python
+            from prefect import flow
+
+            @flow(name="My flow")
+            def my_flow():
+                return 1
+
+            new_flow = my_flow.with_options(name="My new flow")
+            ```
 
             Create a new flow from an existing flow, update the task runner, and call
             it without an intermediate variable:
 
-            >>> from prefect.task_runners import ThreadPoolTaskRunner
-            >>>
-            >>> @flow
-            >>> def my_flow(x, y):
-            >>>     return x + y
-            >>>
-            >>> state = my_flow.with_options(task_runner=ThreadPoolTaskRunner)(1, 3)
-            >>> assert state.result() == 4
+            ```python
+            from prefect.task_runners import ThreadPoolTaskRunner
+
+            @flow
+            def my_flow(x, y):
+                return x + y
+
+            state = my_flow.with_options(task_runner=ThreadPoolTaskRunner)(1, 3)
+            assert state.result() == 4
+            ```
         """
         new_task_runner = (
             task_runner() if isinstance(task_runner, type) else task_runner
@@ -1653,22 +1656,27 @@ class Flow(Generic[P, R]):
 
             Define a flow
 
-            >>> @flow
-            >>> def my_flow(name):
-            >>>     print(f"hello {name}")
-            >>>     return f"goodbye {name}"
+            ```python
+            @flow
+            def my_flow(name):
+                print(f"hello {name}")
+                return f"goodbye {name}"
+            ```
 
             Run a flow
 
-            >>> my_flow("marvin")
-            hello marvin
-            "goodbye marvin"
+            ```python
+            my_flow("marvin")
+            ```
 
             Run a flow with additional tags
 
-            >>> from prefect import tags
-            >>> with tags("db", "blue"):
-            >>>     my_flow("foo")
+            ```python
+            from prefect import tags
+
+            with tags("db", "blue"):
+                my_flow("foo")
+            ```
         """
         from prefect.utilities.visualization import (
             get_task_viz_tracker,
@@ -1907,36 +1915,47 @@ class FlowDecorator:
         Examples:
             Define a simple flow
 
-            >>> from prefect import flow
-            >>> @flow
-            >>> def add(x, y):
-            >>>     return x + y
+            ```python
+            from prefect import flow
+
+            @flow
+            def add(x, y):
+                return x + y
+            ```
 
             Define an async flow
 
-            >>> @flow
-            >>> async def add(x, y):
-            >>>     return x + y
+            ```python
+            @flow
+            async def add(x, y):
+                return x + y
+            ```
 
             Define a flow with a version and description
 
-            >>> @flow(version="first-flow", description="This flow is empty!")
-            >>> def my_flow():
-            >>>     pass
+            ```python
+            @flow(version="first-flow", description="This flow is empty!")
+            def my_flow():
+                pass
+            ```
 
             Define a flow with a custom name
 
-            >>> @flow(name="The Ultimate Flow")
-            >>> def my_flow():
-            >>>     pass
+            ```python
+            @flow(name="The Ultimate Flow")
+            def my_flow():
+                pass
+            ```
 
             Define a flow that submits its tasks to dask
 
-            >>> from prefect_dask.task_runners import DaskTaskRunner
-            >>>
-            >>> @flow(task_runner=DaskTaskRunner)
-            >>> def my_flow():
-            >>>     pass
+            ```python
+            from prefect_dask.task_runners import DaskTaskRunner
+
+            @flow(task_runner=DaskTaskRunner)
+            def my_flow():
+                pass
+            ```
         """
         if __fn:
             return Flow(

{prefect_client-3.4.7.dev5 → prefect_client-3.4.7.dev7}/src/prefect/runner/submit.py

@@ -17,7 +17,13 @@ from prefect.client.schemas.filters import (
     FlowRunFilterParentFlowRunId,
     TaskRunFilter,
 )
-from prefect.client.schemas.objects import Constant, FlowRun, Parameter, TaskRunResult
+from prefect.client.schemas.objects import (
+    Constant,
+    FlowRun,
+    FlowRunResult,
+    Parameter,
+    TaskRunResult,
+)
 from prefect.context import FlowRunContext
 from prefect.flows import Flow
 from prefect.logging import get_logger
@@ -66,9 +72,9 @@ async def _submit_flow_to_runner(
 
         parent_flow_run_context = FlowRunContext.get()
 
-        task_inputs: dict[str, list[TaskRunResult | Parameter | Constant]] = {
-            k: list(await collect_task_run_inputs(v)) for k, v in parameters.items()
-        }
+        task_inputs: dict[
+            str, list[Union[TaskRunResult, FlowRunResult, Parameter, Constant]]
+        ] = {k: list(await collect_task_run_inputs(v)) for k, v in parameters.items()}
         parameters = await resolve_inputs(parameters)
         dummy_task = Task(name=flow.name, fn=flow.fn, version=flow.version)
         parent_task_run = await client.create_task_run(