prefect-client 3.3.8.dev4__tar.gz → 3.4.1.dev1__tar.gz

{prefect_client-3.3.8.dev4 → prefect_client-3.4.1.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prefect-client
-Version: 3.3.8.dev4
+Version: 3.4.1.dev1
 Summary: Workflow orchestration and management.
 Project-URL: Changelog, https://github.com/PrefectHQ/prefect/releases
 Project-URL: Documentation, https://docs.prefect.io
@@ -40,7 +40,7 @@ Requires-Dist: jsonpatch<2.0,>=1.32
 Requires-Dist: jsonschema<5.0.0,>=4.0.0
 Requires-Dist: opentelemetry-api<2.0.0,>=1.27.0
 Requires-Dist: orjson<4.0,>=3.7
-Requires-Dist: packaging<24.3,>=21.3
+Requires-Dist: packaging<25.1,>=21.3
 Requires-Dist: pathspec>=0.8.0
 Requires-Dist: pendulum<4,>=3.0.0; python_version < '3.13'
 Requires-Dist: prometheus-client>=0.20.0
@@ -62,7 +62,7 @@ Requires-Dist: typing-extensions<5.0.0,>=4.10.0
 Requires-Dist: ujson<6.0.0,>=5.8.0
 Requires-Dist: uvicorn!=0.29.0,>=0.14.0
 Requires-Dist: websockets<16.0,>=13.0
-Requires-Dist: whenever<0.8.0,>=0.7.3; python_version >= '3.13'
+Requires-Dist: whenever<0.9.0,>=0.7.3; python_version >= '3.13'
 Provides-Extra: notifications
 Requires-Dist: apprise<2.0.0,>=1.1.0; extra == 'notifications'
 Description-Content-Type: text/markdown

{prefect_client-3.3.8.dev4 → prefect_client-3.4.1.dev1}/pyproject.toml

@@ -44,7 +44,7 @@ dependencies = [
     "jsonschema>=4.0.0,<5.0.0",
     "opentelemetry-api>=1.27.0,<2.0.0",
     "orjson>=3.7,<4.0",
-    "packaging>=21.3,<24.3",
+    "packaging>=21.3,<25.1",
     "pathspec>=0.8.0",
     "pendulum>=3.0.0,<4; python_version<'3.13'",
     "prometheus-client>=0.20.0",
@@ -66,7 +66,7 @@ dependencies = [
     "ujson>=5.8.0,<6.0.0",
     "uvicorn>=0.14.0,!=0.29.0",
     "websockets>=13.0,<16.0",
-    "whenever>=0.7.3,<0.8.0; python_version>='3.13'",
+    "whenever>=0.7.3,<0.9.0; python_version>='3.13'",
 ]
 [project.urls]
 Changelog = "https://github.com/PrefectHQ/prefect/releases"

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

@@ -0,0 +1,5 @@
+# Generated by versioningit
+__version__ = "3.4.1.dev1"
+__build_date__ = "2025-05-04 08:07:31.383855+00:00"
+__git_commit__ = "378fc4f6b72aace32343264ee6cea198d949ba6a"
+__dirty__ = False

{prefect_client-3.3.8.dev4 → prefect_client-3.4.1.dev1}/src/prefect/_versioning.py

@@ -422,6 +422,8 @@ async def get_inferred_version_info(
         get_git_version_info,
     ]
 
+    if version_type is VersionType.SIMPLE:
+        return None
     if version_type:
         if version_type not in type_to_getter:
             raise ValueError(f"Unknown version type: {version_type}")

{prefect_client-3.3.8.dev4 → prefect_client-3.4.1.dev1}/src/prefect/blocks/core.py

@@ -95,6 +95,12 @@ class InvalidBlockRegistration(Exception):
     """
 
 
+class UnknownBlockType(Exception):
+    """
+    Raised when a block type is not found in the registry.
+    """
+
+
 def _collect_nested_reference_strings(
     obj: dict[str, Any] | list[Any],
 ) -> list[dict[str, Any]]:
@@ -786,7 +792,20 @@ class Block(BaseModel, ABC):
         # before looking up the block class, but only do this once
         load_prefect_collections()
 
-        return lookup_type(cls, key)
+        try:
+            return lookup_type(cls, key)
+        except KeyError:
+            message = f"No block class found for slug {key!r}."
+            # Handle common blocks types used for storage, which is the primary use case for looking up blocks by key
+            if key == "s3-bucket":
+                message += " Please ensure that `prefect-aws` is installed."
+            elif key == "gcs-bucket":
+                message += " Please ensure that `prefect-gcp` is installed."
+            elif key == "azure-blob-storage-container":
+                message += " Please ensure that `prefect-azure` is installed."
+            else:
+                message += " Please ensure that the block class is available in the current environment."
+            raise UnknownBlockType(message)
 
     def _define_metadata_on_nested_blocks(
         self, block_document_references: dict[str, dict[str, Any]]

{prefect_client-3.3.8.dev4 → prefect_client-3.4.1.dev1}/src/prefect/client/schemas/objects.py

@@ -1459,6 +1459,10 @@ class WorkPoolStorageConfiguration(PrefectBaseModel):
     bundle_execution_step: Optional[dict[str, Any]] = Field(
         default=None, description="The bundle execution step for the work pool."
     )
+    default_result_storage_block_id: Optional[UUID] = Field(
+        default=None,
+        description="The block document ID of the default result storage block.",
+    )
 
 
 class WorkPool(ObjectBaseModel):

{prefect_client-3.3.8.dev4 → prefect_client-3.4.1.dev1}/src/prefect/deployments/runner.py

@@ -35,7 +35,15 @@ import importlib
 import tempfile
 from datetime import datetime, timedelta
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, ClassVar, Iterable, List, Optional, Union
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    ClassVar,
+    Iterable,
+    List,
+    Optional,
+    Union,
+)
 from uuid import UUID
 
 from pydantic import (
@@ -58,6 +66,7 @@ from prefect._internal.schemas.validators import (
     reconcile_paused_deployment,
     reconcile_schedules_runner,
 )
+from prefect._versioning import VersionType, get_inferred_version_info
 from prefect.client.base import ServerType
 from prefect.client.orchestration import PrefectClient, get_client
 from prefect.client.schemas.actions import DeploymentScheduleCreate, DeploymentUpdate
@@ -154,6 +163,13 @@ class RunnerDeployment(BaseModel):
     version: Optional[str] = Field(
         default=None, description="An optional version for the deployment."
     )
+    version_type: Optional[VersionType] = Field(
+        default=None,
+        description=(
+            "The type of version information to use for the deployment. The version type"
+            " will be inferred if not provided."
+        ),
+    )
     tags: ListOfNonEmptyStrings = Field(
         default_factory=list,
         description="One of more tags to apply to this deployment.",
@@ -219,6 +235,7 @@ class RunnerDeployment(BaseModel):
             " a built runner."
         ),
     )
+
     # (Experimental) SLA configuration for the deployment. May be removed or modified at any time. Currently only supported on Prefect Cloud.
     _sla: Optional[Union[SlaTypes, list[SlaTypes]]] = PrivateAttr(
         default=None,
@@ -232,6 +249,9 @@ class RunnerDeployment(BaseModel):
     _parameter_openapi_schema: ParameterSchema = PrivateAttr(
         default_factory=ParameterSchema,
     )
+    _version_from_flow: bool = PrivateAttr(
+        default=False,
+    )
 
     @property
     def entrypoint_type(self) -> EntrypointType:
@@ -241,6 +261,20 @@ class RunnerDeployment(BaseModel):
     def full_name(self) -> str:
         return f"{self.flow_name}/{self.name}"
 
+    def _get_deployment_version_info(
+        self, version_type: Optional[VersionType] = None
+    ) -> VersionInfo:
+        if inferred_version := run_coro_as_sync(
+            get_inferred_version_info(version_type)
+        ):
+            if not self.version or self._version_from_flow:
+                self.version = inferred_version.version  # TODO: maybe reconsider
+
+            inferred_version.version = self.version
+            return inferred_version
+
+        return VersionInfo(version=self.version or "", type="prefect:simple")
+
     @field_validator("name", mode="before")
     @classmethod
     def validate_name(cls, value: str) -> str:
@@ -387,7 +421,7 @@ class RunnerDeployment(BaseModel):
         update_payload = self.model_dump(
             mode="json",
             exclude_unset=True,
-            exclude={"storage", "name", "flow_name", "triggers"},
+            exclude={"storage", "name", "flow_name", "triggers", "version_type"},
         )
 
         if self.storage:
@@ -444,7 +478,7 @@ class RunnerDeployment(BaseModel):
         self,
         work_pool_name: Optional[str] = None,
         image: Optional[str] = None,
-        version_info: VersionInfo | None = None,
+        version_info: Optional[VersionInfo] = None,
     ) -> UUID:
         """
         Registers this deployment with the API and returns the deployment's ID.
@@ -455,11 +489,15 @@ class RunnerDeployment(BaseModel):
             image: The registry, name, and tag of the Docker image to
                 use for this deployment. Only used when the deployment is
                 deployed to a work pool.
-            version_info: Version information for the deployment.
+            version_info: The version information to use for the deployment.
         Returns:
             The ID of the created deployment.
         """
 
+        version_info = version_info or self._get_deployment_version_info(
+            self.version_type
+        )
+
         async with get_client() as client:
             try:
                 deployment = await client.read_deployment_by_name(self.full_name)
@@ -570,6 +608,7 @@ class RunnerDeployment(BaseModel):
 
         if not self.version:
             self.version = flow.version
+            self._version_from_flow = True
         if not self.description:
             self.description = flow.description
 
@@ -592,6 +631,7 @@ class RunnerDeployment(BaseModel):
         description: Optional[str] = None,
         tags: Optional[List[str]] = None,
         version: Optional[str] = None,
+        version_type: Optional[VersionType] = None,
         enforce_parameter_schema: bool = True,
         work_pool_name: Optional[str] = None,
         work_queue_name: Optional[str] = None,
@@ -622,6 +662,7 @@ class RunnerDeployment(BaseModel):
             tags: A list of tags to associate with the created deployment for organizational
                 purposes.
             version: A version for the created deployment. Defaults to the flow's version.
+            version_type: The type of version information to use for the deployment.
             enforce_parameter_schema: Whether or not the Prefect API should enforce the
                 parameter schema for this deployment.
             work_pool_name: The name of the work pool to use for this deployment.
@@ -662,6 +703,7 @@ class RunnerDeployment(BaseModel):
             parameters=parameters or {},
             description=description,
             version=version,
+            version_type=version_type,
             enforce_parameter_schema=enforce_parameter_schema,
             work_pool_name=work_pool_name,
             work_queue_name=work_queue_name,
@@ -837,6 +879,7 @@ class RunnerDeployment(BaseModel):
         description: Optional[str] = None,
         tags: Optional[List[str]] = None,
         version: Optional[str] = None,
+        version_type: Optional[VersionType] = None,
         enforce_parameter_schema: bool = True,
         work_pool_name: Optional[str] = None,
         work_queue_name: Optional[str] = None,
@@ -870,6 +913,8 @@ class RunnerDeployment(BaseModel):
             tags: A list of tags to associate with the created deployment for organizational
                 purposes.
             version: A version for the created deployment. Defaults to the flow's version.
+            version_type: The type of version information to use for the deployment. The version type
+                will be inferred if not provided.
             enforce_parameter_schema: Whether or not the Prefect API should enforce the
                 parameter schema for this deployment.
             work_pool_name: The name of the work pool to use for this deployment.
@@ -921,6 +966,7 @@ class RunnerDeployment(BaseModel):
             parameters=parameters or {},
             description=description,
             version=version,
+            version_type=version_type,
             entrypoint=entrypoint,
             enforce_parameter_schema=enforce_parameter_schema,
             storage=storage,
@@ -959,6 +1005,7 @@ class RunnerDeployment(BaseModel):
         description: Optional[str] = None,
         tags: Optional[List[str]] = None,
         version: Optional[str] = None,
+        version_type: Optional[VersionType] = None,
         enforce_parameter_schema: bool = True,
         work_pool_name: Optional[str] = None,
         work_queue_name: Optional[str] = None,
@@ -992,6 +1039,8 @@ class RunnerDeployment(BaseModel):
             tags: A list of tags to associate with the created deployment for organizational
                 purposes.
             version: A version for the created deployment. Defaults to the flow's version.
+            version_type: The type of version information to use for the deployment. The version type
+                will be inferred if not provided.
             enforce_parameter_schema: Whether or not the Prefect API should enforce the
                 parameter schema for this deployment.
             work_pool_name: The name of the work pool to use for this deployment.
@@ -1041,6 +1090,7 @@ class RunnerDeployment(BaseModel):
             parameters=parameters or {},
             description=description,
             version=version,
+            version_type=version_type,
             entrypoint=entrypoint,
             enforce_parameter_schema=enforce_parameter_schema,
             storage=storage,

{prefect_client-3.3.8.dev4 → prefect_client-3.4.1.dev1}/src/prefect/events/clients.py

@@ -684,8 +684,8 @@ class PrefectEventSubscriber:
 
     async def __aexit__(
         self,
-        exc_type: Optional[Type[Exception]],
-        exc_val: Optional[Exception],
+        exc_type: Optional[Type[BaseException]],
+        exc_val: Optional[BaseException],
         exc_tb: Optional[TracebackType],
     ) -> None:
         self._websocket = None

{prefect_client-3.3.8.dev4 → prefect_client-3.4.1.dev1}/src/prefect/flows.py

@@ -49,6 +49,7 @@ from typing_extensions import Literal, ParamSpec
 
 from prefect._experimental.sla.objects import SlaTypes
 from prefect._internal.concurrency.api import create_call, from_async
+from prefect._versioning import VersionType
 from prefect.blocks.core import Block
 from prefect.client.schemas.filters import WorkerFilter, WorkerFilterStatus
 from prefect.client.schemas.objects import ConcurrencyLimitConfig, FlowRun
@@ -704,6 +705,7 @@ class Flow(Generic[P, R]):
         description: Optional[str] = None,
         tags: Optional[list[str]] = None,
         version: Optional[str] = None,
+        version_type: Optional[VersionType] = None,
         enforce_parameter_schema: bool = True,
         work_pool_name: Optional[str] = None,
         work_queue_name: Optional[str] = None,
@@ -733,6 +735,8 @@ class Flow(Generic[P, R]):
             tags: A list of tags to associate with the created deployment for organizational
                 purposes.
             version: A version for the created deployment. Defaults to the flow's version.
+            version_type: The type of version to use for the created deployment. The version type
+                will be inferred if not provided.
             enforce_parameter_schema: Whether or not the Prefect API should enforce the
                 parameter schema for the created deployment.
             work_pool_name: The name of the work pool to use for this deployment.
@@ -787,6 +791,7 @@ class Flow(Generic[P, R]):
                 parameters=parameters or {},
                 description=description,
                 version=version,
+                version_type=version_type,
                 enforce_parameter_schema=enforce_parameter_schema,
                 work_pool_name=work_pool_name,
                 work_queue_name=work_queue_name,
@@ -809,6 +814,7 @@ class Flow(Generic[P, R]):
                 parameters=parameters or {},
                 description=description,
                 version=version,
+                version_type=version_type,
                 enforce_parameter_schema=enforce_parameter_schema,
                 work_pool_name=work_pool_name,
                 work_queue_name=work_queue_name,
@@ -840,6 +846,7 @@ class Flow(Generic[P, R]):
         description: Optional[str] = None,
         tags: Optional[list[str]] = None,
         version: Optional[str] = None,
+        version_type: Optional[VersionType] = None,
         enforce_parameter_schema: bool = True,
         work_pool_name: Optional[str] = None,
         work_queue_name: Optional[str] = None,
@@ -869,6 +876,8 @@ class Flow(Generic[P, R]):
             tags: A list of tags to associate with the created deployment for organizational
                 purposes.
             version: A version for the created deployment. Defaults to the flow's version.
+            version_type: The type of version to use for the created deployment. The version type
+                will be inferred if not provided.
             enforce_parameter_schema: Whether or not the Prefect API should enforce the
                 parameter schema for the created deployment.
             work_pool_name: The name of the work pool to use for this deployment.
@@ -925,6 +934,7 @@ class Flow(Generic[P, R]):
                     parameters=parameters or {},
                     description=description,
                     version=version,
+                    version_type=version_type,
                     enforce_parameter_schema=enforce_parameter_schema,
                     work_pool_name=work_pool_name,
                     work_queue_name=work_queue_name,
@@ -949,6 +959,7 @@ class Flow(Generic[P, R]):
                 parameters=parameters or {},
                 description=description,
                 version=version,
+                version_type=version_type,
                 enforce_parameter_schema=enforce_parameter_schema,
                 work_pool_name=work_pool_name,
                 work_queue_name=work_queue_name,
@@ -1375,6 +1386,7 @@ class Flow(Generic[P, R]):
         description: Optional[str] = None,
         tags: Optional[list[str]] = None,
         version: Optional[str] = None,
+        version_type: Optional[VersionType] = None,
         enforce_parameter_schema: bool = True,
         entrypoint_type: EntrypointType = EntrypointType.FILE_PATH,
         print_next_steps: bool = True,
@@ -1426,6 +1438,8 @@ class Flow(Generic[P, R]):
             tags: A list of tags to associate with the created deployment for organizational
                 purposes.
             version: A version for the created deployment. Defaults to the flow's version.
+            version_type: The type of version to use for the created deployment. The version type
+                will be inferred if not provided.
             enforce_parameter_schema: Whether or not the Prefect API should enforce the
                 parameter schema for the created deployment.
             entrypoint_type: Type of entrypoint to use for the deployment. When using a module path
@@ -1510,6 +1524,7 @@ class Flow(Generic[P, R]):
             description=description,
             tags=tags,
             version=version,
+            version_type=version_type,
             enforce_parameter_schema=enforce_parameter_schema,
             work_queue_name=work_queue_name,
             job_variables=job_variables,

{prefect_client-3.3.8.dev4 → prefect_client-3.4.1.dev1}/src/prefect/infrastructure/provisioners/cloud_run.py

@@ -133,6 +133,7 @@ class CloudRunPushProvisioner:
             await self._run_command(
                 f"gcloud iam service-accounts create {self._service_account_name}"
                 ' --display-name "Prefect Cloud Run Service Account"'
+                f" --project={self._project}"
             )
         except subprocess.CalledProcessError as e:
             if "already exists" not in e.output.decode("utf-8"):

prefect_client-3.4.1.dev1/src/prefect/runner/_observers.py

@@ -0,0 +1,60 @@
+import asyncio
+import uuid
+from contextlib import AsyncExitStack
+from typing import Any, Protocol
+
+from prefect.events.clients import PrefectEventSubscriber, get_events_subscriber
+from prefect.events.filters import EventFilter, EventNameFilter
+from prefect.logging.loggers import get_logger
+
+
+class OnCancellingCallback(Protocol):
+    def __call__(self, flow_run_id: uuid.UUID) -> None: ...
+
+
+class FlowRunCancellingObserver:
+    def __init__(self, on_cancelling: OnCancellingCallback):
+        self.logger = get_logger("FlowRunCancellingObserver")
+        self.on_cancelling = on_cancelling
+        self._events_subscriber: PrefectEventSubscriber | None
+        self._exit_stack = AsyncExitStack()
+
+    async def _consume_events(self):
+        if self._events_subscriber is None:
+            raise RuntimeError(
+                "Events subscriber not initialized. Please use `async with` to initialize the observer."
+            )
+        async for event in self._events_subscriber:
+            try:
+                flow_run_id = uuid.UUID(
+                    event.resource["prefect.resource.id"].replace(
+                        "prefect.flow-run.", ""
+                    )
+                )
+                self.on_cancelling(flow_run_id)
+            except ValueError:
+                self.logger.debug(
+                    "Received event with invalid flow run ID: %s",
+                    event.resource["prefect.resource.id"],
+                )
+
+    async def __aenter__(self):
+        self._events_subscriber = await self._exit_stack.enter_async_context(
+            get_events_subscriber(
+                filter=EventFilter(
+                    event=EventNameFilter(name=["prefect.flow-run.Cancelling"])
+                )
+            )
+        )
+        self._consumer_task = asyncio.create_task(self._consume_events())
+        return self
+
+    async def __aexit__(self, *exc_info: Any):
+        await self._exit_stack.__aexit__(*exc_info)
+        self._consumer_task.cancel()
+        try:
+            await self._consumer_task
+        except asyncio.CancelledError:
+            pass
+        except Exception:
+            self.logger.exception("Error consuming events")