prefect-client 3.1.14__py3-none-any.whl → 3.2.0__py3-none-any.whl

prefect/client/schemas/actions.py

@@ -1,5 +1,5 @@
 from copy import deepcopy
-from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union
+from typing import TYPE_CHECKING, Any, Callable, Optional, TypeVar, Union
 from uuid import UUID, uuid4
 
 import jsonschema
@@ -22,7 +22,14 @@ from prefect.client.schemas.objects import (
     StateDetails,
     StateType,
 )
-from prefect.client.schemas.schedules import SCHEDULE_TYPES
+from prefect.client.schemas.schedules import (
+    SCHEDULE_TYPES,
+    CronSchedule,
+    IntervalSchedule,
+    NoSchedule,
+    RRuleSchedule,
+)
+from prefect.schedules import Schedule
 from prefect.settings import PREFECT_DEPLOYMENT_SCHEDULE_MAX_SCHEDULED_RUNS
 from prefect.types import (
     MAX_VARIABLE_NAME_LENGTH,
@@ -39,7 +46,7 @@ from prefect.utilities.collections import listrepr
 from prefect.utilities.pydantic import get_class_fields_only
 
 if TYPE_CHECKING:
-    from prefect.results import ResultRecordMetadata
+    from prefect._result_records import ResultRecordMetadata
 
 R = TypeVar("R")
 
@@ -92,6 +99,24 @@ class DeploymentScheduleCreate(ActionBaseModel):
         default=None,
         description="The maximum number of scheduled runs for the schedule.",
     )
+    parameters: dict[str, Any] = Field(
+        default_factory=dict,
+        description="Parameter overrides for the schedule.",
+    )
+    slug: Optional[str] = Field(
+        default=None,
+        description="A unique identifier for the schedule.",
+    )
+
+    @field_validator("active", mode="wrap")
+    @classmethod
+    def validate_active(cls, v: Any, handler: Callable[[Any], Any]) -> bool:
+        try:
+            return handler(v)
+        except Exception:
+            raise ValueError(
+                f"active must be able to be parsed as a boolean, got {v!r} of type {type(v)}"
+            )
 
     @field_validator("max_scheduled_runs")
     @classmethod
@@ -100,6 +125,45 @@ class DeploymentScheduleCreate(ActionBaseModel):
             v, PREFECT_DEPLOYMENT_SCHEDULE_MAX_SCHEDULED_RUNS.value()
         )
 
+    @classmethod
+    def from_schedule(cls, schedule: Schedule) -> "DeploymentScheduleCreate":
+        if schedule.interval is not None:
+            return cls(
+                schedule=IntervalSchedule(
+                    interval=schedule.interval,
+                    timezone=schedule.timezone,
+                    anchor_date=schedule.anchor_date,
+                ),
+                parameters=schedule.parameters,
+                active=schedule.active,
+                slug=schedule.slug,
+            )
+        elif schedule.cron is not None:
+            return cls(
+                schedule=CronSchedule(
+                    cron=schedule.cron,
+                    timezone=schedule.timezone,
+                    day_or=schedule.day_or,
+                ),
+                parameters=schedule.parameters,
+                active=schedule.active,
+                slug=schedule.slug,
+            )
+        elif schedule.rrule is not None:
+            return cls(
+                schedule=RRuleSchedule(
+                    rrule=schedule.rrule,
+                    timezone=schedule.timezone,
+                ),
+                parameters=schedule.parameters,
+                active=schedule.active,
+                slug=schedule.slug,
+            )
+        else:
+            return cls(
+                schedule=NoSchedule(),
+            )
+
 
 class DeploymentScheduleUpdate(ActionBaseModel):
     schedule: Optional[SCHEDULE_TYPES] = Field(
@@ -113,6 +177,14 @@ class DeploymentScheduleUpdate(ActionBaseModel):
         default=None,
         description="The maximum number of scheduled runs for the schedule.",
     )
+    parameters: Optional[dict[str, Any]] = Field(
+        default=None,
+        description="Parameter overrides for the schedule.",
+    )
+    slug: Optional[str] = Field(
+        default=None,
+        description="A unique identifier for the schedule.",
+    )
 
     @field_validator("max_scheduled_runs")
     @classmethod
@@ -254,6 +326,8 @@ class DeploymentUpdate(ActionBaseModel):
             "Whether or not the deployment should enforce the parameter schema."
         ),
     )
