prefect-client 2.20.2__py3-none-any.whl → 3.0.0__py3-none-any.whl

prefect/artifacts.py

@@ -6,20 +6,27 @@ from __future__ import annotations
 
 import json  # noqa: I001
 import math
-from typing import Any, Dict, List, Optional, Tuple, Union
+import warnings
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
 from uuid import UUID
 
-from typing_extensions import Self
-
-from prefect.client.orchestration import PrefectClient
 from prefect.client.schemas.actions import ArtifactCreate as ArtifactRequest
+from prefect.client.schemas.actions import ArtifactUpdate
 from prefect.client.schemas.filters import ArtifactFilter, ArtifactFilterKey
-from prefect.client.schemas.objects import Artifact as ArtifactResponse
 from prefect.client.schemas.sorting import ArtifactSort
 from prefect.client.utilities import get_or_create_client, inject_client
+from prefect.logging.loggers import get_logger
 from prefect.utilities.asyncutils import sync_compatible
 from prefect.utilities.context import get_task_and_flow_run_ids
 
+logger = get_logger("artifacts")
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+    from prefect.client.orchestration import PrefectClient
+    from prefect.client.schemas.objects import Artifact as ArtifactResponse
+
 
 class Artifact(ArtifactRequest):
     """
@@ -36,9 +43,9 @@ class Artifact(ArtifactRequest):
 
     @sync_compatible
     async def create(
-        self: Self,
-        client: Optional[PrefectClient] = None,
-    ) -> ArtifactResponse:
+        self: "Self",
+        client: Optional["PrefectClient"] = None,
+    ) -> "ArtifactResponse":
         """
         A method to create an artifact.
 
@@ -48,8 +55,19 @@ class Artifact(ArtifactRequest):
         Returns:
             - The created artifact.
         """
+        from prefect.context import MissingContextError, get_run_context
+
         client, _ = get_or_create_client(client)
         task_run_id, flow_run_id = get_task_and_flow_run_ids()
+
+        try:
+            get_run_context()
+        except MissingContextError:
+            warnings.warn(
+                "Artifact creation outside of a flow or task run is deprecated and will be removed in a later version.",
+                FutureWarning,
+            )
+
         return await client.create_artifact(
             artifact=ArtifactRequest(
                 type=self.type,
@@ -64,8 +82,8 @@ class Artifact(ArtifactRequest):
     @classmethod
     @sync_compatible
     async def get(
-        cls, key: Optional[str] = None, client: Optional[PrefectClient] = None
-    ) -> Optional[ArtifactResponse]:
+        cls, key: Optional[str] = None, client: Optional["PrefectClient"] = None
+    ) -> Optional["ArtifactResponse"]:
         """
         A method to get an artifact.
 
@@ -95,9 +113,9 @@ class Artifact(ArtifactRequest):
         key: Optional[str] = None,
         description: Optional[str] = None,
         data: Optional[Union[Dict[str, Any], Any]] = None,
-        client: Optional[PrefectClient] = None,
+        client: Optional["PrefectClient"] = None,
         **kwargs: Any,
-    ) -> Tuple[ArtifactResponse, bool]:
+    ) -> Tuple["ArtifactResponse", bool]:
         """
         A method to get or create an artifact.
 
@@ -171,13 +189,54 @@ class TableArtifact(Artifact):
         return json.dumps(self._sanitize(self.table))
 
 
+class ProgressArtifact(Artifact):
+    progress: float
+    type: Optional[str] = "progress"
+
+    async def format(self) -> float:
+        # Ensure progress is between 0 and 100
+        min_progress = 0.0
+        max_progress = 100.0
+        if self.progress < min_progress or self.progress > max_progress:
+            logger.warning(
+                f"ProgressArtifact received an invalid value, Progress: {self.progress}%"
+            )
+            self.progress = max(min_progress, min(self.progress, max_progress))
+            logger.warning(f"Interpreting as {self.progress}% progress")
+
+        return self.progress
+
+
+class ImageArtifact(Artifact):
+    """
+    An artifact that will display an image from a publicly accessible URL in the UI.
+
+    Arguments:
+        image_url: The URL of the image to display.
+    """
+
+    image_url: str
+    type: Optional[str] = "image"
+
+    async def format(self) -> str:
+        """
+        This method is used to format the artifact data so it can be properly sent
+        to the API when the .create() method is called. It is async because the
+        method is awaited in the parent class.
+
+        Returns:
+            str: The image URL.
+        """
+        return self.image_url
+
+
 @inject_client
 async def _create_artifact(
     type: str,
     key: Optional[str] = None,
     description: Optional[str] = None,
     data: Optional[Union[Dict[str, Any], Any]] = None,
-    client: Optional[PrefectClient] = None,
+    client: Optional["PrefectClient"] = None,
 ) -> UUID:
     """
     Helper function to create an artifact.
@@ -210,7 +269,7 @@ async def create_link_artifact(
     link_text: Optional[str] = None,
     key: Optional[str] = None,
     description: Optional[str] = None,
-    client: Optional[PrefectClient] = None,
+    client: Optional["PrefectClient"] = None,
 ) -> UUID:
     """
     Create a link artifact.
@@ -292,3 +351,103 @@ async def create_table_artifact(
     ).create()
 
     return artifact.id
+
+
+@sync_compatible
+async def create_progress_artifact(
+    progress: float,
+    key: Optional[str] = None,
+    description: Optional[str] = None,
+) -> UUID:
+    """
+    Create a progress artifact.
+
+    Arguments:
+        progress: The percentage of progress represented by a float between 0 and 100.
+        key: A user-provided string identifier.
+          Required for the artifact to show in the Artifacts page in the UI.
+          The key must only contain lowercase letters, numbers, and dashes.
+        description: A user-specified description of the artifact.
+
+    Returns:
+        The progress artifact ID.
+    """
+
+    artifact = await ProgressArtifact(
+        key=key,
+        description=description,
+        progress=progress,
+    ).create()
+
+    return artifact.id
+
+
+@sync_compatible
+async def update_progress_artifact(
+    artifact_id: UUID,
+    progress: float,
+    description: Optional[str] = None,
+    client: Optional[PrefectClient] = None,
+) -> UUID:
+    """
+    Update a progress artifact.
+
+    Arguments:
+        artifact_id: The ID of the artifact to update.
+        progress: The percentage of progress represented by a float between 0 and 100.
+        description: A user-specified description of the artifact.
+
+    Returns:
+        The progress artifact ID.
+    """
+
+    client, _ = get_or_create_client(client)
+
+    artifact = ProgressArtifact(
+        description=description,
+        progress=progress,
+    )
+    update = (
+        ArtifactUpdate(
+            description=artifact.description,
+            data=await artifact.format(),
+        )
+        if description
+        else ArtifactUpdate(data=await artifact.format())
+    )
+
+    await client.update_artifact(
+        artifact_id=artifact_id,
+        artifact=update,
+    )
+
+    return artifact_id
+
+
+@sync_compatible
+async def create_image_artifact(
+    image_url: str,
+    key: Optional[str] = None,
+    description: Optional[str] = None,
+) -> UUID:
+    """
+    Create an image artifact.
+
+    Arguments:
+        image_url: The URL of the image to display.
+        key: A user-provided string identifier.
+          Required for the artifact to show in the Artifacts page in the UI.
+          The key must only contain lowercase letters, numbers, and dashes.
+        description: A user-specified description of the artifact.
+
+    Returns:
+        The image artifact ID.
+    """
+
+    artifact = await ImageArtifact(
+        key=key,
+        description=description,
+        image_url=image_url,
+    ).create()
+
+    return artifact.id

prefect/automations.py

@@ -5,6 +5,24 @@ from pydantic import Field
 from typing_extensions import Self
 
 from prefect.client.utilities import get_or_create_client
+from prefect.events.actions import (
+    CallWebhook,
+    CancelFlowRun,
+    ChangeFlowRunState,
+    DeclareIncident,
+    DoNothing,
+    PauseAutomation,
+    PauseDeployment,
+    PauseWorkPool,
+    PauseWorkQueue,
+    ResumeAutomation,
+    ResumeDeployment,
+    ResumeWorkPool,
+    ResumeWorkQueue,
+    RunDeployment,
+    SendNotification,
+    SuspendFlowRun,
+)
 from prefect.events.schemas.automations import (
     AutomationCore,
     CompositeTrigger,
@@ -37,6 +55,23 @@ __all__ = [
     "SequenceTrigger",
     "CompoundTrigger",
     "MetricTriggerQuery",
+    # action types
+    "DoNothing",
+    "RunDeployment",
+    "PauseDeployment",
+    "ResumeDeployment",
+    "CancelFlowRun",
+    "ChangeFlowRunState",
+    "PauseWorkQueue",
+    "ResumeWorkQueue",
+    "SendNotification",
+    "CallWebhook",
+    "PauseAutomation",
+    "ResumeAutomation",
+    "SuspendFlowRun",
+    "PauseWorkPool",
+    "ResumeWorkPool",
+    "DeclareIncident",
 ]
 
 
@@ -65,7 +100,7 @@ class Automation(AutomationCore):
         created_automation = auto_to_create.create()
         """
         client, _ = get_or_create_client()
-        automation = AutomationCore(**self.dict(exclude={"id"}))
+        automation = AutomationCore(**self.model_dump(exclude={"id"}))
         self.id = await client.create_automation(automation=automation)
         return self
 
@@ -79,7 +114,7 @@ class Automation(AutomationCore):
         """
 
         client, _ = get_or_create_client()
-        automation = AutomationCore(**self.dict(exclude={"id", "owner_resource"}))
+        automation = AutomationCore(**self.model_dump(exclude={"id", "owner_resource"}))
         await client.update_automation(automation_id=self.id, automation=automation)
 
     @classmethod
@@ -106,11 +141,11 @@ class Automation(AutomationCore):
             except PrefectHTTPStatusError as exc:
                 if exc.response.status_code == 404:
                     raise ValueError(f"Automation with ID {id!r} not found")
-            return Automation(**automation.dict())
+            return Automation(**automation.model_dump())
         else:
             automation = await client.read_automations_by_name(name=name)
             if len(automation) > 0:
-                return Automation(**automation[0].dict()) if automation else None
+                return Automation(**automation[0].model_dump()) if automation else None
             else:
                 raise ValueError(f"Automation with name {name!r} not found")
 

prefect/blocks/abstract.py

@@ -73,7 +73,7 @@ class NotificationBlock(Block, ABC):
     """
 
     _block_schema_capabilities = ["notify"]
-    _events_excluded_methods = Block._events_excluded_methods + ["notify"]
+    _events_excluded_methods = Block._events_excluded_methods.default + ["notify"]
 
     @property
     def logger(self) -> Logger: