prefect-client 3.2.12__py3-none-any.whl → 3.2.13__py3-none-any.whl

prefect/_build_info.py

@@ -1,5 +1,5 @@
 # Generated by versioningit
-__version__ = "3.2.12"
-__build_date__ = "2025-03-10 16:35:36.997425+00:00"
-__git_commit__ = "826eb1a7423831a2eeb6541909ef35ecca17fde7"
+__version__ = "3.2.13"
+__build_date__ = "2025-03-14 20:36:04.139050+00:00"
+__git_commit__ = "1280029757bdefaca553d85a008f9b82da0c697a"
 __dirty__ = False

prefect/flows.py

@@ -1046,10 +1046,9 @@ class Flow(Generic[P, R]):
         if not name:
             name = self.name
         else:
-            # Handling for my_flow.serve(__file__)
-            # Will set name to name of file where my_flow.serve() without the extension
-            # Non filepath strings will pass through unchanged
-            name = Path(name).stem
+            # Only strip extension if it is a file path
+            if (p := Path(name)).is_file():
+                name = p.stem
 
         runner = Runner(name=name, pause_on_shutdown=pause_on_shutdown, limit=limit)
         deployment_id = runner.add_flow(

prefect/logging/loggers.py

@@ -146,10 +146,11 @@ def get_run_logger(
             **kwargs,
         )
     elif (
-        get_logger("prefect.flow_run").disabled
-        and get_logger("prefect.task_run").disabled
+        get_logger("prefect.flow_runs").disabled
+        and get_logger("prefect.task_runs").disabled
     ):
         logger = logging.getLogger("null")
+        logger.disabled = True
     else:
         raise MissingContextError("There is no active flow or task run context.")
 
@@ -280,9 +281,9 @@ def disable_run_logger():
     """
     Gets both `prefect.flow_run` and `prefect.task_run` and disables them
     within the context manager. Upon exiting the context manager, both loggers
-    are returned to its original state.
+    are returned to their original state.
     """
-    with disable_logger("prefect.flow_run"), disable_logger("prefect.task_run"):
+    with disable_logger("prefect.flow_runs"), disable_logger("prefect.task_runs"):
         yield
 
 

prefect/server/api/server.py

@@ -294,12 +294,16 @@ async def prefect_object_not_found_exception_handler(
     )
 
 
+API_APP_CACHE: dict[tuple[str, str | None], FastAPI] = {}
+
+
 def create_api_app(
     dependencies: list[Any] | None = None,
     health_check_path: str = "/health",
     version_check_path: str = "/version",
     fast_api_app_kwargs: dict[str, Any] | None = None,
     final: bool = False,
+    ignore_cache: bool = False,
 ) -> FastAPI:
     """
     Create a FastAPI app that includes the Prefect REST API
@@ -310,10 +314,20 @@ def create_api_app(
         fast_api_app_kwargs: kwargs to pass to the FastAPI constructor
         final: whether this will be the last instance of the Prefect server to be
             created in this process, so that additional optimizations may be applied
+        ignore_cache: if set, a new app will be created even if the settings and fast_api_app_kwargs match
+            an existing app in the cache
 
     Returns:
         a FastAPI app that serves the Prefect REST API
     """
+    cache_key = (
+        prefect.settings.get_current_settings().hash_key(),
+        hash_objects(fast_api_app_kwargs) if fast_api_app_kwargs else None,
+    )
+
+    if cache_key in API_APP_CACHE and not ignore_cache:
+        return API_APP_CACHE[cache_key]
+
     fast_api_app_kwargs = fast_api_app_kwargs or {}
     api_app = FastAPI(title=API_TITLE, **fast_api_app_kwargs)
     api_app.add_middleware(GZipMiddleware)
@@ -389,6 +403,8 @@ def create_api_app(
                 )
             return await call_next(request)
 
+    API_APP_CACHE[cache_key] = api_app
+
     return api_app
 
 
@@ -655,6 +671,7 @@ def create_app(
             }
         },
         final=final,
+        ignore_cache=ignore_cache,
     )
     ui_app = create_ui_app(ephemeral)
 

prefect/task_engine.py

@@ -24,6 +24,7 @@ from typing import (
     Type,
     TypeVar,
     Union,
+    overload,
 )
 from uuid import UUID
 
@@ -1527,6 +1528,32 @@ async def run_generator_task_async(
         await engine.result()
 
 
+@overload
+def run_task(
+    task: "Task[P, R]",
+    task_run_id: Optional[UUID] = None,
+    task_run: Optional[TaskRun] = None,
+    parameters: Optional[dict[str, Any]] = None,
+    wait_for: Optional["OneOrManyFutureOrResult[Any]"] = None,
+    return_type: Literal["state"] = "state",
+    dependencies: Optional[dict[str, set[TaskRunInput]]] = None,
+    context: Optional[dict[str, Any]] = None,
+) -> State[R]: ...
+
+
+@overload
+def run_task(
+    task: "Task[P, R]",
+    task_run_id: Optional[UUID] = None,
+    task_run: Optional[TaskRun] = None,
+    parameters: Optional[dict[str, Any]] = None,
+    wait_for: Optional["OneOrManyFutureOrResult[Any]"] = None,
+    return_type: Literal["result"] = "result",
+    dependencies: Optional[dict[str, set[TaskRunInput]]] = None,
+    context: Optional[dict[str, Any]] = None,
+) -> R: ...
+
+
 def run_task(
     task: "Task[P, Union[R, Coroutine[Any, Any, R]]]",
     task_run_id: Optional[UUID] = None,

prefect/tasks.py

@@ -1426,6 +1426,8 @@ class Task(Generic[P, R]):
         else:
             return futures
 
+    # Background task methods
+
     def apply_async(
         self,
         args: Optional[tuple[Any, ...]] = None,

prefect/telemetry/run_telemetry.py

@@ -16,6 +16,7 @@ from opentelemetry.trace import (
 from typing_extensions import TypeAlias
 
 import prefect
+import prefect.settings
 from prefect.client.orchestration import PrefectClient, SyncPrefectClient
 from prefect.client.schemas import FlowRun, TaskRun
 from prefect.client.schemas.objects import State
@@ -50,15 +51,19 @@ class RunTelemetry:
         default_factory=lambda: get_tracer("prefect", prefect.__version__)
     )
     span: Span | None = None
+    _enabled: bool = field(
+        default_factory=lambda: prefect.settings.get_current_settings().cloud.enable_orchestration_telemetry
+    )
 
     async def async_start_span(
         self,
         run: FlowOrTaskRun,
         client: PrefectClient,
         parameters: dict[str, Any] | None = None,
-    ) -> Span:
+    ) -> Span | None:
+        if not self._enabled:
+            return None
         traceparent, span = self._start_span(run, parameters)
-
         if self._run_type(run) == "flow" and traceparent:
             # Only explicitly update labels if the run is a flow as task runs
             # are updated via events.
@@ -73,7 +78,10 @@ class RunTelemetry:
         run: FlowOrTaskRun,
         client: SyncPrefectClient,
         parameters: dict[str, Any] | None = None,
-    ) -> Span:
+    ) -> Span | None:
+        if not self._enabled:
+            return None
+
         traceparent, span = self._start_span(run, parameters)
 
         if self._run_type(run) == "flow" and traceparent:

prefect/workers/base.py

@@ -3,31 +3,31 @@ from __future__ import annotations
 import abc
 import asyncio
 import threading
+import warnings
 from contextlib import AsyncExitStack
 from functools import partial
 from typing import (
     TYPE_CHECKING,
     Any,
     Callable,
-    Dict,
     Generic,
-    List,
     Optional,
-    Set,
     Type,
-    Union,
 )
 from uuid import UUID, uuid4
 
 import anyio
 import anyio.abc
 import httpx
-from importlib_metadata import distributions
+from importlib_metadata import (
+    distributions,  # type: ignore[reportUnknownVariableType] incomplete typing
+)
 from pydantic import BaseModel, Field, PrivateAttr, field_validator
 from pydantic.json_schema import GenerateJsonSchema
 from typing_extensions import Literal, Self, TypeVar
 
 import prefect
+from prefect._internal.compatibility.deprecated import PrefectDeprecationWarning
 from prefect._internal.schemas.validators import return_v_or_none
 from prefect.client.base import ServerType
 from prefect.client.orchestration import PrefectClient, get_client
@@ -94,12 +94,12 @@ class BaseJobConfiguration(BaseModel):
             "will be automatically generated by the worker."
         ),
     )