+    parameter_openapi_schema: Optional[dict[str, Any]] = Field(default_factory=dict)
+    pull_steps: Optional[list[dict[str, Any]]] = Field(default=None)
 
     def check_valid_configuration(self, base_job_template: dict[str, Any]) -> None:
         """Check that the combination of base_job_template defaults

prefect/client/schemas/objects.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import datetime
 import warnings
 from collections.abc import Callable, Mapping
@@ -15,7 +17,6 @@ from typing import (
 from uuid import UUID, uuid4
 
 import orjson
-import pendulum
 from pydantic import (
     ConfigDict,
     Discriminator,
@@ -48,6 +49,7 @@ from prefect._internal.schemas.validators import (
     validate_not_negative,
     validate_parent_and_ref_diff,
 )
+from prefect._result_records import ResultRecordMetadata
 from prefect.client.schemas.schedules import SCHEDULE_TYPES
 from prefect.settings import PREFECT_CLOUD_API_URL, PREFECT_CLOUD_UI_URL
 from prefect.types import (
@@ -58,25 +60,17 @@ from prefect.types import (
     PositiveInteger,
     StrictVariableValue,
 )
+from prefect.types._datetime import DateTime
 from prefect.utilities.collections import AutoEnum, listrepr, visit_collection
 from prefect.utilities.names import generate_slug
 from prefect.utilities.pydantic import handle_secret_render
 
-if TYPE_CHECKING:
-    from prefect.client.schemas.actions import StateCreate
-    from prefect.results import ResultRecordMetadata
-
-    DateTime = pendulum.DateTime
-else:
-    from prefect.types import DateTime
-
-
 R = TypeVar("R", default=Any)
 
 
-DEFAULT_BLOCK_SCHEMA_VERSION = "non-versioned"
-DEFAULT_AGENT_WORK_POOL_NAME = "default-agent-pool"
-FLOW_RUN_NOTIFICATION_TEMPLATE_KWARGS = [
+DEFAULT_BLOCK_SCHEMA_VERSION: Literal["non-versioned"] = "non-versioned"
+DEFAULT_AGENT_WORK_POOL_NAME: Literal["default-agent-pool"] = "default-agent-pool"
+FLOW_RUN_NOTIFICATION_TEMPLATE_KWARGS: list[str] = [
     "flow_run_notification_policy_id",
     "flow_id",
     "flow_name",
@@ -105,7 +99,7 @@ class StateType(AutoEnum):
     CANCELLING = AutoEnum.auto()
 
 
-TERMINAL_STATES = {
+TERMINAL_STATES: set[StateType] = {
     StateType.COMPLETED,
     StateType.CANCELLED,
     StateType.FAILED,
@@ -223,8 +217,7 @@ class State(ObjectBaseModel, Generic[R]):
         raise_on_failure: Literal[True] = ...,
         fetch: bool = ...,
         retry_result_failure: bool = ...,
-    ) -> R:
-        ...
+    ) -> R: ...
 
     @overload
     def result(
@@ -232,8 +225,7 @@ class State(ObjectBaseModel, Generic[R]):
         raise_on_failure: Literal[False] = False,
         fetch: bool = ...,
         retry_result_failure: bool = ...,
-    ) -> Union[R, Exception]:
-        ...
+    ) -> Union[R, Exception]: ...
 
     @overload
     def result(
@@ -241,8 +233,7 @@ class State(ObjectBaseModel, Generic[R]):
         raise_on_failure: bool = ...,
         fetch: bool = ...,
         retry_result_failure: bool = ...,
-    ) -> Union[R, Exception]:
-        ...
+    ) -> Union[R, Exception]: ...
 
     @deprecated.deprecated_parameter(
         "fetch",
@@ -333,33 +324,6 @@ class State(ObjectBaseModel, Generic[R]):
             retry_result_failure=retry_result_failure,
         )
 
-    def to_state_create(self) -> "StateCreate":
-        """
-        Convert this state to a `StateCreate` type which can be used to set the state of
-        a run in the API.
-
-        This method will drop this state's `data` if it is not a result type. Only
-        results should be sent to the API. Other data is only available locally.
-        """
-        from prefect.client.schemas.actions import StateCreate
-        from prefect.results import (
-            ResultRecord,
-            should_persist_result,
-        )
-
-        if isinstance(self.data, ResultRecord) and should_persist_result():
-            data = self.data.metadata  # pyright: ignore[reportUnknownMemberType] unable to narrow ResultRecord type
-        else:
-            data = None
-
-        return StateCreate(
-            type=self.type,
-            name=self.name,
-            message=self.message,
-            data=data,
-            state_details=self.state_details,
-        )
-
     @model_validator(mode="after")
     def default_name_from_type(self) -> Self:
         """If a name is not provided, use the type"""
@@ -374,7 +338,7 @@ class State(ObjectBaseModel, Generic[R]):
     def default_scheduled_start_time(self) -> Self:
         if self.type == StateType.SCHEDULED:
             if not self.state_details.scheduled_time:
-                self.state_details.scheduled_time = pendulum.DateTime.now("utc")
+                self.state_details.scheduled_time = DateTime.now("utc")
         return self
 
     @model_validator(mode="after")
@@ -1099,6 +1063,14 @@ class DeploymentSchedule(ObjectBaseModel):
         default=None,
         description="The maximum number of scheduled runs for the schedule.",
     )
+    parameters: dict[str, Any] = Field(
+        default_factory=dict,
+        description="Parameter overrides for the schedule.",
+    )
+    slug: Optional[str] = Field(
+        default=None,
+        description="A unique identifier for the schedule.",
+    )
 
 
 class Deployment(ObjectBaseModel):
@@ -1374,7 +1346,7 @@ class WorkQueueHealthPolicy(PrefectBaseModel):
     )
 
     def evaluate_health_status(
-        self, late_runs_count: int, last_polled: Optional[pendulum.DateTime] = None
+        self, late_runs_count: int, last_polled: DateTime | None = None
     ) -> bool:
         """
         Given empirical information about the state of the work queue, evaluate its health status.
@@ -1396,7 +1368,7 @@ class WorkQueueHealthPolicy(PrefectBaseModel):
         if self.maximum_seconds_since_last_polled is not None:
             if (
                 last_polled is None
-                or pendulum.now("UTC").diff(last_polled).in_seconds()
+                or DateTime.now("UTC").diff(last_polled).in_seconds()
                 > self.maximum_seconds_since_last_polled
             ):
                 healthy = False

prefect/client/schemas/schedules.py

@@ -8,7 +8,6 @@ from typing import TYPE_CHECKING, Annotated, Any, ClassVar, Optional, Union
 import dateutil
 import dateutil.rrule
 import dateutil.tz
-import pendulum
 from pydantic import AfterValidator, ConfigDict, Field, field_validator, model_validator
 from typing_extensions import TypeAlias, TypeGuard
 
@@ -19,14 +18,7 @@ from prefect._internal.schemas.validators import (
     validate_cron_string,
     validate_rrule_string,
 )
-
-if TYPE_CHECKING:
-    # type checkers have difficulty accepting that
-    # pydantic_extra_types.pendulum_dt and pendulum.DateTime can be used
-    # together.
-    DateTime = pendulum.DateTime
-else:
-    from prefect.types import DateTime
+from prefect.types._datetime import Date, DateTime
 
 MAX_ITERATIONS = 1000
 # approx. 1 years worth of RDATEs + buffer
@@ -83,7 +75,7 @@ class IntervalSchedule(PrefectBaseModel):
 
     interval: datetime.timedelta = Field(gt=datetime.timedelta(0))
     anchor_date: Annotated[DateTime, AfterValidator(default_anchor_date)] = Field(
-        default_factory=lambda: pendulum.now("UTC"),
+        default_factory=lambda: DateTime.now("UTC"),
         examples=["2020-01-01T00:00:00Z"],
     )
     timezone: Optional[str] = Field(default=None, examples=["America/New_York"])
@@ -99,12 +91,9 @@ class IntervalSchedule(PrefectBaseModel):
             self,
             /,
             interval: datetime.timedelta,
-            anchor_date: Optional[
-                Union[pendulum.DateTime, datetime.datetime, str]
-            ] = None,
+            anchor_date: Optional[Union[DateTime, datetime.datetime, str]] = None,
             timezone: Optional[str] = None,
-        ) -> None:
-            ...
+        ) -> None: ...
 
 
 class CronSchedule(PrefectBaseModel):
@@ -145,7 +134,7 @@ class CronSchedule(PrefectBaseModel):
 
     @field_validator("timezone")
     @classmethod
-    def valid_timezone(cls, v: Optional[str]) -> str:
+    def valid_timezone(cls, v: Optional[str]) -> Optional[str]:
         return default_timezone(v)
 
     @field_validator("cron")
@@ -154,7 +143,7 @@ class CronSchedule(PrefectBaseModel):
         return validate_cron_string(v)
 
 
-DEFAULT_ANCHOR_DATE = pendulum.date(2020, 1, 1)
+DEFAULT_ANCHOR_DATE = Date(2020, 1, 1)
 
 
 def _rrule_dt(
@@ -220,7 +209,7 @@ class RRuleSchedule(PrefectBaseModel):
             return RRuleSchedule(rrule=str(rrule), timezone=timezone)
         rrules = _rrule(rrule)
         dtstarts = [dts for rr in rrules if (dts := _rrule_dt(rr)) is not None]
-        unique_dstarts = set(pendulum.instance(d).in_tz("UTC") for d in dtstarts)
+        unique_dstarts = set(DateTime.instance(d).in_tz("UTC") for d in dtstarts)
         unique_timezones = set(d.tzinfo for d in dtstarts if d.tzinfo is not None)
 
         if len(unique_timezones) > 1:
@@ -276,7 +265,7 @@ class RRuleSchedule(PrefectBaseModel):
                 kwargs.update(
                     until=until.replace(tzinfo=timezone),
                 )
-            return rrule.replace(**kwargs)
+            return rrule.replace(**kwargs)  # pyright: ignore[reportUnknownVariableType, reportUnknownMemberType] missing type hints
 
         # update rrules
         localized_rrules: list[dateutil.rrule.rrule] = []
@@ -286,7 +275,7 @@ class RRuleSchedule(PrefectBaseModel):
             kwargs: dict[str, Any] = dict(dtstart=dtstart.replace(tzinfo=timezone))
             if until := _rrule_dt(rr, "_until"):
                 kwargs.update(until=until.replace(tzinfo=timezone))
-            localized_rrules.append(rr.replace(**kwargs))
+            localized_rrules.append(rr.replace(**kwargs))  # pyright: ignore[reportUnknownArgumentType, reportUnknownMemberType] missing type hints
         setattr(rrule, "_rrule", localized_rrules)
 
         # update exrules
@@ -297,7 +286,7 @@ class RRuleSchedule(PrefectBaseModel):
             kwargs = dict(dtstart=dtstart.replace(tzinfo=timezone))
             if until := _rrule_dt(exr, "_until"):
                 kwargs.update(until=until.replace(tzinfo=timezone))
-            localized_exrules.append(exr.replace(**kwargs))
+            localized_exrules.append(exr.replace(**kwargs))  # pyright: ignore[reportUnknownArgumentType, reportUnknownMemberType] missing type hints
         setattr(rrule, "_exrule", localized_exrules)
 
         # update rdates
@@ -381,7 +370,7 @@ def construct_schedule(
         if isinstance(interval, (int, float)):
             interval = datetime.timedelta(seconds=interval)
         if not anchor_date:
-            anchor_date = pendulum.DateTime.now()
+            anchor_date = DateTime.now()
         schedule = IntervalSchedule(
             interval=interval, anchor_date=anchor_date, timezone=timezone
         )

prefect/client/types/flexible_schedule_list.py

@@ -5,7 +5,8 @@ from typing_extensions import TypeAlias
 if TYPE_CHECKING:
     from prefect.client.schemas.actions import DeploymentScheduleCreate
     from prefect.client.schemas.schedules import SCHEDULE_TYPES
+    from prefect.schedules import Schedule
 
 FlexibleScheduleList: TypeAlias = Sequence[
-    Union["DeploymentScheduleCreate", dict[str, Any], "SCHEDULE_TYPES"]
+    Union["DeploymentScheduleCreate", dict[str, Any], "SCHEDULE_TYPES", "Schedule"]
 ]

prefect/context.py

@@ -73,8 +73,8 @@ def hydrated_context(
     # We need to rebuild the models because we might be hydrating in a remote
     # environment where the models are not available.
     # TODO: Remove this once we have fixed our circular imports and we don't need to rebuild models any more.
+    from prefect._result_records import ResultRecordMetadata
     from prefect.flows import Flow
-    from prefect.results import ResultRecordMetadata
     from prefect.tasks import Task
 
     _types: dict[str, Any] = dict(
@@ -123,8 +123,7 @@ class ContextModel(BaseModel):
 
     if TYPE_CHECKING:
         # subclasses can pass through keyword arguments to the pydantic base model
-        def __init__(self, **kwargs: Any) -> None:
-            ...
+        def __init__(self, **kwargs: Any) -> None: ...
 
     # The context variable for storing data must be defined by the child class
     __var__: ClassVar[ContextVar[Self]]

prefect/deployments/base.py

@@ -10,12 +10,11 @@ from __future__ import annotations
 import os
 from copy import deepcopy
 from pathlib import Path
-from typing import Any, Dict, List, Optional, cast
+from typing import Any, Dict, List, Optional
 
 import yaml
 from ruamel.yaml import YAML
 
-from prefect.client.schemas.actions import DeploymentScheduleCreate
 from prefect.client.schemas.objects import ConcurrencyLimitStrategy
 from prefect.client.schemas.schedules import IntervalSchedule
 from prefect.utilities._git import get_git_branch, get_git_remote_origin_url
@@ -207,8 +206,8 @@ def initialize_project(
 
 
 def _format_deployment_for_saving_to_prefect_file(
-    deployment: Dict,
-) -> Dict:
+    deployment: dict[str, Any],
+) -> dict[str, Any]:
     """
     Formats a deployment into a templated deploy config for saving to prefect.yaml.
 
@@ -227,10 +226,8 @@ def _format_deployment_for_saving_to_prefect_file(
     deployment.pop("flow_name", None)
 
     if deployment.get("schedules"):
-        schedules = []
-        for deployment_schedule in cast(
-            List[DeploymentScheduleCreate], deployment["schedules"]
-        ):
+        schedules: list[dict[str, Any]] = []
+        for deployment_schedule in deployment["schedules"]:
             if isinstance(deployment_schedule.schedule, IntervalSchedule):
                 schedule_config = _interval_schedule_to_dict(
                     deployment_schedule.schedule
@@ -257,7 +254,7 @@ def _format_deployment_for_saving_to_prefect_file(
     return deployment
 
 
-def _interval_schedule_to_dict(schedule: IntervalSchedule) -> Dict:
+def _interval_schedule_to_dict(schedule: IntervalSchedule) -> dict[str, Any]:
     """
     Converts an IntervalSchedule to a dictionary.
 
@@ -265,7 +262,7 @@ def _interval_schedule_to_dict(schedule: IntervalSchedule) -> Dict:
         - schedule (IntervalSchedule): the schedule to convert
 
     Returns:
-        - Dict: the schedule as a dictionary
+        - dict[str, Any]: the schedule as a dictionary
     """
     schedule_config = schedule.model_dump()
     schedule_config["interval"] = schedule_config["interval"].total_seconds()
@@ -275,12 +272,12 @@ def _interval_schedule_to_dict(schedule: IntervalSchedule) -> Dict:
 
 
 def _save_deployment_to_prefect_file(
-    deployment: Dict,
-    build_steps: Optional[List[Dict]] = None,
-    push_steps: Optional[List[Dict]] = None,
-    pull_steps: Optional[List[Dict]] = None,
-    triggers: Optional[List[Dict]] = None,
-    sla: Optional[list[dict]] = None,
+    deployment: dict[str, Any],
+    build_steps: list[dict[str, Any]] | None = None,
+    push_steps: list[dict[str, Any]] | None = None,
+    pull_steps: list[dict[str, Any]] | None = None,
+    triggers: list[dict[str, Any]] | None = None,
+    sla: list[dict[str, Any]] | None = None,
     prefect_file: Path = Path("prefect.yaml"),
 ):
     """

prefect/deployments/flow_runs.py

@@ -6,11 +6,11 @@ import anyio
 import pendulum
 
 import prefect
+from prefect._result_records import ResultRecordMetadata
 from prefect.client.schemas import FlowRun
 from prefect.client.utilities import inject_client
 from prefect.context import FlowRunContext, TaskRunContext
 from prefect.logging import get_logger
-from prefect.results import ResultRecordMetadata
 from prefect.states import Pending, Scheduled
 from prefect.tasks import Task
 from prefect.telemetry.run_telemetry import (