prefect-client 3.1.11__py3-none-any.whl → 3.1.13__py3-none-any.whl

prefect/deployments/flow_runs.py

@@ -29,7 +29,11 @@ prefect.client.schemas.StateCreate.model_rebuild(
     }
 )
 
-logger = get_logger(__name__)
+
+if TYPE_CHECKING:
+    import logging
+
+logger: "logging.Logger" = get_logger(__name__)
 
 
 @sync_compatible

prefect/deployments/runner.py

@@ -48,12 +48,14 @@ from rich.console import Console
 from rich.progress import Progress, SpinnerColumn, TextColumn, track
 from rich.table import Table
 
+from prefect._experimental.sla.objects import SlaTypes
 from prefect._internal.concurrency.api import create_call, from_async
 from prefect._internal.schemas.validators import (
     reconcile_paused_deployment,
     reconcile_schedules_runner,
 )
-from prefect.client.orchestration import get_client
+from prefect.client.base import ServerType
+from prefect.client.orchestration import PrefectClient, get_client
 from prefect.client.schemas.actions import DeploymentScheduleCreate
 from prefect.client.schemas.filters import WorkerFilter, WorkerFilterStatus
 from prefect.client.schemas.objects import (
@@ -128,6 +130,7 @@ class RunnerDeployment(BaseModel):
         job_variables: Settings used to override the values specified default base job template
             of the chosen work pool. Refer to the base job template of the chosen work pool for
             available settings.
+        _sla: (Experimental) SLA configuration for the deployment. May be removed or modified at any time. Currently only supported on Prefect Cloud.
     """
 
     model_config: ClassVar[ConfigDict] = ConfigDict(arbitrary_types_allowed=True)
@@ -207,6 +210,10 @@ class RunnerDeployment(BaseModel):
             " a built runner."
         ),
     )
+    # (Experimental) SLA configuration for the deployment. May be removed or modified at any time. Currently only supported on Prefect Cloud.
+    _sla: Optional[Union[SlaTypes, list[SlaTypes]]] = PrivateAttr(
+        default=None,
+    )
     _entrypoint_type: EntrypointType = PrivateAttr(
         default=EntrypointType.FILE_PATH,
     )
@@ -351,8 +358,28 @@ class RunnerDeployment(BaseModel):
                 trigger.set_deployment_id(deployment_id)
                 await client.create_automation(trigger.as_automation())
 
+            # We plan to support SLA configuration on the Prefect Server in the future.
+            # For now, we only support it on Prefect Cloud.
+
+            # If we're provided with an empty list, we will call the apply endpoint
+            # to remove existing SLAs for the deployment. If the argument is not provided,
+            # we will not call the endpoint.
+            if self._sla or self._sla == []:
+                await self._create_slas(deployment_id, client)
+
             return deployment_id
 
+    async def _create_slas(self, deployment_id: UUID, client: PrefectClient):
+        if not isinstance(self._sla, list):
+            self._sla = [self._sla]
+
+        if client.server_type == ServerType.CLOUD:
+            await client.apply_slas_for_deployment(deployment_id, self._sla)
+        else:
+            raise ValueError(
+                "SLA configuration is currently only supported on Prefect Cloud."
+            )
+
     @staticmethod
     def _construct_deployment_schedules(
         interval: Optional[
@@ -467,6 +494,7 @@ class RunnerDeployment(BaseModel):
         work_queue_name: Optional[str] = None,
         job_variables: Optional[dict[str, Any]] = None,
         entrypoint_type: EntrypointType = EntrypointType.FILE_PATH,
+        _sla: Optional[Union[SlaTypes, list[SlaTypes]]] = None,  # experimental
     ) -> "RunnerDeployment":
         """
         Configure a deployment for a given flow.
@@ -497,6 +525,7 @@ class RunnerDeployment(BaseModel):
             job_variables: Settings used to override the values specified default base job template
                 of the chosen work pool. Refer to the base job template of the chosen work pool for
                 available settings.
+            _sla: (Experimental) SLA configuration for the deployment. May be removed or modified at any time. Currently only supported on Prefect Cloud.
         """
         constructed_schedules = cls._construct_deployment_schedules(
             interval=interval,
@@ -532,6 +561,7 @@ class RunnerDeployment(BaseModel):
             work_queue_name=work_queue_name,
             job_variables=job_variables,
         )
+        deployment._sla = _sla
 
         if not deployment.entrypoint:
             no_file_location_error = (
@@ -607,6 +637,7 @@ class RunnerDeployment(BaseModel):
         work_pool_name: Optional[str] = None,
         work_queue_name: Optional[str] = None,
         job_variables: Optional[dict[str, Any]] = None,
+        _sla: Optional[Union[SlaTypes, list[SlaTypes]]] = None,  # experimental
     ) -> "RunnerDeployment":
         """
         Configure a deployment for a given flow located at a given entrypoint.
@@ -638,6 +669,7 @@ class RunnerDeployment(BaseModel):
             job_variables: Settings used to override the values specified default base job template
                 of the chosen work pool. Refer to the base job template of the chosen work pool for
                 available settings.
+            _sla: (Experimental) SLA configuration for the deployment. May be removed or modified at any time. Currently only supported on Prefect Cloud.
         """
         from prefect.flows import load_flow_from_entrypoint
 
@@ -677,6 +709,7 @@ class RunnerDeployment(BaseModel):
             work_queue_name=work_queue_name,
             job_variables=job_variables,
         )
+        deployment._sla = _sla
         deployment._path = str(Path.cwd())
 
         cls._set_defaults_from_flow(deployment, flow)
@@ -708,6 +741,7 @@ class RunnerDeployment(BaseModel):
         work_pool_name: Optional[str] = None,
         work_queue_name: Optional[str] = None,
         job_variables: Optional[dict[str, Any]] = None,
+        _sla: Optional[Union[SlaTypes, list[SlaTypes]]] = None,  # experimental
     ):
         """
         Create a RunnerDeployment from a flow located at a given entrypoint and stored in a
@@ -739,6 +773,7 @@ class RunnerDeployment(BaseModel):
             job_variables: Settings used to override the values specified default base job template
                 of the chosen work pool. Refer to the base job template of the chosen work pool for
                 available settings.
+            _sla: (Experimental) SLA configuration for the deployment. May be removed or modified at any time. Currently only supported on Prefect Cloud.
         """
         from prefect.flows import load_flow_from_entrypoint
 
@@ -787,6 +822,7 @@ class RunnerDeployment(BaseModel):
             work_queue_name=work_queue_name,
             job_variables=job_variables,
         )
+        deployment._sla = _sla
         deployment._path = str(storage.destination).replace(
             tmpdir, "$STORAGE_BASE_PATH"
         )

prefect/deployments/steps/core.py

@@ -141,7 +141,7 @@ async def run_steps(
     steps: List[Dict[str, Any]],
     upstream_outputs: Optional[Dict[str, Any]] = None,
     print_function: Any = print,
-):
+) -> dict[str, Any]:
     upstream_outputs = deepcopy(upstream_outputs) if upstream_outputs else {}
     for step in steps:
         if not step:

prefect/deployments/steps/pull.py

@@ -12,7 +12,10 @@ from prefect.logging.loggers import get_logger
 from prefect.runner.storage import BlockStorageAdapter, GitRepository, RemoteStorage
 from prefect.utilities.asyncutils import run_coro_as_sync
 
-deployment_logger = get_logger("deployment")
+if TYPE_CHECKING:
+    import logging
+
+deployment_logger: "logging.Logger" = get_logger("deployment")
 
 if TYPE_CHECKING:
     from prefect.blocks.core import Block
@@ -197,7 +200,7 @@ def git_clone(
     return dict(directory=str(storage.destination.relative_to(Path.cwd())))
 
 
-async def pull_from_remote_storage(url: str, **settings: Any):
+async def pull_from_remote_storage(url: str, **settings: Any) -> dict[str, Any]:
     """
     Pulls code from a remote storage location into the current working directory.
 
@@ -239,7 +242,9 @@ async def pull_from_remote_storage(url: str, **settings: Any):
     return {"directory": directory}
 
 
-async def pull_with_block(block_document_name: str, block_type_slug: str):
+async def pull_with_block(
+    block_document_name: str, block_type_slug: str
+) -> dict[str, Any]:
     """
     Pulls code using a block.
 

prefect/deployments/steps/utility.py

@@ -26,7 +26,7 @@ import shlex
 import string
 import subprocess
 import sys
-from typing import Dict, Optional
+from typing import Any, Dict, Optional
 
 from anyio import create_task_group
 from anyio.streams.text import TextReceiveStream
@@ -205,7 +205,7 @@ async def pip_install_requirements(
     directory: Optional[str] = None,
     requirements_file: str = "requirements.txt",
     stream_output: bool = True,
-):
+) -> dict[str, Any]:
     """
     Installs dependencies from a requirements.txt file.
 

prefect/docker/docker_image.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Optional
+from typing import Any, Optional
 
 from pendulum import now as pendulum_now
 
@@ -34,7 +34,11 @@ class DockerImage:
     """
 
     def __init__(
-        self, name: str, tag: Optional[str] = None, dockerfile="auto", **build_kwargs
+        self,
+        name: str,
+        tag: Optional[str] = None,
+        dockerfile: str = "auto",
+        **build_kwargs: Any,
     ):
         image_name, image_tag = parse_image_tag(name)
         if tag and image_tag:
@@ -49,16 +53,16 @@ class DockerImage:
             namespace = PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACE.value()
         # join the namespace and repository to create the full image name
         # ignore namespace if it is None
-        self.name = "/".join(filter(None, [namespace, repository]))
-        self.tag = tag or image_tag or slugify(pendulum_now("utc").isoformat())
-        self.dockerfile = dockerfile
-        self.build_kwargs = build_kwargs
+        self.name: str = "/".join(filter(None, [namespace, repository]))
+        self.tag: str = tag or image_tag or slugify(pendulum_now("utc").isoformat())
+        self.dockerfile: str = dockerfile
+        self.build_kwargs: dict[str, Any] = build_kwargs
 
     @property
-    def reference(self):
+    def reference(self) -> str:
         return f"{self.name}:{self.tag}"
 
-    def build(self):
+    def build(self) -> None:
         full_image_name = self.reference
         build_kwargs = self.build_kwargs.copy()
         build_kwargs["context"] = Path.cwd()
@@ -72,7 +76,7 @@ class DockerImage:
             build_kwargs["dockerfile"] = self.dockerfile
             build_image(**build_kwargs)
 
-    def push(self):
+    def push(self) -> None:
         with docker_client() as client:
             events = client.api.push(
                 repository=self.name, tag=self.tag, stream=True, decode=True

prefect/engine.py

@@ -1,6 +1,6 @@
 import os
 import sys
-from typing import Any, Callable
+from typing import TYPE_CHECKING, Any, Callable
 from uuid import UUID
 
 from prefect._internal.compatibility.migration import getattr_migration
@@ -15,12 +15,19 @@ from prefect.utilities.asyncutils import (
     run_coro_as_sync,
 )
 
-engine_logger = get_logger("engine")
+if TYPE_CHECKING:
+    import logging
+
+    from prefect.flow_engine import FlowRun
+    from prefect.flows import Flow
+    from prefect.logging.loggers import LoggingAdapter
+
+engine_logger: "logging.Logger" = get_logger("engine")
 
 
 if __name__ == "__main__":
     try:
-        flow_run_id = UUID(
+        flow_run_id: UUID = UUID(
             sys.argv[1] if len(sys.argv) > 1 else os.environ.get("PREFECT__FLOW_RUN_ID")
         )
     except Exception:
@@ -31,26 +38,41 @@ if __name__ == "__main__":
 
     try:
         from prefect.flow_engine import (
-            load_flow_and_flow_run,
+            flow_run_logger,
+            load_flow,
+            load_flow_run,
             run_flow,
         )
 
-        flow_run, flow = load_flow_and_flow_run(flow_run_id=flow_run_id)
+        flow_run: "FlowRun" = load_flow_run(flow_run_id=flow_run_id)
+        run_logger: "LoggingAdapter" = flow_run_logger(flow_run=flow_run)
+
+        try:
+            flow: "Flow[..., Any]" = load_flow(flow_run)
+        except Exception:
+            run_logger.error(
+                "Unexpected exception encountered when trying to load flow",
+                exc_info=True,
+            )
+            raise
+
         # run the flow
         if flow.isasync:
-            run_coro_as_sync(run_flow(flow, flow_run=flow_run))
+            run_coro_as_sync(run_flow(flow, flow_run=flow_run, error_logger=run_logger))
         else:
-            run_flow(flow, flow_run=flow_run)
+            run_flow(flow, flow_run=flow_run, error_logger=run_logger)
 
-    except Abort as exc:
+    except Abort as abort_signal:
+        abort_signal: Abort
         engine_logger.info(
             f"Engine execution of flow run '{flow_run_id}' aborted by orchestrator:"
-            f" {exc}"
+            f" {abort_signal}"
         )
         exit(0)
-    except Pause as exc:
+    except Pause as pause_signal:
+        pause_signal: Pause
         engine_logger.info(
-            f"Engine execution of flow run '{flow_run_id}' is paused: {exc}"
+            f"Engine execution of flow run '{flow_run_id}' is paused: {pause_signal}"
         )
         exit(0)
     except Exception:

prefect/events/cli/automations.py

@@ -3,7 +3,7 @@ Command line interface for working with automations.
 """
 
 import functools
-from typing import Optional, Type
+from typing import Any, Callable, Optional, Type
 from uuid import UUID
 
 import orjson
@@ -21,16 +21,16 @@ from prefect.client.orchestration import get_client
 from prefect.events.schemas.automations import Automation
 from prefect.exceptions import PrefectHTTPStatusError
 
-automations_app = PrefectTyper(
+automations_app: PrefectTyper = PrefectTyper(
     name="automation",
     help="Manage automations.",
 )
 app.add_typer(automations_app, aliases=["automations"])
 
 
-def requires_automations(func):
+def requires_automations(func: Callable[..., Any]) -> Callable[..., Any]:
     @functools.wraps(func)
-    async def wrapper(*args, **kwargs):
+    async def wrapper(*args: Any, **kwargs: Any) -> Any:
         try:
             return await func(*args, **kwargs)
         except RuntimeError as exc:

prefect/events/clients.py

@@ -70,18 +70,21 @@ EVENT_WEBSOCKET_CHECKPOINTS = Counter(
     labelnames=["client"],
 )
 
-logger = get_logger(__name__)
+if TYPE_CHECKING:
+    import logging
+
+logger: "logging.Logger" = get_logger(__name__)
 
 
-def http_to_ws(url: str):
+def http_to_ws(url: str) -> str:
     return url.replace("https://", "wss://").replace("http://", "ws://").rstrip("/")
 
 
-def events_in_socket_from_api_url(url: str):
+def events_in_socket_from_api_url(url: str) -> str:
     return http_to_ws(url) + "/events/in"
 
 
-def events_out_socket_from_api_url(url: str):
+def events_out_socket_from_api_url(url: str) -> str:
     return http_to_ws(url) + "/events/out"
 
 
@@ -250,11 +253,11 @@ class AssertingEventsClient(EventsClient):
     last: ClassVar["Optional[AssertingEventsClient]"] = None
     all: ClassVar[List["AssertingEventsClient"]] = []
 
-    args: Tuple
-    kwargs: Dict[str, Any]
-    events: List[Event]
+    args: tuple[Any, ...]
+    kwargs: dict[str, Any]
+    events: list[Event]
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args: Any, **kwargs: Any):
         AssertingEventsClient.last = self
         AssertingEventsClient.all.append(self)
         self.args = args
@@ -431,13 +434,13 @@ class AssertingPassthroughEventsClient(PrefectEventsClient):
     during tests AND sends them to a Prefect server."""
 
     last: ClassVar["Optional[AssertingPassthroughEventsClient]"] = None
-    all: ClassVar[List["AssertingPassthroughEventsClient"]] = []
+    all: ClassVar[list["AssertingPassthroughEventsClient"]] = []
 
-    args: Tuple
-    kwargs: Dict[str, Any]
-    events: List[Event]
+    args: tuple[Any, ...]
+    kwargs: dict[str, Any]
+    events: list[Event]
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args: Any, **kwargs: Any):
         super().__init__(*args, **kwargs)
         AssertingPassthroughEventsClient.last = self
         AssertingPassthroughEventsClient.all.append(self)
@@ -449,7 +452,7 @@ class AssertingPassthroughEventsClient(PrefectEventsClient):
         cls.last = None
         cls.all = []
 
-    def pop_events(self) -> List[Event]:
+    def pop_events(self) -> list[Event]:
         events = self.events
         self.events = []
         return events

prefect/events/schemas/automations.py

@@ -52,7 +52,7 @@ class Trigger(PrefectBaseModel, abc.ABC, extra="ignore"):  # type: ignore[call-a
 
     _deployment_id: Optional[UUID] = PrivateAttr(default=None)
 
-    def set_deployment_id(self, deployment_id: UUID):
+    def set_deployment_id(self, deployment_id: UUID) -> None:
         self._deployment_id = deployment_id
 
     def owner_resource(self) -> Optional[str]:
@@ -277,7 +277,7 @@ class MetricTriggerQuery(PrefectBaseModel):
     )
 
     @field_validator("range", "firing_for")
-    def enforce_minimum_range(cls, value: timedelta):
+    def enforce_minimum_range(cls, value: timedelta) -> timedelta:
         if value < timedelta(seconds=300):
             raise ValueError("The minimum range is 300 seconds (5 minutes)")
         return value
@@ -404,13 +404,17 @@ class AutomationCore(PrefectBaseModel, extra="ignore"):  # type: ignore[call-arg
     """Defines an action a user wants to take when a certain number of events
     do or don't happen to the matching resources"""
 
-    name: str = Field(..., description="The name of this automation")
-    description: str = Field("", description="A longer description of this automation")
+    name: str = Field(default=..., description="The name of this automation")
+    description: str = Field(
+        default="", description="A longer description of this automation"
+    )
 
-    enabled: bool = Field(True, description="Whether this automation will be evaluated")
+    enabled: bool = Field(
+        default=True, description="Whether this automation will be evaluated"
+    )
 
     trigger: TriggerTypes = Field(
-        ...,
+        default=...,
         description=(
             "The criteria for which events this Automation covers and how it will "
             "respond to the presence or absence of those events"
@@ -418,7 +422,7 @@ class AutomationCore(PrefectBaseModel, extra="ignore"):  # type: ignore[call-arg
     )
 
     actions: List[ActionTypes] = Field(
-        ...,
+        default=...,
         description="The actions to perform when this Automation triggers",
     )
 
@@ -438,4 +442,4 @@ class AutomationCore(PrefectBaseModel, extra="ignore"):  # type: ignore[call-arg
 
 
 class Automation(AutomationCore):
-    id: UUID = Field(..., description="The ID of this automation")
+    id: UUID = Field(default=..., description="The ID of this automation")

prefect/events/schemas/events.py

@@ -1,6 +1,7 @@
 import copy
 from collections import defaultdict
 from typing import (
+    TYPE_CHECKING,
     Any,
     ClassVar,
     Dict,
@@ -32,7 +33,10 @@ from prefect.types import DateTime
 
 from .labelling import Labelled
 
-logger = get_logger(__name__)
+if TYPE_CHECKING:
+    import logging
+
+logger: "logging.Logger" = get_logger(__name__)
 
 
 class Resource(Labelled):

prefect/events/worker.py

@@ -82,7 +82,7 @@ class EventsWorker(QueueService[Event]):
 
         await self._client.emit(event)
 
-    async def attach_related_resources_from_context(self, event: Event):
+    async def attach_related_resources_from_context(self, event: Event) -> None:
         if "prefect.resource.lineage-group" in event.resource:
             # We attach related resources to lineage events in `emit_lineage_event`,
             # instead of the worker, because not all run-related resources are

prefect/filesystems.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import abc
 import urllib.parse
 from pathlib import Path
@@ -92,7 +94,9 @@ class LocalFileSystem(WritableFileSystem, WritableDeploymentStorage):
     )
 
     @field_validator("basepath", mode="before")
-    def cast_pathlib(cls, value):
+    def cast_pathlib(cls, value: str | Path | None) -> str | None:
+        if value is None:
+            return value
         return stringify_path(value)
 
     def _resolve_path(self, path: str, validate: bool = False) -> Path:
@@ -132,7 +136,7 @@ class LocalFileSystem(WritableFileSystem, WritableDeploymentStorage):
         Defaults to copying the entire contents of the block's basepath to the current working directory.
         """
         if not from_path:
-            from_path = Path(self.basepath).expanduser().resolve()
+            from_path = Path(self.basepath or ".").expanduser().resolve()
         else:
             from_path = self._resolve_path(from_path)
 
@@ -277,7 +281,7 @@ class RemoteFileSystem(WritableFileSystem, WritableDeploymentStorage):
     _filesystem: fsspec.AbstractFileSystem = None
 
     @field_validator("basepath")
-    def check_basepath(cls, value):
+    def check_basepath(cls, value: str) -> str:
         return validate_basepath(value)
 
     def _resolve_path(self, path: str) -> str: