prefect-client 3.1.15__py3-none-any.whl → 3.2.1__py3-none-any.whl

prefect/flows.py

@@ -49,7 +49,6 @@ from typing_extensions import Literal, ParamSpec
 from prefect._experimental.sla.objects import SlaTypes
 from prefect._internal.concurrency.api import create_call, from_async
 from prefect.blocks.core import Block
-from prefect.client.schemas.actions import DeploymentScheduleCreate
 from prefect.client.schemas.filters import WorkerFilter, WorkerFilterStatus
 from prefect.client.schemas.objects import ConcurrencyLimitConfig, FlowRun
 from prefect.client.utilities import client_injector
@@ -69,6 +68,7 @@ from prefect.futures import PrefectFuture
 from prefect.logging import get_logger
 from prefect.logging.loggers import flow_run_logger
 from prefect.results import ResultSerializer, ResultStorage
+from prefect.schedules import Schedule
 from prefect.settings import (
     PREFECT_DEFAULT_WORK_POOL_NAME,
     PREFECT_FLOW_DEFAULT_RETRIES,
@@ -120,8 +120,7 @@ class FlowStateHook(Protocol, Generic[P, R]):
 
     def __call__(
         self, flow: Flow[P, R], flow_run: FlowRun, state: State
-    ) -> Awaitable[None] | None:
-        ...
+    ) -> Awaitable[None] | None: ...
 
 
 if TYPE_CHECKING:
@@ -669,6 +668,7 @@ class Flow(Generic[P, R]):
         cron: Optional[Union[Iterable[str], str]] = None,
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
+        schedule: Optional[Schedule] = None,
         schedules: Optional["FlexibleScheduleList"] = None,
         concurrency_limit: Optional[Union[int, ConcurrencyLimitConfig, None]] = None,
         parameters: Optional[dict[str, Any]] = None,
@@ -693,6 +693,8 @@ class Flow(Generic[P, R]):
             cron: A cron schedule of when to execute runs of this deployment.
             rrule: An rrule schedule of when to execute runs of this deployment.
             paused: Whether or not to set this deployment as paused.
+            schedule: A schedule object defining when to execute runs of this deployment.
+                Used to provide additional scheduling options like `timezone` or `parameters`.
             schedules: A list of schedule objects defining when to execute runs of this deployment.
                 Used to define multiple schedules or additional scheduling options such as `timezone`.
             concurrency_limit: The maximum number of runs of this deployment that can run at the same time.
@@ -749,6 +751,7 @@ class Flow(Generic[P, R]):
                 cron=cron,
                 rrule=rrule,
                 paused=paused,
+                schedule=schedule,
                 schedules=schedules,
                 concurrency_limit=concurrency_limit,
                 tags=tags,
@@ -770,6 +773,7 @@ class Flow(Generic[P, R]):
                 cron=cron,
                 rrule=rrule,
                 paused=paused,
+                schedule=schedule,
                 schedules=schedules,
                 concurrency_limit=concurrency_limit,
                 tags=tags,
@@ -800,6 +804,7 @@ class Flow(Generic[P, R]):
         cron: Optional[Union[Iterable[str], str]] = None,
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
+        schedule: Optional[Schedule] = None,
         schedules: Optional["FlexibleScheduleList"] = None,
         concurrency_limit: Optional[Union[int, ConcurrencyLimitConfig, None]] = None,
         parameters: Optional[dict[str, Any]] = None,
@@ -824,6 +829,8 @@ class Flow(Generic[P, R]):
             cron: A cron schedule of when to execute runs of this deployment.
             rrule: An rrule schedule of when to execute runs of this deployment.
             paused: Whether or not to set this deployment as paused.
+            schedule: A schedule object defining when to execute runs of this deployment.
+                Used to provide additional scheduling options like `timezone` or `parameters`.
             schedules: A list of schedule objects defining when to execute runs of this deployment.
                 Used to define multiple schedules or additional scheduling options such as `timezone`.
             concurrency_limit: The maximum number of runs of this deployment that can run at the same time.
@@ -882,6 +889,7 @@ class Flow(Generic[P, R]):
                     cron=cron,
                     rrule=rrule,
                     paused=paused,
+                    schedule=schedule,
                     schedules=schedules,
                     concurrency_limit=concurrency_limit,
                     tags=tags,
@@ -905,6 +913,7 @@ class Flow(Generic[P, R]):
                 cron=cron,
                 rrule=rrule,
                 paused=paused,
+                schedule=schedule,
                 schedules=schedules,
                 concurrency_limit=concurrency_limit,
                 tags=tags,
