prefect-client 3.8.2.dev5__tar.gz → 3.8.3.dev1__tar.gz

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: prefect-client
-Version: 3.8.2.dev5
+Version: 3.8.3.dev1
 Summary: Workflow orchestration and management.
 Project-URL: Changelog, https://github.com/PrefectHQ/prefect/releases
 Project-URL: Documentation, https://docs.prefect.io

prefect_client-3.8.3.dev1/src/prefect/_build_info.py

@@ -0,0 +1,5 @@
+# Generated by versioningit
+__version__ = "3.8.3.dev1"
+__build_date__ = "2026-08-11 08:24:15.796562+00:00"
+__git_commit__ = "7d377adfd43019a26cc901d7f50491489a86377f"
+__dirty__ = False

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/_internal/concurrency/services.py

@@ -408,10 +408,21 @@ class FutureQueueService(
             # If the request to the increment endpoint fails in a non-standard
             # way, we need to set the future's result so it'll be re-raised in
             # the context of the caller.
-            future.set_exception(exc)
+            if future.set_running_or_notify_cancel():
+                future.set_exception(exc)
             raise exc
         else:
-            future.set_result(response)
+            # Transitioning the future to running before setting its result closes
+            # the window where the caller cancels it while `acquire` is in flight:
+            # after this point `cancel()` fails, and if the caller got there first
+            # the acquired resource is nobody's and must be discarded.
+            if future.set_running_or_notify_cancel():
+                future.set_result(response)
+            else:
+                await self._discard(response)
+
+    async def _discard(self, response: R) -> None:
+        """Dispose of a result whose caller is no longer waiting for it."""
 
     @abc.abstractmethod
     async def acquire(self, *args: Unpack[Ts]) -> R:

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/client/orchestration/_work_pools/client.py

@@ -48,7 +48,7 @@ class WorkPoolClient(BaseClient):
         Args:
             work_pool_name: The name of the work pool to heartbeat against.
             worker_name: The name of the worker sending the heartbeat.
-            return_id: Whether to return the worker ID. Note: will return `None` if the connected server does not support returning worker IDs, even if `return_id` is `True`.
+            get_worker_id: Whether to return the worker ID. Note: will return `None` if the connected server does not support returning worker IDs, even if `get_worker_id` is `True`.
             worker_metadata: Metadata about the worker to send to the server.
         """
         from uuid import UUID
@@ -376,7 +376,7 @@ class WorkPoolAsyncClient(BaseAsyncClient):
         Args:
             work_pool_name: The name of the work pool to heartbeat against.
             worker_name: The name of the worker sending the heartbeat.
-            return_id: Whether to return the worker ID. Note: will return `None` if the connected server does not support returning worker IDs, even if `return_id` is `True`.
+            get_worker_id: Whether to return the worker ID. Note: will return `None` if the connected server does not support returning worker IDs, even if `get_worker_id` is `True`.
             worker_metadata: Metadata about the worker to send to the server.
         """
         from uuid import UUID

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/client/schemas/objects.py

@@ -1477,7 +1477,7 @@ class WorkQueueHealthPolicy(PrefectBaseModel):
         Given empirical information about the state of the work queue, evaluate its health status.
 
         Args:
-            late_runs: the count of late runs for the work queue.
+            late_runs_count: the count of late runs for the work queue.
             last_polled: the last time the work queue was polled, if available.
 
         Returns:

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/concurrency/_asyncio.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import asyncio
+import concurrent.futures
 import logging
 from contextlib import asynccontextmanager
 from typing import TYPE_CHECKING, AsyncGenerator, Literal, Optional
@@ -150,6 +151,9 @@ async def aacquire_concurrency_slots_with_lease(
     )
     try:
         response = await asyncio.wrap_future(future)
+    except asyncio.CancelledError:
+        _release_lease_when_granted(service, future)
+        raise
     except TimeoutError as timeout:
         raise AcquireConcurrencySlotTimeoutError(
             f"Attempt to acquire concurrency slots timed out after {timeout_seconds} second(s)"
@@ -225,6 +229,28 @@ def _discard_cleanup_lease(lease_id: UUID) -> None:
         ctx.cleanup_lease_ids.remove(lease_id)
 
 
+def _release_lease_when_granted(
+    service: ConcurrencySlotAcquisitionWithLeaseService,
+    future: "concurrent.futures.Future[httpx.Response]",
+) -> None:
+    """Release the lease for an acquisition whose caller has been cancelled.
+
+    The acquisition may still be granted after the caller is gone, and the lease
+    id never reaches the `ConcurrencyContext`, so the slots would stay occupied
+    until the lease expires. The cancelled caller cannot do the release itself, so
+    the service that acquired the slots is asked to release them.
+    """
+
+    def _release(completed: "concurrent.futures.Future[httpx.Response]") -> None:
+        if completed.cancelled() or completed.exception() is not None:
+            # Nothing was granted, so there is nothing to release.
+            return
+
+        service.release_orphaned_lease(completed.result())
+
+    future.add_done_callback(_release)
+
+
 def _response_to_minimal_concurrency_limit_response(
     response: httpx.Response,
 ) -> list[MinimalConcurrencyLimitResponse]:

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/concurrency/services.py

@@ -1,10 +1,11 @@
 import asyncio
+import concurrent.futures
 import json
 from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
 from threading import Lock
 from typing import TYPE_CHECKING, Literal, Optional
-from uuid import uuid4
+from uuid import UUID, uuid4
 
 import cachetools
 import httpx
@@ -104,12 +105,25 @@ class ConcurrencySlotAcquisitionWithLeaseService(
         super().__init__(concurrency_limit_names)
         self._client: PrefectClient
         self.concurrency_limit_names: list[str] = sorted(list(concurrency_limit_names))
+        self._pending_releases: set[concurrent.futures.Future[None]] = set()
 
     @asynccontextmanager
     async def _lifespan(self) -> AsyncGenerator[None, None]:
         async with get_client() as client:
             self._client = client
-            yield
+            try:
+                yield
+            finally:
+                # The client closes when this exits, so releases scheduled by
+                # cancelled callers have to finish first or their slots leak.
+                if self._pending_releases:
+                    await asyncio.gather(
+                        *(
+                            asyncio.wrap_future(release)
+                            for release in tuple(self._pending_releases)
+                        ),
+                        return_exceptions=True,
+                    )
 
     async def acquire(
         self,
@@ -185,6 +199,74 @@ class ConcurrencySlotAcquisitionWithLeaseService(
                     if max_retries is not None:
                         max_retries -= 1
 
+    async def _discard(self, response: httpx.Response) -> None:
+        """Release a lease granted to a caller that was cancelled while waiting.
+
+        Without this the slots stay occupied until the lease expires, because the
+        caller never learns the lease id and so cannot record it for cleanup.
+        """
+        lease_id = self._lease_id_from_response(response)
+        if lease_id is None:
+            return
+
+        try:
+            await self._client.release_concurrency_slots_with_lease(lease_id=lease_id)
+        except Exception:
+            logger.warning(
+                f"Failed to release concurrency lease {lease_id} for "
+                f"{self.concurrency_limit_names} after the acquiring caller was cancelled",
+                exc_info=True,
+            )
+
+    def release_orphaned_lease(
+        self, response: httpx.Response
+    ) -> "concurrent.futures.Future[None]":
+        """Release a lease that was delivered to a caller which is already gone.
+
+        The release is scheduled on the service's own loop so it reuses the client
+        that acquired the slots, keeping acquisition and cleanup on the same API, and
+        is tracked so that draining the service waits for it.
+        """
+        with self._lock:
+            loop = self._loop
+            if self._stopped or loop is None or loop.is_closed():
+                logger.warning(
+                    f"Unable to release concurrency lease for {self.concurrency_limit_names} "
+                    "after the acquiring caller was cancelled: the acquisition service is "
+                    "no longer running. The slots remain occupied until the lease expires."
+                )
+                stopped: concurrent.futures.Future[None] = concurrent.futures.Future()
+                stopped.set_result(None)
+                return stopped
+
+            # Registering under the lock `_stop` uses keeps the service from
+            # finishing its lifespan, and closing its client, before this release.
+            release = asyncio.run_coroutine_threadsafe(self._discard(response), loop)
+            self._pending_releases.add(release)
+
+        release.add_done_callback(self._pending_releases.discard)
+        return release
+
+    def _lease_id_from_response(self, response: httpx.Response) -> Optional[UUID]:
+        """Read the lease id out of a successful acquisition response.
+
+        Returns `None` when no slots were acquired, and logs when the response is
+        malformed, since that leaves a possibly active lease we cannot release.
+        """
+        try:
+            data = response.json()
+            if not data.get("limits"):
+                return None
+            return UUID(data["lease_id"])
+        except Exception:
+            logger.warning(
+                f"Unable to read the lease id from the acquisition response for "
+                f"{self.concurrency_limit_names}; if a lease was granted its slots "
+                "remain occupied until it expires.",
+                exc_info=True,
+            )
+            return None
+
 
 def _should_use_cache(
     names: list[str], holder: Optional["ConcurrencyLeaseHolder"]

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/context.py

@@ -994,7 +994,7 @@ def use_profile(
 
     Args:
         profile: The name of the profile to load or an instance of a Profile.
-        override_environment_variable: If set, variables in the profile will take
+        override_environment_variables: If set, variables in the profile will take
             precedence over current environment variables. By default, environment
             variables will override profile settings.
         include_current_context: If set, the new settings will be constructed

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/events/clients.py

@@ -718,7 +718,6 @@ class PrefectEventSubscriber:
         """
         Args:
             api_url: The base URL for a Prefect Cloud workspace
-            api_key: The API of an actor with the manage_events scope
             reconnection_attempts: When the client is disconnected, how many times
                 the client should attempt to reconnect
             reconnect_on_clean_close: Whether to reconnect when the server closes

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/flows.py

@@ -1507,7 +1507,7 @@ class Flow(Generic[P, R]):
                 parameter schema for the created deployment.
             entrypoint_type: Type of entrypoint to use for the deployment. When using a module path
                 entrypoint, ensure that the module will be importable in the execution environment.
-            print_next_steps_message: Whether or not to print a message with next steps
+            print_next_steps: Whether or not to print a message with next steps
                 after deploying the deployments.
             ignore_warnings: Whether or not to ignore warnings about the work pool type.
             _sla: (Experimental) SLA configuration for the deployment. May be removed or modified at any time. Currently only supported on Prefect Cloud.
@@ -1705,7 +1705,7 @@ class Flow(Generic[P, R]):
                 parameter schema for the created deployment.
             entrypoint_type: Type of entrypoint to use for the deployment. When using a module path
                 entrypoint, ensure that the module will be importable in the execution environment.
-            print_next_steps_message: Whether or not to print a message with next steps
+            print_next_steps: Whether or not to print a message with next steps
                 after deploying the deployments.
             ignore_warnings: Whether or not to ignore warnings about the work pool type.
             _sla: (Experimental) SLA configuration for the deployment. May be removed or modified at any time. Currently only supported on Prefect Cloud.
@@ -2562,7 +2562,6 @@ class InfrastructureBoundFlow(Flow[P, R]):
 
         Args:
             flow_run: The existing flow run to retry
-            return_state: If True, return the final state instead of the result
 
         Returns:
             The flow result or final state
@@ -3135,6 +3134,7 @@ async def aserve(
 
         if __name__ == "__main__":
             asyncio.run(main())
+        ```
     """
 
     from prefect.runner import Runner

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/infrastructure/provisioners/container_instance.py

@@ -592,7 +592,7 @@ class ContainerInstancePushProvisioner:
         Logs into the given Azure Container Registry.
 
         Args:
-            registry_name: The name of the registry to log into.
+            login_server: The login server of the registry to log into.
 
         Raises:
             subprocess.CalledProcessError: If the Azure CLI command execution fails.

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/runner/storage.py

@@ -931,7 +931,7 @@ class LocalStorage:
     """
     Sets the working directory in the local filesystem.
     Parameters:
-        Path: Local file path to set the working directory for the flow
+        path: Local file path to set the working directory for the flow
     Examples:
         Sets the working directory for the local path to the flow:
         ```python
@@ -996,7 +996,7 @@ def create_storage_from_source(
     Creates a storage object from a URL.
 
     Args:
-        url: The URL to create a storage object from. Supports git and `fsspec`
+        source: The URL to create a storage object from. Supports git and `fsspec`
             URLs.
         pull_interval: The interval at which to pull contents from remote storage to
             local storage

{prefect_client-3.8.2.dev5 → prefect_client-3.8.3.dev1}/src/prefect/tasks.py

@@ -1829,10 +1829,6 @@ class Task(Generic[P, R]):
 
         This is the async version of serve().
 
-        Args:
-            task_runner: The task runner to use for serving the task. If not provided,
-                the default task runner will be used.
-
         Examples:
             Serve a task using the default task runner in an async context
             ```python
@@ -1853,10 +1849,6 @@ class Task(Generic[P, R]):
         establish a websocket connection with the Prefect server and listen for
         submitted task runs to execute.
 
-        Args:
-            task_runner: The task runner to use for serving the task. If not provided,
-                the default task runner will be used.
-
         Examples:
             Serve a task using the default task runner
             ```python

prefect_client-3.8.2.dev5/src/prefect/_build_info.py

@@ -1,5 +0,0 @@
-# Generated by versioningit
-__version__ = "3.8.2.dev5"
-__build_date__ = "2026-08-06 09:00:07.568922+00:00"
-__git_commit__ = "baa13ab830c96045672f4588f2d9da992c9a0afd"
-__dirty__ = False