prefect-client 3.1.11__tar.gz → 3.1.13__tar.gz

{prefect-client-3.1.11/src/prefect_client.egg-info → prefect-client-3.1.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prefect-client
-Version: 3.1.11
+Version: 3.1.13
 Summary: Workflow orchestration and management.
 Home-page: https://www.prefect.io
 Author: Prefect Technologies, Inc.

{prefect-client-3.1.11 → prefect-client-3.1.13}/requirements-client.txt

@@ -3,7 +3,7 @@ asgi-lifespan >= 1.0, < 3.0
 cachetools >= 5.3, < 6.0
 cloudpickle >= 2.0, < 4.0
 coolname >= 1.0.4, < 3.0.0
-croniter >= 1.0.12, < 6.0.0
+croniter >= 1.0.12, < 7.0.0
 exceptiongroup >= 1.0.0
 fastapi >= 0.111.0, < 1.0.0
 fsspec >= 2022.5.0
@@ -20,7 +20,7 @@ packaging >= 21.3, < 24.3
 pathspec >= 0.8.0
 pendulum >= 3.0.0, <4
 prometheus-client >= 0.20.0
-pydantic >= 2.7, < 3.0.0, != 2.10.0
+pydantic >= 2.9, < 3.0.0, != 2.10.0
 pydantic_core >= 2.12.0, < 3.0.0
 pydantic_extra_types >= 2.8.2, < 3.0.0
 pydantic_settings > 2.2.1

prefect-client-3.1.13/src/prefect/_experimental/sla/client.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from prefect.client.orchestration.base import BaseAsyncClient, BaseClient
+
+if TYPE_CHECKING:
+    from uuid import UUID
+
+    from prefect._experimental.sla.objects import SlaMergeResponse, SlaTypes
+
+
+class SlaClient(BaseClient):
+    def apply_slas_for_deployment(
+        self, deployment_id: "UUID", slas: "list[SlaTypes]"
+    ) -> "SlaMergeResponse":
+        """
+        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:
+            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 SLAs were not updated for any reason
+        Returns:
+            SlaMergeResponse: The response from the backend, containing the names of the created, updated, and deleted SLAs
+        """
+        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",
+            f"/slas/apply-resource-slas/{resource_id}",
+            json=slas_spec_list,
+        )
+        response.raise_for_status()
+
+        response_json = response.json()
+
+        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 apply_slas_for_deployment(
+        self, deployment_id: "UUID", slas: "list[SlaTypes]"
+    ) -> "UUID":
+        """
+        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:
+            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 SLAs were not updated for any reason
+        Returns:
+            SlaMergeResponse: The response from the backend, containing the names of the created, updated, and deleted SLAs
+        """
+        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",
+            f"/slas/apply-resource-slas/{resource_id}",
+            json=slas_spec_list,
+        )
+        response.raise_for_status()
+
+        response_json = response.json()
+
+        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-client-3.1.13/src/prefect/_experimental/sla/objects.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+import abc
+from typing import Literal, Optional, Union
+from uuid import UUID
+
+from pydantic import Field, PrivateAttr, computed_field
+from typing_extensions import Self, TypeAlias
+
+from prefect._internal.schemas.bases import PrefectBaseModel
+
+
+class ServiceLevelAgreement(PrefectBaseModel, abc.ABC):
+    """An ORM representation of a Service Level Agreement."""
+
+    _deployment_id: Optional[UUID] = PrivateAttr(default=None)
+
+    name: str = Field(
+        default=...,
+        description="The name of the SLA. Names must be unique on a per-deployment basis.",
+    )
+    severity: Literal["minor", "low", "moderate", "high", "critical"] = Field(
+        default="moderate",
+        description="The severity of the SLA.",
+    )
+    enabled: Optional[bool] = Field(
+        default=True,
+        description="Whether the SLA is enabled.",
+    )
+
+    def set_deployment_id(self, deployment_id: UUID) -> Self:
+        self._deployment_id = deployment_id
+        return self
+
+    @computed_field
+    @property
+    def owner_resource(self) -> Union[str, None]:
+        if self._deployment_id:
+            return f"prefect.deployment.{self._deployment_id}"
+        return None
+
+
+class TimeToCompletionSla(ServiceLevelAgreement):
+    """An SLA that triggers when a flow run takes longer than the specified duration."""
+
+    duration: int = Field(
+        default=...,
+        description="The maximum flow run duration allowed before the SLA is violated, expressed in seconds.",
+    )
+
+
+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-client-3.1.11 → prefect-client-3.1.13}/src/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-client-3.1.11 → prefect-client-3.1.13}/src/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-client-3.1.11 → prefect-client-3.1.13}/src/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-client-3.1.11 → prefect-client-3.1.13}/src/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-client-3.1.11 → prefect-client-3.1.13}/src/prefect/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-01-02T13:11:17-0600",
+ "date": "2025-01-17T08:46:53-0800",
  "dirty": true,
  "error": null,
- "full-revisionid": "e448bd3462d7c2580427624f426d81cf6e9a7ff1",
- "version": "3.1.11"
+ "full-revisionid": "16e85ce3c281778f5ab6487a73377eed63bcac8b",
+ "version": "3.1.13"
 }
 '''  # END VERSION_JSON
 

{prefect-client-3.1.11 → prefect-client-3.1.13}/src/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