prefect-client 3.0.0rc14__py3-none-any.whl → 3.0.0rc16__py3-none-any.whl

prefect/_internal/compatibility/deprecated.py

@@ -16,7 +16,6 @@ import warnings
 from typing import Any, Callable, List, Optional, Type, TypeVar
 
 import pendulum
-import wrapt
 from pydantic import BaseModel
 
 from prefect.utilities.callables import get_call_parameters
@@ -273,55 +272,3 @@ def register_renamed_module(old_name: str, new_name: str, start_date: str):
     DEPRECATED_MODULE_ALIASES.append(
         AliasedModuleDefinition(old_name, new_name, callback)
     )
-
-
-class AsyncCompatProxy(wrapt.ObjectProxy):
-    """
-    A proxy object that allows for awaiting a method that is no longer async.
-
-    See https://wrapt.readthedocs.io/en/master/wrappers.html#object-proxy for more
-    """
-
-    def __init__(self, wrapped, class_name: str, method_name: str):
-        super().__init__(wrapped)
-        self._self_class_name = class_name
-        self._self_method_name = method_name
-        self._self_already_awaited = False
-
-    def __await__(self):
-        if not self._self_already_awaited:
-            warnings.warn(
-                (
-                    f"The {self._self_method_name!r} method on {self._self_class_name!r}"
-                    " is no longer async and awaiting it will raise an error after Dec 2024"
-                    " - please remove the `await` keyword."
-                ),
-                DeprecationWarning,
-                stacklevel=2,
-            )
-            self._self_already_awaited = True
-        yield
-        return self.__wrapped__
-
-    def __repr__(self):
-        return repr(self.__wrapped__)
-
-    def __reduce_ex__(self, protocol):
-        return (
-            type(self),
-            (self.__wrapped__,),
-            {"_self_already_awaited": self._self_already_awaited},
-        )
-
-
-def deprecated_async_method(wrapped):
-    """Decorator that wraps a sync method to allow awaiting it even though it is no longer async."""
-
-    @wrapt.decorator
-    def wrapper(wrapped, instance, args, kwargs):
-        result = wrapped(*args, **kwargs)
-        return AsyncCompatProxy(
-            result, class_name=instance.__class__.__name__, method_name=wrapped.__name__
-        )
-
-    return wrapper(wrapped)

prefect/_internal/schemas/validators.py