-    env: Dict[str, Optional[str]] = Field(
+    env: dict[str, Optional[str]] = Field(
         default_factory=dict,
         title="Environment Variables",
         description="Environment variables to set when starting a flow run.",
     )
-    labels: Dict[str, str] = Field(
+    labels: dict[str, str] = Field(
         default_factory=dict,
         description=(
             "Labels applied to infrastructure created by the worker using "
@@ -114,7 +114,7 @@ class BaseJobConfiguration(BaseModel):
         ),
     )
 
-    _related_objects: Dict[str, Any] = PrivateAttr(default_factory=dict)
+    _related_objects: dict[str, Any] = PrivateAttr(default_factory=dict)
 
     @property
     def is_using_a_runner(self) -> bool:
@@ -122,18 +122,18 @@ class BaseJobConfiguration(BaseModel):
 
     @field_validator("command")
     @classmethod
-    def _coerce_command(cls, v):
+    def _coerce_command(cls, v: str | None) -> str | None:
         return return_v_or_none(v)
 
     @field_validator("env", mode="before")
     @classmethod
-    def _coerce_env(cls, v):
+    def _coerce_env(cls, v: dict[str, Any]) -> dict[str, str | None]:
         return {k: str(v) if v is not None else None for k, v in v.items()}
 
     @staticmethod
-    def _get_base_config_defaults(variables: dict) -> dict:
+    def _get_base_config_defaults(variables: dict[str, Any]) -> dict[str, Any]:
         """Get default values from base config for all variables that have them."""
-        defaults = dict()
+        defaults: dict[str, Any] = {}
         for variable_name, attrs in variables.items():
             # We remote `None` values because we don't want to use them in templating.
             # The currently logic depends on keys not existing to populate the correct value
@@ -149,9 +149,9 @@ class BaseJobConfiguration(BaseModel):
     @inject_client
     async def from_template_and_values(
         cls,
-        base_job_template: dict,
-        values: dict,
-        client: Optional["PrefectClient"] = None,
+        base_job_template: dict[str, Any],
+        values: dict[str, Any],
+        client: "PrefectClient | None" = None,
     ):
         """Creates a valid worker configuration object from the provided base
         configuration and overrides.
@@ -159,7 +159,7 @@ class BaseJobConfiguration(BaseModel):
         Important: this method expects that the base_job_template was already
         validated server-side.
         """
-        base_config: Dict[str, Any] = base_job_template["job_configuration"]
+        base_config: dict[str, Any] = base_job_template["job_configuration"]
         variables_schema = base_job_template["variables"]
         variables = cls._get_base_config_defaults(
             variables_schema.get("properties", {})
@@ -213,8 +213,10 @@ class BaseJobConfiguration(BaseModel):
     def prepare_for_flow_run(
         self,
         flow_run: "FlowRun",
-        deployment: Optional["DeploymentResponse"] = None,
-        flow: Optional["Flow"] = None,
+        deployment: "DeploymentResponse | None" = None,
+        flow: "Flow | None" = None,
+        work_pool: "WorkPool | None" = None,
+        worker_name: str | None = None,
     ) -> None:
         """
         Prepare the job configuration for a flow run.
@@ -227,6 +229,8 @@ class BaseJobConfiguration(BaseModel):
             flow_run: The flow run to be executed.
             deployment: The deployment that the flow run is associated with.
             flow: The flow that the flow run is associated with.
+            work_pool: The work pool that the flow run is running in.
+            worker_name: The name of the worker that is submitting the flow run.
         """
 
         self._related_objects = {
@@ -234,26 +238,19 @@ class BaseJobConfiguration(BaseModel):
             "flow": flow,
             "flow-run": flow_run,
         }
-        if deployment is not None:
-            deployment_labels = self._base_deployment_labels(deployment)
-        else:
-            deployment_labels = {}
-
-        if flow is not None:
-            flow_labels = self._base_flow_labels(flow)
-        else:
-            flow_labels = {}
 
         env = {
             **self._base_environment(),
             **self._base_flow_run_environment(flow_run),
-            **(self.env if isinstance(self.env, dict) else {}),
+            **(self.env if isinstance(self.env, dict) else {}),  # pyright: ignore[reportUnnecessaryIsInstance]
         }
         self.env = {key: value for key, value in env.items() if value is not None}
         self.labels = {
             **self._base_flow_run_labels(flow_run),
-            **deployment_labels,
-            **flow_labels,
+            **self._base_work_pool_labels(work_pool),
+            **self._base_worker_name_label(worker_name),
+            **self._base_flow_labels(flow),
+            **self._base_deployment_labels(deployment),
             **self.labels,
         }
         self.name = self.name or flow_run.name
@@ -267,7 +264,7 @@ class BaseJobConfiguration(BaseModel):
         return "prefect flow-run execute"
 
     @staticmethod
-    def _base_flow_run_labels(flow_run: "FlowRun") -> Dict[str, str]:
+    def _base_flow_run_labels(flow_run: "FlowRun") -> dict[str, str]:
         """
         Generate a dictionary of labels for a flow run job.
         """
@@ -278,7 +275,7 @@ class BaseJobConfiguration(BaseModel):
         }
 
     @classmethod
-    def _base_environment(cls) -> Dict[str, str]:
+    def _base_environment(cls) -> dict[str, str]:
         """
         Environment variables that should be passed to all created infrastructure.
 
@@ -287,14 +284,22 @@ class BaseJobConfiguration(BaseModel):
         return get_current_settings().to_environment_variables(exclude_unset=True)
 
     @staticmethod
-    def _base_flow_run_environment(flow_run: "FlowRun") -> Dict[str, str]:
+    def _base_flow_run_environment(flow_run: "FlowRun | None") -> dict[str, str]:
         """
         Generate a dictionary of environment variables for a flow run job.
         """
+        if flow_run is None:
+            return {}
+
         return {"PREFECT__FLOW_RUN_ID": str(flow_run.id)}
 
     @staticmethod
-    def _base_deployment_labels(deployment: "DeploymentResponse") -> Dict[str, str]:
+    def _base_deployment_labels(
+        deployment: "DeploymentResponse | None",
+    ) -> dict[str, str]:
+        if deployment is None:
+            return {}
+
         labels = {
             "prefect.io/deployment-id": str(deployment.id),
             "prefect.io/deployment-name": deployment.name,
@@ -306,15 +311,37 @@ class BaseJobConfiguration(BaseModel):
         return labels
 
     @staticmethod
-    def _base_flow_labels(flow: "Flow") -> Dict[str, str]:
+    def _base_flow_labels(flow: "Flow | None") -> dict[str, str]:
+        if flow is None:
+            return {}
+
         return {
             "prefect.io/flow-id": str(flow.id),
             "prefect.io/flow-name": flow.name,
         }
 
-    def _related_resources(self) -> List[RelatedResource]:
-        tags = set()
-        related = []
+    @staticmethod
+    def _base_work_pool_labels(work_pool: "WorkPool | None") -> dict[str, str]:
+        """Adds the work pool labels to the job manifest."""
+        if work_pool is None:
+            return {}
+
+        return {
+            "prefect.io/work-pool-name": work_pool.name,
+            "prefect.io/work-pool-id": str(work_pool.id),
+        }
+
+    @staticmethod
+    def _base_worker_name_label(worker_name: str | None) -> dict[str, str]:
+        """Adds the worker name label to the job manifest."""
+        if worker_name is None:
+            return {}
+
+        return {"prefect.io/worker-name": worker_name}
+
+    def _related_resources(self) -> list[RelatedResource]:
+        tags: set[str] = set()
+        related: list[RelatedResource] = []
 
         for kind, obj in self._related_objects.items():
             if obj is None:
@@ -331,12 +358,12 @@ class BaseVariables(BaseModel):
         default=None,
         description="Name given to infrastructure created by a worker.",
     )
-    env: Dict[str, Optional[str]] = Field(
+    env: dict[str, Optional[str]] = Field(
         default_factory=dict,
         title="Environment Variables",
         description="Environment variables to set when starting a flow run.",
     )
-    labels: Dict[str, str] = Field(
+    labels: dict[str, str] = Field(
         default_factory=dict,
         description="Labels applied to infrastructure created by a worker.",
     )
@@ -356,7 +383,7 @@ class BaseVariables(BaseModel):
         ref_template: str = "#/definitions/{model}",
         schema_generator: Type[GenerateJsonSchema] = GenerateJsonSchema,
         mode: Literal["validation", "serialization"] = "validation",
-    ) -> Dict[str, Any]:
+    ) -> dict[str, Any]:
         """TODO: stop overriding this method - use GenerateSchema in ConfigDict instead?"""
         schema = super().model_json_schema(
             by_alias, ref_template, schema_generator, mode
@@ -403,14 +430,14 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
     def __init__(
         self,
         work_pool_name: str,
-        work_queues: Optional[List[str]] = None,
-        name: Optional[str] = None,
-        prefetch_seconds: Optional[float] = None,
+        work_queues: list[str] | None = None,
+        name: str | None = None,
+        prefetch_seconds: float | None = None,
         create_pool_if_not_found: bool = True,
-        limit: Optional[int] = None,
-        heartbeat_interval_seconds: Optional[int] = None,
+        limit: int | None = None,
+        heartbeat_interval_seconds: int | None = None,
         *,
-        base_job_template: Optional[Dict[str, Any]] = None,
+        base_job_template: dict[str, Any] | None = None,
     ):
         """
         Base class for all Prefect workers.
@@ -445,7 +472,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         self._create_pool_if_not_found = create_pool_if_not_found
         self._base_job_template = base_job_template
         self._work_pool_name = work_pool_name
-        self._work_queues: Set[str] = set(work_queues) if work_queues else set()
+        self._work_queues: set[str] = set(work_queues) if work_queues else set()
 
         self._prefetch_seconds: float = (
             prefetch_seconds or PREFECT_WORKER_PREFETCH_SECONDS.value()
@@ -461,11 +488,35 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         self._last_polled_time: DateTime = DateTime.now("utc")
         self._limit = limit
         self._limiter: Optional[anyio.CapacityLimiter] = None
-        self._submitting_flow_run_ids = set()
-        self._cancelling_flow_run_ids = set()
-        self._scheduled_task_scopes = set()
+        self._submitting_flow_run_ids: set[UUID] = set()
+        self._cancelling_flow_run_ids: set[UUID] = set()
+        self._scheduled_task_scopes: set[anyio.CancelScope] = set()
         self._worker_metadata_sent = False
 
+    @property
+    def client(self) -> PrefectClient:
+        if self._client is None:
+            raise RuntimeError(
+                "Worker has not been correctly initialized. Please use the worker class as an async context manager."
+            )
+        return self._client
+
+    @property
+    def work_pool(self) -> WorkPool:
+        if self._work_pool is None:
+            raise RuntimeError(
+                "Worker has not been correctly initialized. Please use the worker class as an async context manager."
+            )
+        return self._work_pool
+
+    @property
+    def limiter(self) -> anyio.CapacityLimiter:
+        if self._limiter is None:
+            raise RuntimeError(
+                "Worker has not been correctly initialized. Please use the worker class as an async context manager."
+            )
+        return self._limiter
+
     @classmethod
     def get_documentation_url(cls) -> str:
         return cls._documentation_url
@@ -510,7 +561,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
             return worker_registry.get(type)
 
     @staticmethod
-    def get_all_available_worker_types() -> List[str]:
+    def get_all_available_worker_types() -> list[str]:
         """
         Returns all worker types available in the local registry.
         """
@@ -790,7 +841,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
 
         should_get_worker_id = self._should_get_worker_id()
 
-        params = {
+        params: dict[str, Any] = {
             "work_pool_name": self._work_pool_name,
             "worker_name": self.name,
             "heartbeat_interval_seconds": self.heartbeat_interval_seconds,
@@ -852,7 +903,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
 
     async def _get_scheduled_flow_runs(
         self,
-    ) -> List["WorkerFlowRunResponse"]:
+    ) -> list["WorkerFlowRunResponse"]:
         """
         Retrieve scheduled flow runs from the work pool's queues.
         """
@@ -862,7 +913,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         )
         try:
             scheduled_flow_runs = (
-                await self._client.get_scheduled_flow_runs_for_work_pool(
+                await self.client.get_scheduled_flow_runs_for_work_pool(
                     work_pool_name=self._work_pool_name,
                     scheduled_before=scheduled_before,
                     work_queue_names=list(self._work_queues),
@@ -878,8 +929,8 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
             return []
 
     async def _submit_scheduled_flow_runs(
-        self, flow_run_response: List["WorkerFlowRunResponse"]
-    ) -> List["FlowRun"]:
+        self, flow_run_response: list["WorkerFlowRunResponse"]
+    ) -> list["FlowRun"]:
         """
         Takes a list of WorkerFlowRunResponses and submits the referenced flow runs
         for execution by the worker.
@@ -897,7 +948,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
                     self._limiter.acquire_on_behalf_of_nowait(flow_run.id)
             except anyio.WouldBlock:
                 self._logger.info(
-                    f"Flow run limit reached; {self._limiter.borrowed_tokens} flow runs"
+                    f"Flow run limit reached; {self.limiter.borrowed_tokens} flow runs"
                     " in progress."
                 )
                 break
@@ -921,6 +972,8 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
                         run_logger.warning(f"Failed to generate worker URL: {ve}")
 
                 self._submitting_flow_run_ids.add(flow_run.id)
+                if TYPE_CHECKING:
+                    assert self._runs_task_group is not None
                 self._runs_task_group.start_soon(
                     self._submit_run,
                     flow_run,
@@ -939,14 +992,9 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         """
         run_logger = self.get_flow_run_logger(flow_run)
 
-        if flow_run.deployment_id:
-            assert self._client and self._client._started, (
-                "Client must be started to check flow run deployment."
-            )
-
         try:
-            await self._client.read_deployment(flow_run.deployment_id)
-        except ObjectNotFound:
+            await self.client.read_deployment(getattr(flow_run, "deployment_id"))
+        except (ObjectNotFound, AttributeError):
             self._logger.exception(
                 f"Deployment {flow_run.deployment_id} no longer exists. "
                 f"Flow run {flow_run.id} will not be submitted for"
@@ -964,13 +1012,15 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         ready_to_submit = await self._propose_pending_state(flow_run)
         self._logger.debug(f"Ready to submit {flow_run.id}: {ready_to_submit}")
         if ready_to_submit:
+            if TYPE_CHECKING:
+                assert self._runs_task_group is not None
             readiness_result = await self._runs_task_group.start(
                 self._submit_run_and_capture_errors, flow_run
             )
 
             if readiness_result and not isinstance(readiness_result, Exception):
                 try:
-                    await self._client.update_flow_run(
+                    await self.client.update_flow_run(
                         flow_run_id=flow_run.id,
                         infrastructure_pid=str(readiness_result),
                     )
@@ -991,8 +1041,10 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         self._submitting_flow_run_ids.remove(flow_run.id)
 
     async def _submit_run_and_capture_errors(
-        self, flow_run: "FlowRun", task_status: Optional[anyio.abc.TaskStatus] = None
-    ) -> Union[BaseWorkerResult, Exception]:
+        self,
+        flow_run: "FlowRun",
+        task_status: anyio.abc.TaskStatus[int | Exception] | None = None,
+    ) -> BaseWorkerResult | Exception:
         run_logger = self.get_flow_run_logger(flow_run)
 
         try:
@@ -1006,7 +1058,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
                 configuration=configuration,
             )
         except Exception as exc:
-            if not task_status._future.done():
+            if task_status and not getattr(task_status, "_future").done():
                 # This flow run was being submitted and did not start successfully
                 run_logger.exception(
                     f"Failed to submit flow run '{flow_run.id}' to infrastructure."
@@ -1025,7 +1077,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         finally:
             self._release_limit_slot(flow_run.id)
 
-        if not task_status._future.done():
+        if task_status and not getattr(task_status, "_future").done():
             run_logger.error(
                 f"Infrastructure returned without reporting flow run '{flow_run.id}' "
                 "as started or raising an error. This behavior is not expected and "
@@ -1033,7 +1085,11 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
                 "flow run will not be marked as failed, but an issue may have occurred."
             )
             # Mark the task as started to prevent agent crash
-            task_status.started()
+            task_status.started(
+                RuntimeError(
+                    "Infrastructure returned without reporting flow run as started or raising an error."
+                )
+            )
 
         if result.status_code != 0:
             await self._propose_crashed_state(
@@ -1044,11 +1100,12 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
                 ),
             )
 
-        self._emit_flow_run_executed_event(result, configuration, submitted_event)
+        if submitted_event:
+            self._emit_flow_run_executed_event(result, configuration, submitted_event)
 
         return result
 
-    def _release_limit_slot(self, flow_run_id: str) -> None:
+    def _release_limit_slot(self, flow_run_id: UUID) -> None:
         """
         Frees up a slot taken by the given flow run id.
         """
@@ -1078,14 +1135,12 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         flow_run: "FlowRun",
         deployment: Optional["DeploymentResponse"] = None,
     ) -> C:
-        deployment = (
-            deployment
-            if deployment
-            else await self._client.read_deployment(flow_run.deployment_id)
-        )
-        flow = await self._client.read_flow(flow_run.flow_id)
+        if not deployment and flow_run.deployment_id:
+            deployment = await self.client.read_deployment(flow_run.deployment_id)
 
-        deployment_vars = deployment.job_variables or {}
+        flow = await self.client.read_flow(flow_run.flow_id)
+
+        deployment_vars = getattr(deployment, "job_variables", {}) or {}
         flow_run_vars = flow_run.job_variables or {}
         job_variables = {**deployment_vars}
 
@@ -1095,22 +1150,37 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         job_variables.update(flow_run_vars)
 
         configuration = await self.job_configuration.from_template_and_values(
-            base_job_template=self._work_pool.base_job_template,
+            base_job_template=self.work_pool.base_job_template,
             values=job_variables,
-            client=self._client,
-        )
-        configuration.prepare_for_flow_run(
-            flow_run=flow_run, deployment=deployment, flow=flow
+            client=self.client,
         )
+        try:
+            configuration.prepare_for_flow_run(
+                flow_run=flow_run,
+                deployment=deployment,
+                flow=flow,
+                work_pool=self.work_pool,
+                worker_name=self.name,
+            )
+        except TypeError:
+            warnings.warn(
+                "This worker is missing the `work_pool` and `worker_name` arguments "
+                "in its JobConfiguration.prepare_for_flow_run method. Please update "
+                "the worker's JobConfiguration  class to accept these arguments to "
+                "avoid this warning.",
+                category=PrefectDeprecationWarning,
+            )
+            # Handle older subclasses that don't accept work_pool and worker_name
+            configuration.prepare_for_flow_run(
+                flow_run=flow_run, deployment=deployment, flow=flow
+            )
         return configuration
 
     async def _propose_pending_state(self, flow_run: "FlowRun") -> bool:
         run_logger = self.get_flow_run_logger(flow_run)
         state = flow_run.state
         try:
-            state = await propose_state(
-                self._client, Pending(), flow_run_id=flow_run.id
-            )
+            state = await propose_state(self.client, Pending(), flow_run_id=flow_run.id)
         except Abort as exc:
             run_logger.info(
                 (
@@ -1141,7 +1211,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         run_logger = self.get_flow_run_logger(flow_run)
         try:
             await propose_state(
-                self._client,
+                self.client,
                 await exception_to_failed_state(message="Submission failed.", exc=exc),
                 flow_run_id=flow_run.id,
             )
@@ -1159,7 +1229,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         run_logger = self.get_flow_run_logger(flow_run)
         try:
             state = await propose_state(
-                self._client,
+                self.client,
                 Crashed(message=message),
                 flow_run_id=flow_run.id,
             )
@@ -1175,14 +1245,16 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
                 )
 
     async def _mark_flow_run_as_cancelled(
-        self, flow_run: "FlowRun", state_updates: Optional[dict] = None
+        self, flow_run: "FlowRun", state_updates: dict[str, Any] | None = None
     ) -> None:
         state_updates = state_updates or {}
         state_updates.setdefault("name", "Cancelled")
         state_updates.setdefault("type", StateType.CANCELLED)
+        if TYPE_CHECKING:
+            assert flow_run.state
         state = flow_run.state.model_copy(update=state_updates)
 
-        await self._client.set_flow_run_state(flow_run.id, state, force=True)
+        await self.client.set_flow_run_state(flow_run.id, state, force=True)
 
         # Do not remove the flow run from the cancelling set immediately because
         # the API caches responses for the `read_flow_runs` and we do not want to
@@ -1191,16 +1263,21 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
             60 * 10, self._cancelling_flow_run_ids.remove, flow_run.id
         )
 
-    async def _set_work_pool_template(self, work_pool, job_template):
+    async def _set_work_pool_template(
+        self, work_pool: "WorkPool", job_template: dict[str, Any]
+    ):
         """Updates the `base_job_template` for the worker's work pool server side."""
-        await self._client.update_work_pool(
+
+        await self.client.update_work_pool(
             work_pool_name=work_pool.name,
             work_pool=WorkPoolUpdate(
                 base_job_template=job_template,
             ),
         )
 
-    async def _schedule_task(self, __in_seconds: int, fn, *args, **kwargs):
+    async def _schedule_task(
+        self, __in_seconds: int, fn: Callable[..., Any], *args: Any, **kwargs: Any
+    ):
         """
         Schedule a background task to start after some time.
 
@@ -1208,8 +1285,12 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
 
         The function may be async or sync. Async functions will be awaited.
         """
+        if not self._runs_task_group:
+            raise RuntimeError(
+                "Worker has not been correctly initialized. Please use the worker class as an async context manager."
+            )
 
-        async def wrapper(task_status):
+        async def wrapper(task_status: anyio.abc.TaskStatus[Any]):
             # If we are shutting down, do not sleep; otherwise sleep until the scheduled
             # time or shutdown
             if self.is_setup:
@@ -1271,12 +1352,12 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
 
     def _event_related_resources(
         self,
-        configuration: Optional[BaseJobConfiguration] = None,
+        configuration: BaseJobConfiguration | None = None,
         include_self: bool = False,
-    ) -> List[RelatedResource]:
-        related = []
+    ) -> list[RelatedResource]:
+        related: list[RelatedResource] = []
         if configuration:
-            related += configuration._related_resources()
+            related += getattr(configuration, "_related_resources")()
 
         if self._work_pool:
             related.append(
@@ -1294,7 +1375,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
 
     def _emit_flow_run_submitted_event(
         self, configuration: BaseJobConfiguration
-    ) -> Event:
+    ) -> Event | None:
         return emit_event(
             event="prefect.worker.submitted-flow-run",
             resource=self._event_resource(),
@@ -1305,7 +1386,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         self,
         result: BaseWorkerResult,
         configuration: BaseJobConfiguration,
-        submitted_event: Event,
+        submitted_event: Event | None = None,
     ):
         related = self._event_related_resources(configuration=configuration)
 
@@ -1321,7 +1402,7 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
             follows=submitted_event,
         )
 
-    async def _emit_worker_started_event(self) -> Event:
+    async def _emit_worker_started_event(self) -> Event | None:
         return emit_event(
             "prefect.worker.started",
             resource=self._event_resource(),

prefect/workers/process.py

@@ -29,7 +29,6 @@ import anyio.abc
 from pydantic import Field, field_validator
 
 from prefect._internal.schemas.validators import validate_working_dir
-from prefect.client.schemas import FlowRun
 from prefect.runner.runner import Runner
 from prefect.settings import PREFECT_WORKER_QUERY_SECONDS
 from prefect.utilities.processutils import get_sys_executable
@@ -42,7 +41,7 @@ from prefect.workers.base import (
 )
 
 if TYPE_CHECKING:
-    from prefect.client.schemas.objects import Flow
+    from prefect.client.schemas.objects import Flow, FlowRun, WorkPool
     from prefect.client.schemas.responses import DeploymentResponse
 
 
@@ -60,10 +59,12 @@ class ProcessJobConfiguration(BaseJobConfiguration):
     def prepare_for_flow_run(
         self,
         flow_run: "FlowRun",
-        deployment: Optional["DeploymentResponse"] = None,
-        flow: Optional["Flow"] = None,
+        deployment: "DeploymentResponse | None" = None,
+        flow: "Flow | None" = None,
+        work_pool: "WorkPool | None" = None,
+        worker_name: str | None = None,
     ) -> None:
-        super().prepare_for_flow_run(flow_run, deployment, flow)
+        super().prepare_for_flow_run(flow_run, deployment, flow, work_pool, worker_name)
 
         self.env: dict[str, str | None] = {**os.environ, **self.env}
         self.command: str | None = (
@@ -201,7 +202,7 @@ class ProcessWorker(
 
     async def run(
         self,
-        flow_run: FlowRun,
+        flow_run: "FlowRun",
         configuration: ProcessJobConfiguration,
         task_status: Optional[anyio.abc.TaskStatus[int]] = None,
     ) -> ProcessWorkerResult:

{prefect_client-3.2.12.dist-info → prefect_client-3.2.13.dist-info}/METADATA

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

{prefect_client-3.2.12.dist-info → prefect_client-3.2.13.dist-info}/RECORD

@@ -1,7 +1,7 @@
 prefect/.prefectignore,sha256=awSprvKT0vI8a64mEOLrMxhxqcO-b0ERQeYpA2rNKVQ,390
 prefect/__init__.py,sha256=iCdcC5ZmeewikCdnPEP6YBAjPNV5dvfxpYCTpw30Hkw,3685
 prefect/__main__.py,sha256=WFjw3kaYJY6pOTA7WDOgqjsz8zUEUZHCcj3P5wyVa-g,66
-prefect/_build_info.py,sha256=0jvzxnFcIJ0SfWt4cMwAzZNs6tBDVGSkVmAMrLX_sZI,181
+prefect/_build_info.py,sha256=fPct5cKMbz-qqS_zMeI5SJEFgZXcf41UFkUscPv_ikM,181
 prefect/_result_records.py,sha256=S6QmsODkehGVSzbMm6ig022PYbI6gNKz671p_8kBYx4,7789
 prefect/_waiters.py,sha256=Ia2ITaXdHzevtyWIgJoOg95lrEXQqNEOquHvw3T33UQ,9026
 prefect/agent.py,sha256=dPvG1jDGD5HSH7aM2utwtk6RaJ9qg13XjkA0lAIgQmY,287
@@ -14,7 +14,7 @@ prefect/exceptions.py,sha256=-nih8qqdxRm6CX-4yrqwePVh8Mcpvla_V6N_KbdJsIU,11593
 prefect/filesystems.py,sha256=v5YqGB4uXf9Ew2VuB9VCSkawvYMMVvEtZf7w1VmAmr8,18036
 prefect/flow_engine.py,sha256=gR44YU7aCAbHEqoMDdxL1SDrtS5Xx1Kzg3M7FWjHcvY,58967
 prefect/flow_runs.py,sha256=ocbV3ioSBIFoLqExpI2YLteyHdWpHB3t0lrbfl-Ni1E,17256
-prefect/flows.py,sha256=jDGOG_rOk5SgVZ9HM4HDi9T9Cmka5uooY8UkueK9SBo,109057
+prefect/flows.py,sha256=dsrV-qNP_2eUsdG409XbtNtfMkTIzcAnBbXrD9OBUgQ,108950
 prefect/futures.py,sha256=ADd8ceFqX7A8Kw8aXaqvbYRG03uU82OEY30xrP5vrwY,23599
 prefect/main.py,sha256=hFeTTrr01qWKcRwZVEHVipyHEybS0VLTscFV6zG6GtY,2306
 prefect/plugins.py,sha256=FPRLR2mWVBMuOnlzeiTD9krlHONZH2rtYLD753JQDNQ,2516
@@ -23,11 +23,11 @@ prefect/results.py,sha256=gAcYivq5CN8oL5CWu8cJe2560i0M8I5GL-8RcBTJ6VI,36385
 prefect/schedules.py,sha256=9ufG4jhIA_R7vS9uXqnnZEgB7Ts922KMhNacWcveVgA,7291
 prefect/serializers.py,sha256=QI0oEal_BO4HQaWSjr6ReSwT55Hn4sbSOXxGgQI1-y0,9249
 prefect/states.py,sha256=tTZrN-IZKvmFcN8FR_4L-X-ZrmXi6z-cPXl6KdOy-XI,26920
-prefect/task_engine.py,sha256=BF7dZPgIMgq2XeNe6GHHyqPTrCfJN2ZDfETOvedvbw8,60683
+prefect/task_engine.py,sha256=nbiaDyTNN89zP_ibJbe_Zrw2kLGZ4QqoeN221iIc5y0,61526
 prefect/task_runners.py,sha256=Ce_ngocfq_X-NA5zhPj13IdVmzZ5h6gXlmfxYWs2AXA,15828
 prefect/task_runs.py,sha256=7LIzfo3fondCyEUpU05sYFN5IfpZigBDXrhG5yc-8t0,9039
 prefect/task_worker.py,sha256=mihWOZ3IpZCupqBboB_T1XhLm-0ApwwptTgUH-I3nKo,17794
-prefect/tasks.py,sha256=g__kIAXvbvdY7NtK7R-KbJg7qUP31xjf5uK80zRS3Ds,74049
+prefect/tasks.py,sha256=KkqUaGYArxOSf8dRCr6HKtrqWrMfUhq8U4fXC93m4AE,74080
 prefect/transactions.py,sha256=kOXwghBW3jM71gg49MkjJPTnImEzXWeTCUE_zpq2MlI,16068
 prefect/variables.py,sha256=dCK3vX7TbkqXZhnNT_v7rcGh3ISRqoR6pJVLpoll3Js,8342
 prefect/_experimental/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -181,7 +181,7 @@ prefect/logging/filters.py,sha256=NnRYubh9dMmWcCAjuW32cIVQ37rLxdn8ci26wTtQMyU,11
 prefect/logging/formatters.py,sha256=BkPykVyOFKdnhDj_1vhhOoWiHiiBeRnWXPcaRIWK3aI,4125
 prefect/logging/handlers.py,sha256=pIeS6gvuVnuh3lZ-kIC4ijRMSbVPkHo-rYeLMj5P8NA,12240
 prefect/logging/highlighters.py,sha256=BCf_LNhFInIfGPqwuu8YVrGa4wVxNc4YXo2pYgftpg4,1811
-prefect/logging/loggers.py,sha256=xkmHXsiuoPZZXcrrEgMA-ZQu0E-gW3tNVd4BIxWjnpM,12704
+prefect/logging/loggers.py,sha256=rwFJv0i3dhdKr25XX-xUkQy4Vv4dy18bTy366jrC0OQ,12741
 prefect/logging/logging.yml,sha256=tT7gTyC4NmngFSqFkCdHaw7R0GPNPDDsTCGZQByiJAQ,3169
 prefect/runner/__init__.py,sha256=7U-vAOXFkzMfRz1q8Uv6Otsvc0OrPYLLP44srwkJ_8s,89
 prefect/runner/runner.py,sha256=8JixM-hU4Oo4AMaXhWGEISUdZCg0AZdPGkP4lXxbMu0,65436
@@ -218,7 +218,7 @@ prefect/server/api/middleware.py,sha256=WkyuyeJIfo9Q0GAIVU5gO6yIGNVwoHwuBah5AB5o
 prefect/server/api/root.py,sha256=CeumFYIM_BDvPicJH9ry5PO_02PZTLeMqbLMGGTh90o,942
 prefect/server/api/run_history.py,sha256=FHepAgo1AYFeuh7rrAVzo_o3hu8Uc8-4DeH5aD5VGgw,5995
 prefect/server/api/saved_searches.py,sha256=UjoqLLe245QVIs6q5Vk4vdODCOoYzciEEjhi7B8sYCE,3233
-prefect/server/api/server.py,sha256=iJX47L_ae4lskDqpOqFvYe3CwKykgw77HkHtqh0UODQ,32367
+prefect/server/api/server.py,sha256=GHbHTm8qd6i0mbqhnplFNHStUXwYnOuOFc4F9OAYk1c,32940
 prefect/server/api/task_run_states.py,sha256=e63OPpxPudv_CIB5oKr8Z8rfQ-Osjm9Zq0iHe8obnMo,1647
 prefect/server/api/task_runs.py,sha256=VY6MrolTi_vmiaE5my3WyRl5r256WKC7sfxxBE4Wnpw,12239
 prefect/server/api/task_workers.py,sha256=cFP9M8tsApDL_JpySn-x6fOYy9RnOeOgKiqOl_UVVQM,1042
@@ -274,7 +274,7 @@ prefect/telemetry/bootstrap.py,sha256=tD6CXgMU3skgpKNscrRYZudwCWEEt6wjwMsulYpHeA
 prefect/telemetry/instrumentation.py,sha256=9JElKwEqKhErohjHNS4oAIXJRYCWVY0rfSnk4DUBna0,4454
 prefect/telemetry/logging.py,sha256=yn5D4D2GGRrAv0y8wlHPN7PZDmQucGjQT_YauK9M9Yo,727
 prefect/telemetry/processors.py,sha256=jw6j6LviOVxw3IBJe7cSjsxFk0zzY43jUmy6C9pcfCE,2272
-prefect/telemetry/run_telemetry.py,sha256=xOrZEFf-1cbSdKe3ZlB4spbyJ3sxYbnb2u2yZiUSSqM,8282
+prefect/telemetry/run_telemetry.py,sha256=_FbjiPqPemu4xvZuI2YBPwXeRJ2BcKRJ6qgO4UMzKKE,8571
 prefect/telemetry/services.py,sha256=DxgNNDTeWNtHBtioX8cjua4IrCbTiJJdYecx-gugg-w,2358
 prefect/types/__init__.py,sha256=yBjKxiQmSC7jXoo0UNmM3KZil1NBFS-BWGPfwSEaoJo,4621
 prefect/types/_datetime.py,sha256=eOsg5gkm4bATLWvK4lmLqHByxQdER6gfTFyafzj-DLk,3343
@@ -312,13 +312,13 @@ prefect/utilities/schema_tools/__init__.py,sha256=At3rMHd2g_Em2P3_dFQlFgqR_EpBwr
 prefect/utilities/schema_tools/hydration.py,sha256=NkRhWkNfxxFmVGhNDfmxdK_xeKaEhs3a42q83Sg9cT4,9436
 prefect/utilities/schema_tools/validation.py,sha256=Wix26IVR-ZJ32-6MX2pHhrwm3reB-Q4iB6_phn85OKE,10743
 prefect/workers/__init__.py,sha256=EaM1F0RZ-XIJaGeTKLsXDnfOPHzVWk5bk0_c4BVS44M,64
-prefect/workers/base.py,sha256=_7_XRi-5v8jGqKelH12Lkf8CBUnXrq04JPlIMc6WhhM,49439
+prefect/workers/base.py,sha256=E0fZeR0zS_1y7Z7pNx8JyrRn9QLd9gHhA6kuG582Hl4,53040
 prefect/workers/block.py,sha256=dPvG1jDGD5HSH7aM2utwtk6RaJ9qg13XjkA0lAIgQmY,287
 prefect/workers/cloud.py,sha256=dPvG1jDGD5HSH7aM2utwtk6RaJ9qg13XjkA0lAIgQmY,287
-prefect/workers/process.py,sha256=ozC-PGp1rjEG7CO1D7wZYM3oO_DeefccXy3rBLJK3kA,8892
+prefect/workers/process.py,sha256=uxOwcqA2Ps-V-W6WeSdKCQMINrCxBEVx1K1Un8pb7vs,8973
 prefect/workers/server.py,sha256=SEuyScZ5nGm2OotdtbHjpvqJlTRVWCh29ND7FeL_fZA,1974
 prefect/workers/utilities.py,sha256=VfPfAlGtTuDj0-Kb8WlMgAuOfgXCdrGAnKMapPSBrwc,2483
-prefect_client-3.2.12.dist-info/METADATA,sha256=ncy68hiJUyKnuWCgyRWHXy_-LfawTvBaLA3VWyeBj44,7193
-prefect_client-3.2.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-prefect_client-3.2.12.dist-info/licenses/LICENSE,sha256=MCxsn8osAkzfxKC4CC_dLcUkU8DZLkyihZ8mGs3Ah3Q,11357
-prefect_client-3.2.12.dist-info/RECORD,,
+prefect_client-3.2.13.dist-info/METADATA,sha256=_597uZ6zBWXufm6Zc5TkIsJKb41D53QL2DJ-qUnjpX4,7193
+prefect_client-3.2.13.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+prefect_client-3.2.13.dist-info/licenses/LICENSE,sha256=MCxsn8osAkzfxKC4CC_dLcUkU8DZLkyihZ8mGs3Ah3Q,11357
+prefect_client-3.2.13.dist-info/RECORD,,