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

prefect/_experimental/sla/client.py

@@ -7,60 +7,86 @@ from prefect.client.orchestration.base import BaseAsyncClient, BaseClient
 if TYPE_CHECKING:
     from uuid import UUID
 
-    from prefect._experimental.sla.objects import SlaTypes
+    from prefect._experimental.sla.objects import SlaMergeResponse, SlaTypes
 
 
 class SlaClient(BaseClient):
-    def create_sla(self, sla: "SlaTypes") -> "UUID":
+    def apply_slas_for_deployment(
+        self, deployment_id: "UUID", slas: "list[SlaTypes]"
+    ) -> "SlaMergeResponse":
         """
-        Creates a service level agreement.
+        Applies service level agreements for a deployment. Performs matching by SLA name. If a SLA with the same name already exists, it will be updated. If a SLA with the same name does not exist, it will be created. Existing SLAs that are not in the list will be deleted.
         Args:
-            sla: The SLA to create. Must have a deployment ID set.
+            deployment_id: The ID of the deployment to update SLAs for
+            slas: List of SLAs to associate with the deployment
         Raises:
-            httpx.RequestError: if the SLA was not created for any reason
+            httpx.RequestError: if the SLAs were not updated for any reason
         Returns:
-            the ID of the SLA in the backend
+            SlaMergeResponse: The response from the backend, containing the names of the created, updated, and deleted SLAs
         """
-        if not sla.owner_resource:
-            raise ValueError(
-                "Deployment ID is not set. Please set using `set_deployment_id`."
-            )
+        resource_id = f"prefect.deployment.{deployment_id}"
+
+        for sla in slas:
+            sla.set_deployment_id(deployment_id)
+
+        slas_spec_list = [
+            sla.model_dump(mode="json", exclude_unset=True) for sla in slas
+        ]
 
         response = self.request(
             "POST",
-            "/slas/",
-            json=sla.model_dump(mode="json", exclude_unset=True),
+            f"/slas/apply-resource-slas/{resource_id}",
+            json=slas_spec_list,
         )
         response.raise_for_status()
 
-        from uuid import UUID
+        response_json = response.json()
 
-        return UUID(response.json().get("id"))
+        from prefect._experimental.sla.objects import SlaMergeResponse
+
+        return SlaMergeResponse(
+            created=[sla.get("name") for sla in response_json.get("created")],
+            updated=[sla.get("name") for sla in response_json.get("updated")],
+            deleted=[sla.get("name") for sla in response_json.get("deleted")],
+        )
 
 
 class SlaAsyncClient(BaseAsyncClient):
-    async def create_sla(self, sla: "SlaTypes") -> "UUID":
+    async def apply_slas_for_deployment(
+        self, deployment_id: "UUID", slas: "list[SlaTypes]"
+    ) -> "UUID":
         """
-        Creates a service level agreement.
+        Applies service level agreements for a deployment. Performs matching by SLA name. If a SLA with the same name already exists, it will be updated. If a SLA with the same name does not exist, it will be created. Existing SLAs that are not in the list will be deleted.
         Args:
-            sla: The SLA to create. Must have a deployment ID set.
+            deployment_id: The ID of the deployment to update SLAs for
+            slas: List of SLAs to associate with the deployment
         Raises:
-            httpx.RequestError: if the SLA was not created for any reason
+            httpx.RequestError: if the SLAs were not updated for any reason
         Returns:
-            the ID of the SLA in the backend
+            SlaMergeResponse: The response from the backend, containing the names of the created, updated, and deleted SLAs
         """
-        if not sla.owner_resource:
-            raise ValueError(
-                "Deployment ID is not set. Please set using `set_deployment_id`."
-            )
+        resource_id = f"prefect.deployment.{deployment_id}"
+
+        for sla in slas:
+            sla.set_deployment_id(deployment_id)
+
+        slas_spec_list = [
+            sla.model_dump(mode="json", exclude_unset=True) for sla in slas
+        ]
 
         response = await self.request(
             "POST",
-            "/slas/",
-            json=sla.model_dump(mode="json", exclude_unset=True),
+            f"/slas/apply-resource-slas/{resource_id}",
+            json=slas_spec_list,
         )
         response.raise_for_status()
 