@@ -7,7 +7,6 @@ This will be subject to consolidation and refactoring over the next few months.
 """
 
 import json
-import logging
 import re
 import urllib.parse
 import warnings
@@ -21,7 +20,6 @@ import yaml
 from pydantic_extra_types.pendulum_dt import DateTime
 
 from prefect.exceptions import InvalidRepositoryURLError
-from prefect.utilities.annotations import NotSet
 from prefect.utilities.collections import isiterable
 from prefect.utilities.dockerutils import get_prefect_image_name
 from prefect.utilities.filesystem import relative_path_to_current_platform
@@ -219,96 +217,18 @@ def convert_to_strings(value: Union[Any, List[Any]]) -> Union[str, List[str]]:
 ### SCHEDULE SCHEMA VALIDATORS ###
 
 
-def validate_deprecated_schedule_fields(values: dict, logger: logging.Logger) -> dict:
-    """
-    Validate and log deprecation warnings for deprecated schedule fields.
-    """
-    if values.get("schedule") and not values.get("schedules"):
-        logger.warning(
-            "The field 'schedule' in 'Deployment' has been deprecated. It will not be "
-            "available after Sep 2024. Define schedules in the `schedules` list instead."
-        )
-    elif values.get("is_schedule_active") and not values.get("schedules"):
-        logger.warning(
-            "The field 'is_schedule_active' in 'Deployment' has been deprecated. It will "
-            "not be available after Sep 2024. Use the `active` flag within a schedule in "
-            "the `schedules` list instead and the `pause` flag in 'Deployment' to pause "
-            "all schedules."
-        )
-    return values
-
-
-def reconcile_schedules(cls, values: dict) -> dict:
-    """
-    Reconcile the `schedule` and `schedules` fields in a deployment.
-    """
-
-    from prefect.deployments.schedules import (
-        create_deployment_schedule_create,
-        normalize_to_deployment_schedule_create,
-    )
-
-    schedule = values.get("schedule", NotSet)
-    schedules = values.get("schedules", NotSet)
-
-    if schedules is not NotSet:
-        values["schedules"] = normalize_to_deployment_schedule_create(schedules)
-    elif schedule is not NotSet:
-        values["schedule"] = None
-
-        if schedule is None:
-            values["schedules"] = []
-        else:
-            values["schedules"] = [
-                create_deployment_schedule_create(
-                    schedule=schedule, active=values.get("is_schedule_active")
-                )
-            ]
-
-    for schedule in values.get("schedules", []):
-        cls._validate_schedule(schedule.schedule)
-
-    return values
-
-
-# TODO: consolidate with above if possible
 def reconcile_schedules_runner(values: dict) -> dict:
-    """
-    Similar to above, we reconcile the `schedule` and `schedules` fields in a deployment.
-    """
     from prefect.deployments.schedules import (
-        create_deployment_schedule_create,
         normalize_to_deployment_schedule_create,
     )
 
-    schedule = values.get("schedule")
     schedules = values.get("schedules")
-
-    if schedules is None and schedule is not None:
-        values["schedules"] = [create_deployment_schedule_create(schedule)]
-    elif schedules is not None and len(schedules) > 0:
+    if schedules is not None and len(schedules) > 0:
         values["schedules"] = normalize_to_deployment_schedule_create(schedules)
 
     return values
 
 
-def set_deployment_schedules(values: dict) -> dict:
-    from prefect.server.schemas.actions import DeploymentScheduleCreate
-
-    if not values.get("schedules") and values.get("schedule"):
-        kwargs = {
-            key: values[key]
-            for key in ["schedule", "is_schedule_active"]
-            if key in values
-        }
-        if "is_schedule_active" in kwargs:
-            kwargs["active"] = kwargs.pop("is_schedule_active")
-
-        values["schedules"] = [DeploymentScheduleCreate(**kwargs)]
-
-    return values
-
-
 def validate_schedule_max_scheduled_runs(v: Optional[int], limit: int) -> Optional[int]:
     if v is not None and v > limit:
         raise ValueError(f"`max_scheduled_runs` must be less than or equal to {limit}.")
@@ -350,17 +270,9 @@ def remove_old_deployment_fields(values: dict) -> dict:
 
 def reconcile_paused_deployment(values):
     paused = values.get("paused")
-    is_schedule_active = values.get("is_schedule_active")
-
-    if paused is not None:
-        values["paused"] = paused
-        values["is_schedule_active"] = not paused
-    elif is_schedule_active is not None:
-        values["paused"] = not is_schedule_active
-        values["is_schedule_active"] = is_schedule_active
-    else:
+
+    if paused is None:
         values["paused"] = False
-        values["is_schedule_active"] = True
 
     return values
 

prefect/client/orchestration.py

@@ -86,7 +86,6 @@ from prefect.client.schemas.objects import (
     BlockType,
     ConcurrencyLimit,
     Constant,
-    Deployment,
     DeploymentSchedule,
     Flow,
     FlowRunInput,
@@ -1599,7 +1598,6 @@ class PrefectClient:
         flow_id: UUID,
         name: str,
         version: Optional[str] = None,
-        schedule: Optional[SCHEDULE_TYPES] = None,
         schedules: Optional[List[DeploymentScheduleCreate]] = None,
         parameters: Optional[Dict[str, Any]] = None,
         description: Optional[str] = None,
@@ -1611,7 +1609,6 @@ class PrefectClient:
         entrypoint: Optional[str] = None,
         infrastructure_document_id: Optional[UUID] = None,
         parameter_openapi_schema: Optional[Dict[str, Any]] = None,
-        is_schedule_active: Optional[bool] = None,
         paused: Optional[bool] = None,
         pull_steps: Optional[List[dict]] = None,
         enforce_parameter_schema: Optional[bool] = None,
@@ -1624,7 +1621,6 @@ class PrefectClient:
             flow_id: the flow ID to create a deployment for
             name: the name of the deployment
             version: an optional version string for the deployment
-            schedule: an optional schedule to apply to the deployment
             tags: an optional list of tags to apply to the deployment
             storage_document_id: an reference to the storage block document
                 used for the deployed flow
@@ -1658,9 +1654,7 @@ class PrefectClient:
             infrastructure_document_id=infrastructure_document_id,
             job_variables=dict(job_variables or {}),
             parameter_openapi_schema=parameter_openapi_schema,
-            is_schedule_active=is_schedule_active,
             paused=paused,
-            schedule=schedule,
             schedules=schedules or [],
             pull_steps=pull_steps,
             enforce_parameter_schema=enforce_parameter_schema,
@@ -1676,9 +1670,6 @@ class PrefectClient:
             if field not in deployment_create.model_fields_set
         }
 
-        if deployment_create.is_schedule_active is None:
-            exclude.add("is_schedule_active")
-
         if deployment_create.paused is None:
             exclude.add("paused")
 
@@ -1699,12 +1690,6 @@ class PrefectClient:
 
         return UUID(deployment_id)
 
-    async def update_schedule(self, deployment_id: UUID, active: bool = True):
-        path = "set_schedule_active" if active else "set_schedule_inactive"
-        await self._client.post(
-            f"/deployments/{deployment_id}/{path}",
-        )
-
     async def set_deployment_paused_state(self, deployment_id: UUID, paused: bool):
         await self._client.patch(
             f"/deployments/{deployment_id}", json={"paused": paused}
@@ -1712,40 +1697,12 @@ class PrefectClient:
 
     async def update_deployment(
         self,
-        deployment: Deployment,
-        schedule: SCHEDULE_TYPES = None,
-        is_schedule_active: Optional[bool] = None,
+        deployment_id: UUID,
+        deployment: DeploymentUpdate,
     ):
-        deployment_update = DeploymentUpdate(
-            version=deployment.version,
-            schedule=schedule if schedule is not None else deployment.schedule,
-            is_schedule_active=(
-                is_schedule_active
-                if is_schedule_active is not None
-                else deployment.is_schedule_active
-            ),
-            description=deployment.description,
-            work_queue_name=deployment.work_queue_name,
-            tags=deployment.tags,
-            path=deployment.path,
-            entrypoint=deployment.entrypoint,
-            parameters=deployment.parameters,
-            storage_document_id=deployment.storage_document_id,
-            infrastructure_document_id=deployment.infrastructure_document_id,
-            job_variables=deployment.job_variables,
-            enforce_parameter_schema=deployment.enforce_parameter_schema,
-        )
-
-        if getattr(deployment, "work_pool_name", None) is not None:
-            deployment_update.work_pool_name = deployment.work_pool_name
-
-        exclude = set()
-        if deployment.enforce_parameter_schema is None:
-            exclude.add("enforce_parameter_schema")
-
         await self._client.patch(
-            f"/deployments/{deployment.id}",
-            json=deployment_update.model_dump(mode="json", exclude=exclude),
+            f"/deployments/{deployment_id}",
+            json=deployment.model_dump(mode="json", exclude_unset=True),
         )
 
     async def _create_deployment_from_schema(self, schema: DeploymentCreate) -> UUID:

prefect/client/schemas/actions.py

@@ -11,7 +11,6 @@ from prefect._internal.schemas.bases import ActionBaseModel
 from prefect._internal.schemas.validators import (
     convert_to_strings,
     remove_old_deployment_fields,
-    return_none_schedule,
     validate_artifact_key,
     validate_block_document_name,
     validate_block_type_slug,
@@ -153,7 +152,6 @@ class DeploymentCreate(ActionBaseModel):
 
     name: str = Field(..., description="The name of the deployment.")
     flow_id: UUID = Field(..., description="The ID of the flow to deploy.")
-    is_schedule_active: Optional[bool] = Field(None)
     paused: Optional[bool] = Field(None)
     schedules: List[DeploymentScheduleCreate] = Field(
         default_factory=list,
@@ -181,7 +179,6 @@ class DeploymentCreate(ActionBaseModel):
     )
     storage_document_id: Optional[UUID] = Field(None)
     infrastructure_document_id: Optional[UUID] = Field(None)
-    schedule: Optional[SCHEDULE_TYPES] = Field(None)
     description: Optional[str] = Field(None)
     path: Optional[str] = Field(None)
     version: Optional[str] = Field(None)
@@ -219,19 +216,19 @@ class DeploymentUpdate(ActionBaseModel):
     def remove_old_fields(cls, values):
         return remove_old_deployment_fields(values)
 
-    @field_validator("schedule")
-    @classmethod
-    def validate_none_schedule(cls, v):
-        return return_none_schedule(v)
-
     version: Optional[str] = Field(None)
-    schedule: Optional[SCHEDULE_TYPES] = Field(None)
     description: Optional[str] = Field(None)
-    is_schedule_active: bool = Field(None)
     parameters: Optional[Dict[str, Any]] = Field(
         default=None,
         description="Parameters for flow runs scheduled by the deployment.",
     )
+    paused: Optional[bool] = Field(
+        default=None, description="Whether or not the deployment is paused."
+    )
+    schedules: Optional[List[DeploymentScheduleCreate]] = Field(
+        default=None,
+        description="A list of schedules for the deployment.",
+    )
     tags: List[str] = Field(default_factory=list)
     work_queue_name: Optional[str] = Field(None)
     work_pool_name: Optional[str] = Field(

prefect/client/schemas/filters.py

@@ -489,15 +489,6 @@ class DeploymentFilterWorkQueueName(PrefectBaseModel):
     )
 
 
-class DeploymentFilterIsScheduleActive(PrefectBaseModel):
-    """Filter by `Deployment.is_schedule_active`."""
-
-    eq_: Optional[bool] = Field(
-        default=None,
-        description="Only returns where deployment schedule is/is not active",
-    )
-
-
 class DeploymentFilterTags(PrefectBaseModel, OperatorMixin):
     """Filter by `Deployment.tags`."""
 
@@ -523,9 +514,6 @@ class DeploymentFilter(PrefectBaseModel, OperatorMixin):
     name: Optional[DeploymentFilterName] = Field(
         default=None, description="Filter criteria for `Deployment.name`"
     )
-    is_schedule_active: Optional[DeploymentFilterIsScheduleActive] = Field(
-        default=None, description="Filter criteria for `Deployment.is_schedule_active`"
-    )
     tags: Optional[DeploymentFilterTags] = Field(
         default=None, description="Filter criteria for `Deployment.tags`"
     )

prefect/client/schemas/objects.py

@@ -993,12 +993,6 @@ class Deployment(ObjectBaseModel):
     flow_id: UUID = Field(
         default=..., description="The flow id associated with the deployment."
     )
-    schedule: Optional[SCHEDULE_TYPES] = Field(
-        default=None, description="A schedule for the deployment."
-    )
-    is_schedule_active: bool = Field(
-        default=True, description="Whether or not the deployment schedule is active."
-    )
     paused: bool = Field(
         default=False, description="Whether or not the deployment is paused."
     )

prefect/client/schemas/responses.py

@@ -9,7 +9,6 @@ from typing_extensions import Literal
 import prefect.client.schemas.objects as objects
 from prefect._internal.schemas.bases import ObjectBaseModel, PrefectBaseModel
 from prefect._internal.schemas.fields import CreatedBy, UpdatedBy
-from prefect.client.schemas.schedules import SCHEDULE_TYPES
 from prefect.utilities.collections import AutoEnum
 from prefect.utilities.names import generate_slug
 
@@ -314,12 +313,6 @@ class DeploymentResponse(ObjectBaseModel):
     flow_id: UUID = Field(
         default=..., description="The flow id associated with the deployment."
     )
-    schedule: Optional[SCHEDULE_TYPES] = Field(
-        default=None, description="A schedule for the deployment."
-    )
-    is_schedule_active: bool = Field(
-        default=True, description="Whether or not the deployment schedule is active."
-    )
     paused: bool = Field(
         default=False, description="Whether or not the deployment is paused."
     )

prefect/context.py

@@ -91,11 +91,12 @@ def hydrated_context(
             client = client or get_client(sync_client=True)
             if flow_run_context := serialized_context.get("flow_run_context"):
                 flow = flow_run_context["flow"]
+                task_runner = stack.enter_context(flow.task_runner.duplicate())
                 flow_run_context = FlowRunContext(
                     **flow_run_context,
                     client=client,
                     result_factory=run_coro_as_sync(ResultFactory.from_flow(flow)),
-                    task_runner=flow.task_runner.duplicate(),
+                    task_runner=task_runner,
                     detached=True,
                 )
                 stack.enter_context(flow_run_context)

prefect/deployments/base.py

@@ -258,15 +258,6 @@ def _format_deployment_for_saving_to_prefect_file(
     # Only want entrypoint to avoid errors
     deployment.pop("flow_name", None)
 
-    if deployment.get("schedule"):
-        if isinstance(deployment["schedule"], IntervalSchedule):
-            deployment["schedule"] = _interval_schedule_to_dict(deployment["schedule"])
-        else:  # all valid SCHEDULE_TYPES are subclasses of BaseModel
-            deployment["schedule"] = deployment["schedule"].model_dump()
-
-        if "is_schedule_active" in deployment:
-            deployment["schedule"]["active"] = deployment.pop("is_schedule_active")
-
     if deployment.get("schedules"):
         schedules = []
         for deployment_schedule in cast(

prefect/deployments/runner.py

@@ -106,7 +106,6 @@ class RunnerDeployment(BaseModel):
             are used only for organizational purposes. For delegating work to agents,
             see `work_queue_name`.
         schedule: A schedule to run this deployment on, once registered
-        is_schedule_active: Whether or not the schedule is active
         parameters: A dictionary of parameter values to pass to runs created from this
             deployment
         path: The path to the working directory for the workflow, relative to remote
@@ -144,13 +143,9 @@ class RunnerDeployment(BaseModel):
         default=None,
         description="The schedules that should cause this deployment to run.",
     )
-    schedule: Optional[SCHEDULE_TYPES] = None
     paused: Optional[bool] = Field(
         default=None, description="Whether or not the deployment is paused."
     )
-    is_schedule_active: Optional[bool] = Field(
-        default=None, description="DEPRECATED: Whether or not the schedule is active."
-    )
     parameters: Dict[str, Any] = Field(default_factory=dict)
     entrypoint: Optional[str] = Field(
         default=None,
@@ -383,7 +378,7 @@ class RunnerDeployment(BaseModel):
         )
         if num_schedules > 1:
             raise ValueError(
-                "Only one of interval, cron, rrule, schedule, or schedules can be provided."
+                "Only one of interval, cron, rrule, or schedules can be provided."
             )
         elif num_schedules == 0:
             return []
@@ -437,8 +432,6 @@ class RunnerDeployment(BaseModel):
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
         schedules: Optional["FlexibleScheduleList"] = None,
-        schedule: Optional[SCHEDULE_TYPES] = None,
-        is_schedule_active: Optional[bool] = None,
         parameters: Optional[dict] = None,
         triggers: Optional[List[Union[DeploymentTriggerTypes, TriggerTypes]]] = None,
         description: Optional[str] = None,
@@ -463,11 +456,6 @@ class RunnerDeployment(BaseModel):
             paused: Whether or not to set this deployment as paused.
             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`.
-            schedule: A schedule object of when to execute runs of this flow. Used for
-                advanced scheduling options like timezone.
-            is_schedule_active: Whether or not to set the schedule for this deployment as active. If
-                not provided when creating a deployment, the schedule will be set as active. If not
-                provided when updating a deployment, the schedule's activation will not be changed.
             triggers: A list of triggers that should kick of a run of this flow.
             parameters: A dictionary of default parameter values to pass to runs of this flow.
             description: A description for the created deployment. Defaults to the flow's
@@ -488,7 +476,6 @@ class RunnerDeployment(BaseModel):
             interval=interval,
             cron=cron,
             rrule=rrule,
-            schedule=schedule,
             schedules=schedules,
         )
 
@@ -497,9 +484,7 @@ class RunnerDeployment(BaseModel):
         deployment = cls(
             name=Path(name).stem,
             flow_name=flow.name,
-            schedule=schedule,
             schedules=constructed_schedules,
-            is_schedule_active=is_schedule_active,
             paused=paused,
             tags=tags or [],
             triggers=triggers or [],
@@ -573,8 +558,6 @@ class RunnerDeployment(BaseModel):
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
         schedules: Optional["FlexibleScheduleList"] = None,
-        schedule: Optional[SCHEDULE_TYPES] = None,
-        is_schedule_active: Optional[bool] = None,
         parameters: Optional[dict] = None,
         triggers: Optional[List[Union[DeploymentTriggerTypes, TriggerTypes]]] = None,
         description: Optional[str] = None,
@@ -599,11 +582,6 @@ class RunnerDeployment(BaseModel):
             paused: Whether or not to set this deployment as paused.
             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`.
-            schedule: A schedule object of when to execute runs of this flow. Used for
-                advanced scheduling options like timezone.
-            is_schedule_active: Whether or not to set the schedule for this deployment as active. If
-                not provided when creating a deployment, the schedule will be set as active. If not
-                provided when updating a deployment, the schedule's activation will not be changed.
             triggers: A list of triggers that should kick of a run of this flow.
             parameters: A dictionary of default parameter values to pass to runs of this flow.
             description: A description for the created deployment. Defaults to the flow's
@@ -629,17 +607,14 @@ class RunnerDeployment(BaseModel):
             interval=interval,
             cron=cron,
             rrule=rrule,
-            schedule=schedule,
             schedules=schedules,
         )
 
         deployment = cls(
             name=Path(name).stem,
             flow_name=flow.name,
-            schedule=schedule,
             schedules=constructed_schedules,
             paused=paused,
-            is_schedule_active=is_schedule_active,
             tags=tags or [],
             triggers=triggers or [],
             parameters=parameters or {},
@@ -671,8 +646,6 @@ class RunnerDeployment(BaseModel):
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
         schedules: Optional["FlexibleScheduleList"] = None,
-        schedule: Optional[SCHEDULE_TYPES] = None,
-        is_schedule_active: Optional[bool] = None,
         parameters: Optional[dict] = None,
         triggers: Optional[List[Union[DeploymentTriggerTypes, TriggerTypes]]] = None,
         description: Optional[str] = None,
@@ -697,11 +670,6 @@ class RunnerDeployment(BaseModel):
                 or a timedelta object. If a number is given, it will be interpreted as seconds.
             cron: A cron schedule of when to execute runs of this flow.
             rrule: An rrule schedule of when to execute runs of this flow.
-            schedule: A schedule object of when to execute runs of this flow. Used for
-                advanced scheduling options like timezone.
-            is_schedule_active: Whether or not to set the schedule for this deployment as active. If
-                not provided when creating a deployment, the schedule will be set as active. If not
-                provided when updating a deployment, the schedule's activation will not be changed.
             triggers: A list of triggers that should kick of a run of this flow.
             parameters: A dictionary of default parameter values to pass to runs of this flow.
             description: A description for the created deployment. Defaults to the flow's
@@ -724,7 +692,6 @@ class RunnerDeployment(BaseModel):
             interval=interval,
             cron=cron,
             rrule=rrule,
-            schedule=schedule,
             schedules=schedules,
         )
 
@@ -742,10 +709,8 @@ class RunnerDeployment(BaseModel):
         deployment = cls(
             name=Path(name).stem,
             flow_name=flow.name,
-            schedule=schedule,
             schedules=constructed_schedules,
             paused=paused,
-            is_schedule_active=is_schedule_active,
             tags=tags or [],
             triggers=triggers or [],
             parameters=parameters or {},