prefect-client 3.3.8.dev2__tar.gz → 3.3.8.dev3__tar.gz

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/PKG-INFO

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

prefect_client-3.3.8.dev3/src/prefect/_build_info.py

@@ -0,0 +1,5 @@
+# Generated by versioningit
+__version__ = "3.3.8.dev3"
+__build_date__ = "2025-05-01 08:08:27.350999+00:00"
+__git_commit__ = "a82ec550b356c4e857fc04fa6ec3e8adfd60daa1"
+__dirty__ = False

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/_internal/schemas/validators.py

@@ -485,25 +485,6 @@ def validate_not_negative(v: Optional[float]) -> Optional[float]:
     return v
 
 
-@overload
-def validate_message_template_variables(v: str) -> str: ...
-
-
-@overload
-def validate_message_template_variables(v: None) -> None: ...
-
-
-def validate_message_template_variables(v: Optional[str]) -> Optional[str]:
-    from prefect.client.schemas.objects import FLOW_RUN_NOTIFICATION_TEMPLATE_KWARGS
-
-    if v is not None:
-        try:
-            v.format(**{k: "test" for k in FLOW_RUN_NOTIFICATION_TEMPLATE_KWARGS})
-        except KeyError as exc:
-            raise ValueError(f"Invalid template variable provided: '{exc.args[0]}'")
-    return v
-
-
 def validate_default_queue_id_not_none(v: Optional[UUID]) -> UUID:
     if v is None:
         raise ValueError(

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/client/orchestration/__init__.py

@@ -87,8 +87,6 @@ import prefect.states
 from prefect.client.constants import SERVER_API_VERSION
 from prefect.client.schemas import FlowRun, OrchestrationResult, TaskRun
 from prefect.client.schemas.actions import (
-    FlowRunNotificationPolicyCreate,
-    FlowRunNotificationPolicyUpdate,
     TaskRunCreate,
     TaskRunUpdate,
     WorkQueueCreate,
@@ -98,14 +96,12 @@ from prefect.client.schemas.filters import (
     DeploymentFilter,
     FlowFilter,
     FlowRunFilter,
-    FlowRunNotificationPolicyFilter,
     TaskRunFilter,
     WorkQueueFilter,
     WorkQueueFilterName,
 )
 from prefect.client.schemas.objects import (
     Constant,
-    FlowRunNotificationPolicy,
     Parameter,
     TaskRunPolicy,
     TaskRunResult,
@@ -962,151 +958,6 @@ class PrefectClient(
             response.json()
         )
 
-    async def create_flow_run_notification_policy(
-        self,
-        block_document_id: UUID,
-        is_active: bool = True,
-        tags: Optional[list[str]] = None,
-        state_names: Optional[list[str]] = None,
-        message_template: Optional[str] = None,
-    ) -> UUID:
-        """
-        Create a notification policy for flow runs
-
-        Args:
-            block_document_id: The block document UUID
-            is_active: Whether the notification policy is active
-            tags: List of flow tags
-            state_names: List of state names
-            message_template: Notification message template
-        """
-        if tags is None:
-            tags = []
-        if state_names is None:
-            state_names = []
-
-        policy = FlowRunNotificationPolicyCreate(
-            block_document_id=block_document_id,
-            is_active=is_active,
-            tags=tags,
-            state_names=state_names,
-            message_template=message_template,
-        )
-        response = await self._client.post(
-            "/flow_run_notification_policies/",
-            json=policy.model_dump(mode="json"),
-        )
-
-        policy_id = response.json().get("id")
-        if not policy_id:
-            raise httpx.RequestError(f"Malformed response: {response}")
-
-        return UUID(policy_id)
-
-    async def delete_flow_run_notification_policy(
-        self,
-        id: UUID,
-    ) -> None:
-        """
-        Delete a flow run notification policy by id.
-
-        Args:
-            id: UUID of the flow run notification policy to delete.
-        Raises:
-            prefect.exceptions.ObjectNotFound: If request returns 404
-            httpx.RequestError: If requests fails
-        """
-        try:
-            await self._client.delete(f"/flow_run_notification_policies/{id}")
-        except httpx.HTTPStatusError as e:
-            if e.response.status_code == status.HTTP_404_NOT_FOUND:
-                raise prefect.exceptions.ObjectNotFound(http_exc=e) from e
-            else:
-                raise
-
-    async def update_flow_run_notification_policy(
-        self,
-        id: UUID,
-        block_document_id: Optional[UUID] = None,
-        is_active: Optional[bool] = None,
-        tags: Optional[list[str]] = None,
-        state_names: Optional[list[str]] = None,
-        message_template: Optional[str] = None,
-    ) -> None:
-        """
-        Update a notification policy for flow runs
-
-        Args:
-            id: UUID of the notification policy
-            block_document_id: The block document UUID
-            is_active: Whether the notification policy is active
-            tags: List of flow tags
-            state_names: List of state names
-            message_template: Notification message template
-        Raises:
-            prefect.exceptions.ObjectNotFound: If request returns 404
-            httpx.RequestError: If requests fails
-        """
-        params: dict[str, Any] = {}
-        if block_document_id is not None:
-            params["block_document_id"] = block_document_id
-        if is_active is not None:
-            params["is_active"] = is_active
-        if tags is not None:
-            params["tags"] = tags
-        if state_names is not None:
-            params["state_names"] = state_names
-        if message_template is not None:
-            params["message_template"] = message_template
-
-        policy = FlowRunNotificationPolicyUpdate(**params)
-
-        try:
-            await self._client.patch(
-                f"/flow_run_notification_policies/{id}",
-                json=policy.model_dump(mode="json", exclude_unset=True),
-            )
-        except httpx.HTTPStatusError as e:
-            if e.response.status_code == status.HTTP_404_NOT_FOUND:
-                raise prefect.exceptions.ObjectNotFound(http_exc=e) from e
-            else:
-                raise
-
-    async def read_flow_run_notification_policies(
-        self,
-        flow_run_notification_policy_filter: FlowRunNotificationPolicyFilter,
-        limit: Optional[int] = None,
-        offset: int = 0,
-    ) -> list[FlowRunNotificationPolicy]:
-        """
-        Query the Prefect API for flow run notification policies. Only policies matching all criteria will
-        be returned.
-
-        Args:
-            flow_run_notification_policy_filter: filter criteria for notification policies
-            limit: a limit for the notification policies query
-            offset: an offset for the notification policies query
-
-        Returns:
-            a list of FlowRunNotificationPolicy model representations
-                of the notification policies
-        """
-        body: dict[str, Any] = {
-            "flow_run_notification_policy_filter": (
-                flow_run_notification_policy_filter.model_dump(mode="json")
-                if flow_run_notification_policy_filter
-                else None
-            ),
-            "limit": limit,
-            "offset": offset,
-        }
-        response = await self._client.post(
-            "/flow_run_notification_policies/filter", json=body
-        )
-        return pydantic.TypeAdapter(list[FlowRunNotificationPolicy]).validate_python(
-            response.json()
-        )
-
     async def read_work_queues(
         self,
         work_pool_name: Optional[str] = None,

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/client/orchestration/routes.py

@@ -63,9 +63,6 @@ ServerRoutes = Literal[
     "/events/count-by/{countable}",
     "/events/filter",
     "/events/filter/next",
-    "/flow_run_notification_policies/",
-    "/flow_run_notification_policies/{id}",
-    "/flow_run_notification_policies/filter",
     "/flow_run_states/",
     "/flow_run_states/{id}",
     "/flow_runs/",

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/client/schemas/actions.py

@@ -15,7 +15,6 @@ from prefect._internal.schemas.validators import (
     validate_artifact_key,
     validate_block_document_name,
     validate_block_type_slug,
-    validate_message_template_variables,
     validate_name_present_on_nonanonymous_blocks,
     validate_schedule_max_scheduled_runs,
     validate_variable_name,
@@ -46,7 +45,7 @@ from prefect.types import (
     PositiveInteger,
     StrictVariableValue,
 )
-from prefect.utilities.collections import listrepr, visit_collection
+from prefect.utilities.collections import visit_collection
 from prefect.utilities.pydantic import get_class_fields_only
 
 if TYPE_CHECKING:
@@ -812,51 +811,6 @@ class WorkQueueUpdate(ActionBaseModel):
     )
 
 
-class FlowRunNotificationPolicyCreate(ActionBaseModel):
-    """Data used by the Prefect REST API to create a flow run notification policy."""
-
-    is_active: bool = Field(
-        default=True, description="Whether the policy is currently active"
-    )
-    state_names: list[str] = Field(
-        default=..., description="The flow run states that trigger notifications"
-    )
-    tags: list[str] = Field(
-        default=...,
-        description="The flow run tags that trigger notifications (set [] to disable)",
-    )
-    block_document_id: UUID = Field(
-        default=..., description="The block document ID used for sending notifications"
-    )
-    message_template: Optional[str] = Field(
-        default=None,
-        description=(
-            "A templatable notification message. Use {braces} to add variables."
-            " Valid variables include:"
-            f" {listrepr(sorted(objects.FLOW_RUN_NOTIFICATION_TEMPLATE_KWARGS), sep=', ')}"
-        ),
-        examples=[
-            "Flow run {flow_run_name} with id {flow_run_id} entered state"
-            " {flow_run_state_name}."
-        ],
-    )
-
-    @field_validator("message_template")
-    @classmethod
-    def validate_message_template_variables(cls, v: Optional[str]) -> Optional[str]:
-        return validate_message_template_variables(v)
-
-
-class FlowRunNotificationPolicyUpdate(ActionBaseModel):
-    """Data used by the Prefect REST API to update a flow run notification policy."""
-
-    is_active: Optional[bool] = Field(default=None)
-    state_names: Optional[list[str]] = Field(default=None)
-    tags: Optional[list[str]] = Field(default=None)
-    block_document_id: Optional[UUID] = Field(default=None)
-    message_template: Optional[str] = Field(default=None)
-
-
 class ArtifactCreate(ActionBaseModel):
     """Data used by the Prefect REST API to create an artifact."""
 

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/client/schemas/filters.py

@@ -799,26 +799,6 @@ class BlockDocumentFilter(PrefectBaseModel, OperatorMixin):
     )
 
 
-class FlowRunNotificationPolicyFilterIsActive(PrefectBaseModel):
-    """Filter by `FlowRunNotificationPolicy.is_active`."""
-
-    eq_: Optional[bool] = Field(
-        default=None,
-        description=(
-            "Filter notification policies for only those that are or are not active."
-        ),
-    )
-
-
-class FlowRunNotificationPolicyFilter(PrefectBaseModel):
-    """Filter FlowRunNotificationPolicies."""
-
-    is_active: Optional[FlowRunNotificationPolicyFilterIsActive] = Field(
-        default=FlowRunNotificationPolicyFilterIsActive(eq_=False),
-        description="Filter criteria for `FlowRunNotificationPolicy.is_active`. ",
-    )
-
-
 class WorkQueueFilterId(PrefectBaseModel):
     """Filter by `WorkQueue.id`."""
 

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/client/schemas/objects.py

@@ -45,7 +45,6 @@ from prefect._internal.schemas.validators import (
     validate_block_document_name,
     validate_default_queue_id_not_none,
     validate_max_metadata_length,
-    validate_message_template_variables,
     validate_name_present_on_nonanonymous_blocks,
     validate_not_negative,
     validate_parent_and_ref_diff,
@@ -63,7 +62,7 @@ from prefect.types import (
 )
 from prefect.types._datetime import DateTime, now
 from prefect.utilities.asyncutils import run_coro_as_sync
-from prefect.utilities.collections import AutoEnum, listrepr, visit_collection
+from prefect.utilities.collections import AutoEnum, visit_collection
 from prefect.utilities.names import generate_slug
 from prefect.utilities.pydantic import handle_secret_render
 
@@ -72,19 +71,6 @@ R = TypeVar("R", default=Any)
 
 DEFAULT_BLOCK_SCHEMA_VERSION: Literal["non-versioned"] = "non-versioned"
 DEFAULT_AGENT_WORK_POOL_NAME: Literal["default-agent-pool"] = "default-agent-pool"
-FLOW_RUN_NOTIFICATION_TEMPLATE_KWARGS: list[str] = [
-    "flow_run_notification_policy_id",
-    "flow_id",
-    "flow_name",
-    "flow_run_url",
-    "flow_run_id",
-    "flow_run_name",
-    "flow_run_parameters",
-    "flow_run_state_type",
-    "flow_run_state_name",
-    "flow_run_state_timestamp",
-    "flow_run_state_message",
-]
 
 
 class StateType(AutoEnum):
@@ -1446,41 +1432,6 @@ class WorkQueueStatusDetail(PrefectBaseModel):
     )
 
 
-class FlowRunNotificationPolicy(ObjectBaseModel):
-    """An ORM representation of a flow run notification."""
-
-    is_active: bool = Field(
-        default=True, description="Whether the policy is currently active"
-    )
-    state_names: list[str] = Field(
-        default=..., description="The flow run states that trigger notifications"
-    )
-    tags: list[str] = Field(
-        default=...,
-        description="The flow run tags that trigger notifications (set [] to disable)",
-    )
-    block_document_id: UUID = Field(
-        default=..., description="The block document ID used for sending notifications"
-    )
-    message_template: Optional[str] = Field(
-        default=None,
-        description=(
-            "A templatable notification message. Use {braces} to add variables."
-            " Valid variables include:"
-            f" {listrepr(sorted(FLOW_RUN_NOTIFICATION_TEMPLATE_KWARGS), sep=', ')}"
-        ),
-        examples=[
-            "Flow run {flow_run_name} with id {flow_run_id} entered state"
-            " {flow_run_state_name}."
-        ],
-    )
-
-    @field_validator("message_template")
-    @classmethod
-    def validate_message_template_variables(cls, v: Optional[str]) -> Optional[str]:
-        return validate_message_template_variables(v)
-
-
 class Agent(ObjectBaseModel):
     """An ORM representation of an agent"""
 

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/deployments/steps/pull.py

@@ -50,6 +50,7 @@ async def _pull_git_repository_with_retries(repo: GitRepository):
 async def agit_clone(
     repository: str,
     branch: Optional[str] = None,
+    commit_sha: Optional[str] = None,
     include_submodules: bool = False,
     access_token: Optional[str] = None,
     credentials: Optional["Block"] = None,
@@ -61,6 +62,7 @@ async def agit_clone(
     Args:
         repository: the URL of the repository to clone
         branch: the branch to clone; if not provided, the default branch will be used
+        commit_sha: the commit SHA to clone; if not provided, the default branch will be used
         include_submodules (bool): whether to include git submodules when cloning the repository
         access_token: an access token to use for cloning the repository; if not provided
             the repository will be cloned using the default git credentials
@@ -84,6 +86,7 @@ async def agit_clone(
         url=repository,
         credentials=_credentials,
         branch=branch,
+        commit_sha=commit_sha,
         include_submodules=include_submodules,
         directories=directories,
     )
@@ -97,6 +100,7 @@ async def agit_clone(
 def git_clone(
     repository: str,
     branch: Optional[str] = None,
+    commit_sha: Optional[str] = None,
     include_submodules: bool = False,
     access_token: Optional[str] = None,
     credentials: Optional["Block"] = None,
@@ -108,6 +112,7 @@ def git_clone(
     Args:
         repository: the URL of the repository to clone
         branch: the branch to clone; if not provided, the default branch will be used
+        commit_sha: the commit SHA to clone; if not provided, the default branch will be used
         include_submodules (bool): whether to include git submodules when cloning the repository
         access_token: an access token to use for cloning the repository; if not provided
             the repository will be cloned using the default git credentials
@@ -191,6 +196,7 @@ def git_clone(
         url=repository,
         credentials=_credentials,
         branch=branch,
+        commit_sha=commit_sha,
         include_submodules=include_submodules,
         directories=directories,
     )

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/runner/storage.py

@@ -119,6 +119,7 @@ class GitRepository:
         credentials: Union[GitCredentials, Block, dict[str, Any], None] = None,
         name: str | None = None,
         branch: str | None = None,
+        commit_sha: str | None = None,
         include_submodules: bool = False,
         pull_interval: int | None = 60,
         directories: list[str] | None = None,
@@ -135,8 +136,15 @@ class GitRepository:
                 "If a username is provided, an access token or password must also be"
                 " provided."
             )
+
+        if branch and commit_sha:
+            raise ValueError(
+                "Cannot provide both a branch and a commit SHA. Please provide only one."
+            )
+
         self._url = url
         self._branch = branch
+        self._commit_sha = commit_sha
         self._credentials = credentials
         self._include_submodules = include_submodules
         repo_name = urlparse(url).path.split("/")[-1].replace(".git", "")
@@ -214,7 +222,6 @@ class GitRepository:
         """
         Check if existing repo is sparsely checked out
         """
-
         try:
             result = await run_process(
                 ["git", "config", "--get", "core.sparseCheckout"], cwd=self.destination
@@ -223,6 +230,34 @@ class GitRepository:
         except Exception:
             return False
 
+    async def is_shallow_clone(self) -> bool:
+        """
+        Check if the repository is a shallow clone
+        """
+        try:
+            result = await run_process(
+                ["git", "rev-parse", "--is-shallow-repository"],
+                cwd=self.destination,
+            )
+            return result.stdout.decode().strip().lower() == "true"
+        except Exception:
+            return False
+
+    async def is_current_commit(self) -> bool:
+        """
+        Check if the current commit is the same as the commit SHA
+        """
+        if not self._commit_sha:
+            raise ValueError("No commit SHA provided")
+        try:
+            result = await run_process(
+                ["git", "rev-parse", self._commit_sha],
+                cwd=self.destination,
+            )
+            return result.stdout.decode().strip() == self._commit_sha
+        except Exception:
+            return False
+
     async def pull_code(self) -> None:
         """
         Pulls the contents of the configured repository to the local filesystem.
@@ -262,22 +297,52 @@ class GitRepository:
             cmd = ["git"]
             # Add the git configuration, must be given after `git` and before the command
             cmd += self._git_config
-            # Add the pull command and parameters
-            cmd += ["pull", "origin"]
-            if self._branch:
-                cmd += [self._branch]
-            if self._include_submodules:
-                cmd += ["--recurse-submodules"]
-            cmd += ["--depth", "1"]
-            try:
-                await run_process(cmd, cwd=self.destination)
-                self._logger.debug("Successfully pulled latest changes")
-            except subprocess.CalledProcessError as exc:
-                self._logger.error(
-                    f"Failed to pull latest changes with exit code {exc}"
+
+            # If the commit is already checked out, skip the pull
+            if self._commit_sha and await self.is_current_commit():
+                return
+
+            # If checking out a specific commit, fetch the latest changes and unshallow the repository if necessary
+            elif self._commit_sha:
+                if await self.is_shallow_clone():
+                    cmd += ["fetch", "origin", "--unshallow"]
+                else:
+                    cmd += ["fetch", "origin", self._commit_sha]
+                try:
+                    await run_process(cmd, cwd=self.destination)
+                    self._logger.debug("Successfully fetched latest changes")
+                except subprocess.CalledProcessError as exc:
+                    self._logger.error(
+                        f"Failed to fetch latest changes with exit code {exc}"
+                    )
+                    shutil.rmtree(self.destination)
+                    await self._clone_repo()
+
+                await run_process(
+                    ["git", "checkout", self._commit_sha],
+                    cwd=self.destination,
+                )
+                self._logger.debug(
+                    f"Successfully checked out commit {self._commit_sha}"
                 )
-                shutil.rmtree(self.destination)
-                await self._clone_repo()
+
+            # Otherwise, pull the latest changes from the branch
+            else:
+                cmd += ["pull", "origin"]
+                if self._branch:
+                    cmd += [self._branch]
+                if self._include_submodules:
+                    cmd += ["--recurse-submodules"]
+                cmd += ["--depth", "1"]
+                try:
+                    await run_process(cmd, cwd=self.destination)
+                    self._logger.debug("Successfully pulled latest changes")
+                except subprocess.CalledProcessError as exc:
+                    self._logger.error(
+                        f"Failed to pull latest changes with exit code {exc}"
+                    )
+                    shutil.rmtree(self.destination)
+                    await self._clone_repo()
 
         else:
             await self._clone_repo()
@@ -295,8 +360,6 @@ class GitRepository:
         # Add the clone command and its parameters
         cmd += ["clone", repository_url]
 
-        if self._branch:
-            cmd += ["--branch", self._branch]
         if self._include_submodules:
             cmd += ["--recurse-submodules"]
 
@@ -304,8 +367,18 @@ class GitRepository:
         if self._directories:
             cmd += ["--sparse"]
 
-        # Limit git history and set path to clone to
-        cmd += ["--depth", "1", str(self.destination)]
+        if self._commit_sha:
+            cmd += ["--filter=blob:none", "--no-checkout"]
+
+        else:
+            if self._branch:
+                cmd += ["--branch", self._branch]
+
+            # Limit git history
+            cmd += ["--depth", "1"]
+
+        # Set path to clone to
+        cmd += [str(self.destination)]
 
         try:
             await run_process(cmd)
@@ -317,6 +390,19 @@ class GitRepository:
                 f" {exc.returncode}."
             ) from exc_chain
 
+        if self._commit_sha:
+            # Fetch the commit
+            await run_process(
+                ["git", "fetch", "origin", self._commit_sha],
+                cwd=self.destination,
+            )
+            # Checkout the specific commit
+            await run_process(
+                ["git", "checkout", self._commit_sha],
+                cwd=self.destination,
+            )
+            self._logger.debug(f"Successfully checked out commit {self._commit_sha}")
+
         # Once repository is cloned and the repo is in sparse-checkout mode then grow the working directory
         if self._directories:
             self._logger.debug("Will add %s", self._directories)
@@ -351,6 +437,10 @@ class GitRepository:
             pull_step["prefect.deployments.steps.git_clone"]["include_submodules"] = (
                 self._include_submodules
             )
+        if self._commit_sha:
+            pull_step["prefect.deployments.steps.git_clone"]["commit_sha"] = (
+                self._commit_sha
+            )
         if isinstance(self._credentials, Block):
             pull_step["prefect.deployments.steps.git_clone"]["credentials"] = (
                 f"{{{{ {self._credentials.get_block_placeholder()} }}}}"

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/server/api/__init__.py

@@ -13,7 +13,6 @@ from . import (
     dependencies,
     deployments,
     events,
-    flow_run_notification_policies,
     flow_run_states,
     flow_runs,
     flows,

{prefect_client-3.3.8.dev2 → prefect_client-3.3.8.dev3}/src/prefect/server/api/server.py

@@ -89,7 +89,6 @@ API_ROUTERS = (
     api.task_runs.router,
     api.flow_run_states.router,
     api.task_run_states.router,
-    api.flow_run_notification_policies.router,
     api.deployments.router,
     api.saved_searches.router,
     api.logs.router,