-        from uuid import UUID
+        response_json = response.json()
 
-        return UUID(response.json().get("id"))
+        from prefect._experimental.sla.objects import SlaMergeResponse
+
+        return SlaMergeResponse(
+            created=[sla.get("name") for sla in response_json.get("created")],
+            updated=[sla.get("name") for sla in response_json.get("updated")],
+            deleted=[sla.get("name") for sla in response_json.get("deleted")],
+        )

prefect/_experimental/sla/objects.py

@@ -5,7 +5,7 @@ from typing import Literal, Optional, Union
 from uuid import UUID
 
 from pydantic import Field, PrivateAttr, computed_field
-from typing_extensions import TypeAlias
+from typing_extensions import Self, TypeAlias
 
 from prefect._internal.schemas.bases import PrefectBaseModel
 
@@ -28,7 +28,7 @@ class ServiceLevelAgreement(PrefectBaseModel, abc.ABC):
         description="Whether the SLA is enabled.",
     )
 
-    def set_deployment_id(self, deployment_id: UUID):
+    def set_deployment_id(self, deployment_id: UUID) -> Self:
         self._deployment_id = deployment_id
         return self
 
@@ -49,5 +49,13 @@ class TimeToCompletionSla(ServiceLevelAgreement):
     )
 
 
+class SlaMergeResponse(PrefectBaseModel):
+    """A response object for the apply_slas_for_deployment method. Contains the names of the created, updated, and deleted SLAs."""
+
+    created: list[str]
+    updated: list[str]
+    deleted: list[str]
+
+
 # Concrete SLA types
 SlaTypes: TypeAlias = Union[TimeToCompletionSla]

prefect/_internal/concurrency/services.py

@@ -32,7 +32,7 @@ class _QueueServiceBase(abc.ABC, Generic[T]):
         self._task: Optional[asyncio.Task[None]] = None
         self._stopped: bool = False
         self._started: bool = False