@@ -954,6 +963,7 @@ class Flow(Generic[P, R]):
         cron: Optional[Union[Iterable[str], str]] = None,
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
+        schedule: Optional[Schedule] = None,
         schedules: Optional["FlexibleScheduleList"] = None,
         global_limit: Optional[Union[int, ConcurrencyLimitConfig, None]] = None,
         triggers: Optional[list[Union[DeploymentTriggerTypes, TriggerTypes]]] = None,
@@ -983,6 +993,8 @@ class Flow(Generic[P, R]):
                 Also accepts an iterable of rrule schedule strings to create multiple schedules.
             triggers: A list of triggers that will kick off runs of this deployment.
             paused: Whether or not to set this deployment as paused.
+            schedule: A schedule object defining when to execute runs of this deployment.
+                Used to provide additional scheduling options like `timezone` or `parameters`.
             schedules: A list of schedule objects defining when to execute runs of this deployment.
                 Used to define multiple schedules or additional scheduling options like `timezone`.
             global_limit: The maximum number of concurrent runs allowed across all served flow instances associated with the same deployment.
@@ -1048,6 +1060,7 @@ class Flow(Generic[P, R]):
             cron=cron,
             rrule=rrule,
             paused=paused,
+            schedule=schedule,
             schedules=schedules,
             concurrency_limit=global_limit,
             parameters=parameters,
@@ -1327,7 +1340,8 @@ class Flow(Generic[P, R]):
         cron: Optional[str] = None,
         rrule: Optional[str] = None,
         paused: Optional[bool] = None,
-        schedules: Optional[list[DeploymentScheduleCreate]] = None,
+        schedule: Optional[Schedule] = None,
+        schedules: Optional[list[Schedule]] = None,
         concurrency_limit: Optional[Union[int, ConcurrencyLimitConfig, None]] = None,
         triggers: Optional[list[Union[DeploymentTriggerTypes, TriggerTypes]]] = None,
         parameters: Optional[dict[str, Any]] = None,
@@ -1374,6 +1388,8 @@ class Flow(Generic[P, R]):
                 Also accepts an iterable of rrule schedule strings to create multiple schedules.
             triggers: A list of triggers that will kick off runs of this deployment.
             paused: Whether or not to set this deployment as paused.
+            schedule: A schedule object defining when to execute runs of this deployment.
+                Used to provide additional scheduling options like `timezone` or `parameters`.
             schedules: A list of schedule objects defining when to execute runs of this deployment.
                 Used to define multiple schedules or additional scheduling options like `timezone`.
             concurrency_limit: The maximum number of runs that can be executed concurrently.
@@ -1458,6 +1474,7 @@ class Flow(Generic[P, R]):
             interval=interval,
             cron=cron,
             rrule=rrule,
+            schedule=schedule,
             schedules=schedules,
             concurrency_limit=concurrency_limit,
             paused=paused,
@@ -1535,16 +1552,14 @@ class Flow(Generic[P, R]):
     @overload
     def __call__(
         self: "Flow[P, Coroutine[Any, Any, T]]", *args: P.args, **kwargs: P.kwargs
-    ) -> Coroutine[Any, Any, T]:
-        ...
+    ) -> Coroutine[Any, Any, T]: ...
 
     @overload
     def __call__(
         self: "Flow[P, T]",
         *args: P.args,
         **kwargs: P.kwargs,
-    ) -> T:
-        ...
+    ) -> T: ...
 
     @overload
     def __call__(
@@ -1552,8 +1567,7 @@ class Flow(Generic[P, R]):
         *args: P.args,
         return_state: Literal[True],
         **kwargs: P.kwargs,
-    ) -> Awaitable[State[T]]:
-        ...
+    ) -> Awaitable[State[T]]: ...
 
     @overload
     def __call__(
@@ -1561,8 +1575,7 @@ class Flow(Generic[P, R]):
         *args: P.args,
         return_state: Literal[True],
         **kwargs: P.kwargs,
-    ) -> State[T]:
-        ...
+    ) -> State[T]: ...
 
     def __call__(
         self,
@@ -1701,8 +1714,7 @@ class Flow(Generic[P, R]):
 
 class FlowDecorator:
     @overload
-    def __call__(self, __fn: Callable[P, R]) -> Flow[P, R]:
-        ...
+    def __call__(self, __fn: Callable[P, R]) -> Flow[P, R]: ...
 
     @overload
     def __call__(
@@ -1728,8 +1740,7 @@ class FlowDecorator:
         on_cancellation: Optional[list[FlowStateHook[..., Any]]] = None,
         on_crashed: Optional[list[FlowStateHook[..., Any]]] = None,
         on_running: Optional[list[FlowStateHook[..., Any]]] = None,
-    ) -> Callable[[Callable[P, R]], Flow[P, R]]:
-        ...
+    ) -> Callable[[Callable[P, R]], Flow[P, R]]: ...
 
     @overload
     def __call__(
@@ -1755,8 +1766,7 @@ class FlowDecorator:
         on_cancellation: Optional[list[FlowStateHook[..., Any]]] = None,
         on_crashed: Optional[list[FlowStateHook[..., Any]]] = None,
         on_running: Optional[list[FlowStateHook[..., Any]]] = None,
-    ) -> Callable[[Callable[P, R]], Flow[P, R]]:
-        ...
+    ) -> Callable[[Callable[P, R]], Flow[P, R]]: ...
 
     def __call__(
         self,
@@ -1950,8 +1960,7 @@ class FlowDecorator:
         def from_source(
             source: Union[str, "RunnerStorage", ReadableDeploymentStorage],
             entrypoint: str,
-        ) -> Union["Flow[..., Any]", Coroutine[Any, Any, "Flow[..., Any]"]]:
-            ...
+        ) -> Union["Flow[..., Any]", Coroutine[Any, Any, "Flow[..., Any]"]]: ...
 
 
 flow: FlowDecorator = FlowDecorator()
@@ -2071,6 +2080,29 @@ def load_flow_from_entrypoint(
     return flow
 
 
+def load_function_and_convert_to_flow(entrypoint: str) -> Flow[P, Any]:
+    """
+    Loads a function from an entrypoint and converts it to a flow if it is not already a flow.
+    """
+
+    if ":" in entrypoint:
+        # split by the last colon once to handle Windows paths with drive letters i.e C:\path\to\file.py:do_stuff
+        path, func_name = entrypoint.rsplit(":", maxsplit=1)
+    else:
+        path, func_name = entrypoint.rsplit(".", maxsplit=1)
+    try:
+        func = import_object(entrypoint)  # pyright: ignore[reportRedeclaration]
+    except AttributeError as exc:
+        raise RuntimeError(
+            f"Function with name {func_name!r} not found in {path!r}."
+        ) from exc
+
+    if isinstance(func, Flow):
+        return func
+    else:
+        return Flow(func, log_prints=True)
+
+
 def serve(
     *args: "RunnerDeployment",
     pause_on_shutdown: bool = True,
@@ -2223,8 +2255,7 @@ def _display_serve_start_message(*args: "RunnerDeployment"):
     from rich.table import Table
 
     help_message_top = (
-        "[green]Your deployments are being served and polling for"
-        " scheduled runs!\n[/]"
+        "[green]Your deployments are being served and polling for scheduled runs!\n[/]"
     )
 
     table = Table(title="Deployments", show_header=False)

prefect/infrastructure/__init__.py

@@ -1,6 +1,7 @@
 """
 2024-06-27: This surfaces an actionable error message for moved or removed objects in Prefect 3.0 upgrade.
 """
+
 from typing import Any, Callable
 
 from prefect._internal.compatibility.migration import getattr_migration

prefect/infrastructure/base.py

@@ -1,6 +1,7 @@
 """
 2024-06-27: This surfaces an actionable error message for moved or removed objects in Prefect 3.0 upgrade.
 """
+
 from typing import Any, Callable
 
 from prefect._internal.compatibility.migration import getattr_migration

prefect/infrastructure/provisioners/__init__.py

@@ -22,20 +22,17 @@ _provisioners = {
 
 class Provisioner(Protocol):
     @property
-    def console(self) -> rich.console.Console:
-        ...
+    def console(self) -> rich.console.Console: ...
 
     @console.setter
-    def console(self, value: rich.console.Console) -> None:
-        ...
+    def console(self, value: rich.console.Console) -> None: ...
 
     async def provision(
         self,
         work_pool_name: str,
         base_job_template: Dict[str, Any],
         client: Optional["PrefectClient"] = None,
-    ) -> Dict[str, Any]:
-        ...
+    ) -> Dict[str, Any]: ...
 
 
 def get_infrastructure_provisioner_for_work_pool_type(

prefect/infrastructure/provisioners/coiled.py

@@ -118,9 +118,9 @@ class CoiledPushProvisioner:
                 block_type_id=credentials_block_type.id
             )
         )
-        assert (
-            credentials_block_schema is not None
-        ), f"Unable to find schema for block type {credentials_block_type.slug}"
+        assert credentials_block_schema is not None, (
+            f"Unable to find schema for block type {credentials_block_type.slug}"
+        )
 
         block_doc = await client.create_block_document(
             block_document=BlockDocumentCreate(

prefect/infrastructure/provisioners/container_instance.py

@@ -10,6 +10,7 @@ Classes:
     ContainerInstancePushProvisioner: A class for provisioning infrastructure using Azure Container Instances.
 
 """
+
 from __future__ import annotations
 
 import json

prefect/infrastructure/provisioners/ecs.py

@@ -341,9 +341,9 @@ class CredentialsBlockResource:
                     block_type_id=credentials_block_type.id
                 )
             )
-            assert (
-                credentials_block_schema is not None
-            ), f"Unable to find schema for block type {credentials_block_type.slug}"
+            assert credentials_block_schema is not None, (
+                f"Unable to find schema for block type {credentials_block_type.slug}"
+            )
 
             block_doc = await client.create_block_document(
                 block_document=BlockDocumentCreate(
@@ -597,9 +597,9 @@ class ClusterResource:
             )
             advance()
 
-        base_job_template["variables"]["properties"]["cluster"][
-            "default"
-        ] = self._cluster_name
+        base_job_template["variables"]["properties"]["cluster"]["default"] = (
+            self._cluster_name
+        )
 
     @property
     def next_steps(self) -> list[str]:

prefect/infrastructure/provisioners/modal.py

@@ -124,9 +124,9 @@ class ModalPushProvisioner:
                 block_type_id=credentials_block_type.id
             )
         )
-        assert (
-            credentials_block_schema is not None
-        ), f"Unable to find schema for block type {credentials_block_type.slug}"
+        assert credentials_block_schema is not None, (
+            f"Unable to find schema for block type {credentials_block_type.slug}"
+        )
 
         block_doc = await client.create_block_document(
             block_document=BlockDocumentCreate(

prefect/input/run_input.py

@@ -664,8 +664,7 @@ def receive_input(  # type: ignore[overload-overlap]
     key_prefix: Optional[str] = None,
     flow_run_id: Optional[UUID] = None,
     with_metadata: bool = False,
-) -> GetInputHandler[R]:
-    ...
+) -> GetInputHandler[R]: ...
 
 
 @overload
@@ -678,8 +677,7 @@ def receive_input(
     key_prefix: Optional[str] = None,
     flow_run_id: Optional[UUID] = None,
     with_metadata: bool = False,
-) -> GetAutomaticInputHandler[T]:
-    ...
+) -> GetAutomaticInputHandler[T]: ...
 
 
 def receive_input(
@@ -697,9 +695,9 @@ def receive_input(
     # the signature is the same as here:
     #   Union[Type[R], Type[T], pydantic.BaseModel],
     # Seems like a possible mypy bug, so we'll ignore the type check here.
-    input_cls: Union[
-        Type[AutomaticRunInput[T]], Type[R]
-    ] = run_input_subclass_from_type(input_type)  # type: ignore[arg-type]
+    input_cls: Union[Type[AutomaticRunInput[T]], Type[R]] = (
+        run_input_subclass_from_type(input_type)
+    )  # type: ignore[arg-type]
 
     if issubclass(input_cls, AutomaticRunInput):
         return input_cls.receive(

prefect/locking/filesystem.py

@@ -9,6 +9,7 @@ import pydantic_core
 from typing_extensions import TypedDict
 
 from prefect.logging.loggers import get_logger
+from prefect.types._datetime import DateTime, PendulumDuration
 
 from .protocol import LockManager
 
@@ -116,7 +117,7 @@ class FileSystemLockManager(LockManager):
                 )
                 return self.acquire_lock(key, holder, acquire_timeout, hold_timeout)
         expiration = (
-            pendulum.now("utc") + pendulum.duration(seconds=hold_timeout)
+            DateTime.now("utc") + PendulumDuration(seconds=hold_timeout)
             if hold_timeout is not None
             else None
         )
@@ -165,7 +166,7 @@ class FileSystemLockManager(LockManager):
                 )
                 return self.acquire_lock(key, holder, acquire_timeout, hold_timeout)
         expiration = (
-            pendulum.now("utc") + pendulum.duration(seconds=hold_timeout)
+            DateTime.now("utc") + PendulumDuration(seconds=hold_timeout)
             if hold_timeout is not None
             else None
         )
@@ -207,7 +208,7 @@ class FileSystemLockManager(LockManager):
         if (expiration := lock_info.get("expiration")) is None:
             return True
 
-        expired = expiration < pendulum.now("utc")
+        expired = expiration < DateTime.now("utc")
         if expired:
             Path(lock_info["path"]).unlink()
             self._locks.pop(key, None)

prefect/main.py

@@ -8,7 +8,7 @@ from prefect.transactions import Transaction
 from prefect.tasks import task, Task
 from prefect.context import tags
 from prefect.utilities.annotations import unmapped, allow_failure
-from prefect.results import ResultRecordMetadata
+from prefect._result_records import ResultRecordMetadata
 from prefect.flow_runs import pause_flow_run, resume_flow_run, suspend_flow_run
 from prefect.client.orchestration import get_client
 from prefect.client.cloud import get_cloud_client