-        self._key = hash(args)
+        self._key = hash((self.__class__, *args))
         self._lock = threading.Lock()
         self._queue_get_thread = WorkerThread(
             # TODO: This thread should not need to be a daemon but when it is not, it
@@ -256,7 +256,7 @@ class _QueueServiceBase(abc.ABC, Generic[T]):
         If an instance already exists with the given arguments, it will be returned.
         """
         with cls._instance_lock:
-            key = hash(args)
+            key = hash((cls, *args))
             if key not in cls._instances:
                 cls._instances[key] = cls._new_instance(*args)
 

prefect/_internal/concurrency/threads.py

@@ -2,6 +2,8 @@
 Utilities for managing worker threads.
 """
 
+from __future__ import annotations
+
 import asyncio
 import atexit
 import concurrent.futures
@@ -197,6 +199,10 @@ class EventLoopThread(Portal):
     def running(self) -> bool:
         return not self._shutdown_event.is_set()
 
+    @property
+    def loop(self) -> asyncio.AbstractEventLoop | None:
+        return self._loop
+
     def _entrypoint(self):
         """
         Entrypoint for the thread.

prefect/_internal/retries.py

@@ -29,7 +29,7 @@ def retry_async_fn(
     retry_on_exceptions: tuple[type[Exception], ...] = (Exception,),
     operation_name: Optional[str] = None,
 ) -> Callable[
-    [Callable[P, Coroutine[Any, Any, R]]], Callable[P, Coroutine[Any, Any, Optional[R]]]
+    [Callable[P, Coroutine[Any, Any, R]]], Callable[P, Coroutine[Any, Any, R]]
 ]:
     """A decorator for retrying an async function.
 
@@ -48,9 +48,9 @@ def retry_async_fn(
 
     def decorator(
         func: Callable[P, Coroutine[Any, Any, R]],
-    ) -> Callable[P, Coroutine[Any, Any, Optional[R]]]:
+    ) -> Callable[P, Coroutine[Any, Any, R]]:
         @wraps(func)
-        async def wrapper(*args: P.args, **kwargs: P.kwargs) -> Optional[R]:
+        async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
             name = operation_name or func.__name__
             for attempt in range(max_attempts):
                 try:
@@ -67,6 +67,9 @@ def retry_async_fn(
                         f"Retrying in {delay:.2f} seconds..."
                     )
                     await asyncio.sleep(delay)
+            # Technically unreachable, but this raise helps pyright know that this function
+            # won't return None.
+            raise Exception(f"Function {name!r} failed after {max_attempts} attempts")
 
         return wrapper
 

prefect/_internal/schemas/validators.py

@@ -6,6 +6,8 @@ format.
 This will be subject to consolidation and refactoring over the next few months.
 """
 
+from __future__ import annotations
+
 import os
 import re
 import urllib.parse
@@ -627,18 +629,18 @@ def validate_name_present_on_nonanonymous_blocks(values: M) -> M:
 
 
 @overload
-def validate_command(v: str) -> Path:
+def validate_working_dir(v: str) -> Path:
     ...
 
 
 @overload
-def validate_command(v: None) -> None:
+def validate_working_dir(v: None) -> None:
     ...
 
 
-def validate_command(v: Optional[str]) -> Optional[Path]:
+def validate_working_dir(v: Optional[Path | str]) -> Optional[Path]:
     """Make sure that the working directory is formatted for the current platform."""
-    if v is not None:
+    if isinstance(v, str):
         return relative_path_to_current_platform(v)
     return v
 

prefect/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-01-09T10:09:15-0800",
+ "date": "2025-01-17T08:46:53-0800",
  "dirty": true,
  "error": null,
- "full-revisionid": "e299e5a781867735d62685e7c190b5d100a28b62",
- "version": "3.1.12"
+ "full-revisionid": "16e85ce3c281778f5ab6487a73377eed63bcac8b",
+ "version": "3.1.13"
 }
 '''  # END VERSION_JSON
 

prefect/artifacts.py

@@ -20,7 +20,10 @@ from prefect.logging.loggers import get_logger
 from prefect.utilities.asyncutils import sync_compatible
 from prefect.utilities.context import get_task_and_flow_run_ids
 
-logger = get_logger("artifacts")
+if TYPE_CHECKING:
+    import logging
+
+logger: "logging.Logger" = get_logger("artifacts")
 
 if TYPE_CHECKING:
     from prefect.client.orchestration import PrefectClient

prefect/automations.py

@@ -137,7 +137,7 @@ class Automation(AutomationCore):
             self.id = client.create_automation(automation=automation)
             return self
 
-    async def aupdate(self: Self):
+    async def aupdate(self: Self) -> None:
         """
         Updates an existing automation.
 

prefect/blocks/abstract.py

@@ -15,7 +15,7 @@ from typing import (
     Union,
 )
 
-from typing_extensions import Self, TypeAlias
+from typing_extensions import TYPE_CHECKING, Self, TypeAlias
 
 from prefect.blocks.core import Block
 from prefect.exceptions import MissingContextError
@@ -26,7 +26,10 @@ T = TypeVar("T")
 if sys.version_info >= (3, 12):
     LoggingAdapter = logging.LoggerAdapter[logging.Logger]
 else:
-    LoggingAdapter = logging.LoggerAdapter
+    if TYPE_CHECKING:
+        LoggingAdapter = logging.LoggerAdapter[logging.Logger]
+    else:
+        LoggingAdapter = logging.LoggerAdapter
 
 LoggerOrAdapter: TypeAlias = Union[Logger, LoggingAdapter]
 

prefect/blocks/notifications.py

@@ -880,6 +880,7 @@ class SendgridEmail(AbstractAppriseNotificationBlock):
         sendgrid_block = SendgridEmail.load("BLOCK_NAME")
 
         sendgrid_block.notify("Hello from Prefect!")
+        ```
     """
 
     _description = "Enables sending notifications via Sendgrid email service."

prefect/cache_policies.py

@@ -2,7 +2,7 @@ import inspect
 from copy import deepcopy
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Literal, Optional, Union
+from typing import TYPE_CHECKING, Any, Callable, Dict, Literal, Optional, Union
 
 from typing_extensions import Self
 
@@ -73,8 +73,8 @@ class CachePolicy:
     def compute_key(
         self,
         task_ctx: TaskRunContext,
-        inputs: Dict[str, Any],
-        flow_parameters: Dict[str, Any],
+        inputs: dict[str, Any],
+        flow_parameters: dict[str, Any],
         **kwargs: Any,
     ) -> Optional[str]:
         raise NotImplementedError
@@ -132,14 +132,14 @@ class CacheKeyFnPolicy(CachePolicy):
 
     # making it optional for tests
     cache_key_fn: Optional[
-        Callable[["TaskRunContext", Dict[str, Any]], Optional[str]]
+        Callable[["TaskRunContext", dict[str, Any]], Optional[str]]
     ] = None
 
     def compute_key(
         self,
         task_ctx: TaskRunContext,
-        inputs: Dict[str, Any],
-        flow_parameters: Dict[str, Any],
+        inputs: dict[str, Any],
+        flow_parameters: dict[str, Any],
         **kwargs: Any,
     ) -> Optional[str]:
         if self.cache_key_fn:
@@ -155,13 +155,13 @@ class CompoundCachePolicy(CachePolicy):
     Any keys that return `None` will be ignored.
     """
 
-    policies: List[CachePolicy] = field(default_factory=list)
+    policies: list[CachePolicy] = field(default_factory=list)
 
     def compute_key(
         self,
         task_ctx: TaskRunContext,
-        inputs: Dict[str, Any],
-        flow_parameters: Dict[str, Any],
+        inputs: dict[str, Any],
+        flow_parameters: dict[str, Any],
         **kwargs: Any,
     ) -> Optional[str]:
         keys: list[str] = []
@@ -189,8 +189,8 @@ class _None(CachePolicy):
     def compute_key(
         self,
         task_ctx: TaskRunContext,
-        inputs: Dict[str, Any],
-        flow_parameters: Dict[str, Any],
+        inputs: dict[str, Any],
+        flow_parameters: dict[str, Any],
         **kwargs: Any,
     ) -> Optional[str]:
         return None
@@ -209,8 +209,8 @@ class TaskSource(CachePolicy):
     def compute_key(
         self,
         task_ctx: TaskRunContext,
-        inputs: Optional[Dict[str, Any]],
-        flow_parameters: Optional[Dict[str, Any]],
+        inputs: Optional[dict[str, Any]],
+        flow_parameters: Optional[dict[str, Any]],
         **kwargs: Any,
     ) -> Optional[str]:
         if not task_ctx:
@@ -236,8 +236,8 @@ class FlowParameters(CachePolicy):
     def compute_key(
         self,
         task_ctx: TaskRunContext,
-        inputs: Dict[str, Any],
-        flow_parameters: Dict[str, Any],
+        inputs: dict[str, Any],
+        flow_parameters: dict[str, Any],
         **kwargs: Any,
     ) -> Optional[str]:
         if not flow_parameters:
@@ -255,8 +255,8 @@ class RunId(CachePolicy):
     def compute_key(
         self,
         task_ctx: TaskRunContext,
-        inputs: Dict[str, Any],
-        flow_parameters: Dict[str, Any],
+        inputs: dict[str, Any],
+        flow_parameters: dict[str, Any],
         **kwargs: Any,
     ) -> Optional[str]:
         if not task_ctx:
@@ -273,13 +273,13 @@ class Inputs(CachePolicy):
     Policy that computes a cache key based on a hash of the runtime inputs provided to the task..
     """
 
-    exclude: List[str] = field(default_factory=list)
+    exclude: list[str] = field(default_factory=list)
 
     def compute_key(
         self,
         task_ctx: TaskRunContext,
-        inputs: Dict[str, Any],
-        flow_parameters: Dict[str, Any],
+        inputs: dict[str, Any],
+        flow_parameters: dict[str, Any],
         **kwargs: Any,
     ) -> Optional[str]:
         hashed_inputs = {}

prefect/client/utilities.py

@@ -5,7 +5,7 @@ Utilities for working with clients.
 # This module must not import from `prefect.client` when it is imported to avoid
 # circular imports for decorators such as `inject_client` which are widely used.
 
-from collections.abc import Awaitable, Coroutine
+from collections.abc import Coroutine
 from functools import wraps
 from typing import TYPE_CHECKING, Any, Callable, Optional, Union
 
@@ -61,8 +61,8 @@ def get_or_create_client(
 
 
 def client_injector(
-    func: Callable[Concatenate["PrefectClient", P], Awaitable[R]],
-) -> Callable[P, Awaitable[R]]:
+    func: Callable[Concatenate["PrefectClient", P], Coroutine[Any, Any, R]],
+) -> Callable[P, Coroutine[Any, Any, R]]:
     @wraps(func)
     async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
         client, _ = get_or_create_client()

prefect/deployments/base.py

@@ -19,6 +19,7 @@ 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
+from prefect.utilities.annotations import NotSet
 from prefect.utilities.filesystem import create_default_ignore_file
 from prefect.utilities.templating import apply_values
 
@@ -113,7 +114,9 @@ def create_default_prefect_yaml(
     return True
 
 
-def configure_project_by_recipe(recipe: str, **formatting_kwargs) -> dict:
+def configure_project_by_recipe(
+    recipe: str, **formatting_kwargs: Any
+) -> dict[str, Any] | type[NotSet]:
     """
     Given a recipe name, returns a dictionary representing base configuration options.
 
@@ -131,13 +134,13 @@ def configure_project_by_recipe(recipe: str, **formatting_kwargs) -> dict:
         raise ValueError(f"Unknown recipe {recipe!r} provided.")
 
     with recipe_path.open(mode="r") as f:
-        config = yaml.safe_load(f)
+        config: dict[str, Any] = yaml.safe_load(f)
 
-    config = apply_values(
+    templated_config = apply_values(
         template=config, values=formatting_kwargs, remove_notset=False
     )
 
-    return config
+    return templated_config
 
 
 def initialize_project(

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

@@ -36,7 +36,6 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Any, ClassVar, Iterable, List, Optional, Union
 from uuid import UUID
 
-from exceptiongroup import ExceptionGroup  # novermin
 from pydantic import (
     BaseModel,
     ConfigDict,
@@ -361,7 +360,11 @@ class RunnerDeployment(BaseModel):
 
             # We plan to support SLA configuration on the Prefect Server in the future.
             # For now, we only support it on Prefect Cloud.
-            if self._sla:
+
+            # 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
@@ -371,15 +374,7 @@ class RunnerDeployment(BaseModel):
             self._sla = [self._sla]
 
         if client.server_type == ServerType.CLOUD:
-            exceptions = []
-            for sla in self._sla:
-                try:
-                    sla.set_deployment_id(deployment_id)
-                    await client.create_sla(sla)
-                except Exception as e:
-                    exceptions.append(e)
-            if exceptions:
-                raise ExceptionGroup("Failed to create SLAs", exceptions)  # novermin
+            await client.apply_slas_for_deployment(deployment_id, self._sla)
         else:
             raise ValueError(
                 "SLA configuration is currently only supported on Prefect Cloud."

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