prefect-client 3.1.9__tar.gz → 3.1.10__tar.gz

{prefect-client-3.1.9/src/prefect_client.egg-info → prefect-client-3.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prefect-client
-Version: 3.1.9
+Version: 3.1.10
 Summary: Workflow orchestration and management.
 Home-page: https://www.prefect.io
 Author: Prefect Technologies, Inc.

{prefect-client-3.1.9 → prefect-client-3.1.10}/requirements-dev.txt

@@ -15,7 +15,7 @@ pytest-benchmark
 pytest-cov
 pytest-env
 pytest-flakefinder
-pytest-mypy-plugins >= 3.1.0
+pytest-mypy-plugins >= 3.2.0
 pytest-timeout
 pytest-xdist >= 3.6.1
 pyyaml

{prefect-client-3.1.9 → prefect-client-3.1.10}/src/prefect/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-12-20T16:33:15-0500",
+ "date": "2024-12-24T22:58:40-0800",
  "dirty": true,
  "error": null,
- "full-revisionid": "e1fe79439b319ce5478aa5f8bd4e836ed4f8a0f5",
- "version": "3.1.9"
+ "full-revisionid": "b11b56fc6143df2bd4c7018f7a974dc656fe9aa3",
+ "version": "3.1.10"
 }
 '''  # END VERSION_JSON
 

{prefect-client-3.1.9 → prefect-client-3.1.10}/src/prefect/artifacts.py

@@ -2,19 +2,20 @@
 Interface for creating and reading artifacts.
 """
 
-from __future__ import annotations
-
+import asyncio
 import json  # noqa: I001
 import math
 import warnings
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+from typing import TYPE_CHECKING, Any, Optional, Union
 from uuid import UUID
 
+from typing_extensions import Self
+
 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.sorting import ArtifactSort
-from prefect.client.utilities import get_or_create_client, inject_client
+from prefect.client.utilities import get_or_create_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
@@ -22,8 +23,6 @@ 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
 
@@ -43,7 +42,7 @@ class Artifact(ArtifactRequest):
 
     @sync_compatible
     async def create(
-        self: "Self",
+        self: Self,
         client: Optional["PrefectClient"] = None,
     ) -> "ArtifactResponse":
         """
@@ -95,16 +94,15 @@ class Artifact(ArtifactRequest):
             (ArtifactResponse, optional): The artifact (if found).
         """
         client, _ = get_or_create_client(client)
-        return next(
-            iter(
-                await client.read_artifacts(
-                    limit=1,
-                    sort=ArtifactSort.UPDATED_DESC,
-                    artifact_filter=ArtifactFilter(key=ArtifactFilterKey(any_=[key])),
-                )
+        filter_key_value = None if key is None else [key]
+        artifacts = await client.read_artifacts(
+            limit=1,
+            sort=ArtifactSort.UPDATED_DESC,
+            artifact_filter=ArtifactFilter(
+                key=ArtifactFilterKey(any_=filter_key_value)
             ),
-            None,
         )
+        return None if not artifacts else artifacts[0]
 
     @classmethod
     @sync_compatible
@@ -112,10 +110,10 @@ class Artifact(ArtifactRequest):
         cls,
         key: Optional[str] = None,
         description: Optional[str] = None,
-        data: Optional[Union[Dict[str, Any], Any]] = None,
+        data: Optional[Union[dict[str, Any], Any]] = None,
         client: Optional["PrefectClient"] = None,
         **kwargs: Any,
-    ) -> Tuple["ArtifactResponse", bool]:
+    ) -> tuple["ArtifactResponse", bool]:
         """
         A method to get or create an artifact.
 
@@ -128,18 +126,20 @@ class Artifact(ArtifactRequest):
         Returns:
             (ArtifactResponse): The artifact, either retrieved or created.
         """
-        artifact = await cls.get(key, client)
+        artifact_coro = cls.get(key, client)
+        if TYPE_CHECKING:
+            assert asyncio.iscoroutine(artifact_coro)
+        artifact = await artifact_coro
         if artifact:
             return artifact, False
-        else:
-            return (
-                await cls(key=key, description=description, data=data, **kwargs).create(
-                    client
-                ),
-                True,
-            )
 
-    async def format(self) -> Optional[Union[Dict[str, Any], Any]]:
+        new_artifact = cls(key=key, description=description, data=data, **kwargs)
+        create_coro = new_artifact.create(client)
+        if TYPE_CHECKING:
+            assert asyncio.iscoroutine(create_coro)
+        return await create_coro, True
+
+    async def format(self) -> Optional[Union[dict[str, Any], Any]]:
         return json.dumps(self.data)
 
 
@@ -165,13 +165,13 @@ class MarkdownArtifact(Artifact):
 
 
 class TableArtifact(Artifact):
-    table: Union[Dict[str, List[Any]], List[Dict[str, Any]], List[List[Any]]]
+    table: Union[dict[str, list[Any]], list[dict[str, Any]], list[list[Any]]]
     type: Optional[str] = "table"
 
     @classmethod
     def _sanitize(
-        cls, item: Union[Dict[str, Any], List[Any], float]
-    ) -> Union[Dict[str, Any], List[Any], int, float, None]:
+        cls, item: Union[dict[str, Any], list[Any], float]
+    ) -> Union[dict[str, Any], list[Any], int, float, None]:
         """
         Sanitize NaN values in a given item.
         The item can be a dict, list or float.
@@ -230,39 +230,6 @@ class ImageArtifact(Artifact):
         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,
-) -> UUID:
-    """
-    Helper function to create an artifact.
-
-    Arguments:
-        type: A string identifying the type of artifact.
-        key: A user-provided string identifier.
-          The key must only contain lowercase letters, numbers, and dashes.
-        description: A user-specified description of the artifact.
-        data: A JSON payload that allows for a result to be retrieved.
-        client: The PrefectClient
-
-    Returns:
-        - The table artifact ID.
-    """
-
-    artifact = await Artifact(
-        type=type,
-        key=key,
-        description=description,
-        data=data,
-    ).create(client)
-
-    return artifact.id
-
-
 @sync_compatible
 async def create_link_artifact(
     link: str,
@@ -286,12 +253,16 @@ async def create_link_artifact(
     Returns:
         The table artifact ID.
     """
-    artifact = await LinkArtifact(
+    new_artifact = LinkArtifact(
         key=key,
         description=description,
         link=link,
         link_text=link_text,
-    ).create(client)
+    )
+    create_coro = new_artifact.create(client)
+    if TYPE_CHECKING:
+        assert asyncio.iscoroutine(create_coro)
+    artifact = await create_coro
 
     return artifact.id
 
@@ -315,18 +286,22 @@ async def create_markdown_artifact(
     Returns:
         The table artifact ID.
     """
-    artifact = await MarkdownArtifact(
+    new_artifact = MarkdownArtifact(
         key=key,
         description=description,
         markdown=markdown,
-    ).create()
+    )
+    create_coro = new_artifact.create()
+    if TYPE_CHECKING:
+        assert asyncio.iscoroutine(create_coro)
+    artifact = await create_coro
 
     return artifact.id
 
 
 @sync_compatible
 async def create_table_artifact(
-    table: Union[Dict[str, List[Any]], List[Dict[str, Any]], List[List[Any]]],
+    table: Union[dict[str, list[Any]], list[dict[str, Any]], list[list[Any]]],
     key: Optional[str] = None,
     description: Optional[str] = None,
 ) -> UUID:
@@ -344,11 +319,15 @@ async def create_table_artifact(
         The table artifact ID.
     """
 
-    artifact = await TableArtifact(
+    new_artifact = TableArtifact(
         key=key,
         description=description,
         table=table,
-    ).create()
+    )
+    create_coro = new_artifact.create()
+    if TYPE_CHECKING:
+        assert asyncio.iscoroutine(create_coro)
+    artifact = await create_coro
 
     return artifact.id
 
@@ -373,11 +352,15 @@ async def create_progress_artifact(
         The progress artifact ID.
     """
 
-    artifact = await ProgressArtifact(
+    new_artifact = ProgressArtifact(
         key=key,
         description=description,
         progress=progress,
-    ).create()
+    )
+    create_coro = new_artifact.create()
+    if TYPE_CHECKING:
+        assert asyncio.iscoroutine(create_coro)
+    artifact = await create_coro
 
     return artifact.id
 
@@ -387,7 +370,7 @@ async def update_progress_artifact(
     artifact_id: UUID,
     progress: float,
     description: Optional[str] = None,
-    client: Optional[PrefectClient] = None,
+    client: Optional["PrefectClient"] = None,
 ) -> UUID:
     """
     Update a progress artifact.
@@ -444,10 +427,14 @@ async def create_image_artifact(
         The image artifact ID.
     """
 
-    artifact = await ImageArtifact(
+    new_artifact = ImageArtifact(
         key=key,
         description=description,
         image_url=image_url,
-    ).create()
+    )
+    create_coro = new_artifact.create()
+    if TYPE_CHECKING:
+        assert asyncio.iscoroutine(create_coro)
+    artifact = await create_coro
 
     return artifact.id

{prefect-client-3.1.9 → prefect-client-3.1.10}/src/prefect/automations.py

@@ -1,4 +1,4 @@
-from typing import Optional, Type
+from typing import TYPE_CHECKING, Optional, overload
 from uuid import UUID
 
 from pydantic import Field
@@ -112,17 +112,28 @@ class Automation(AutomationCore):
         auto.name = "new name"
         auto.update()
         """
+        assert self.id is not None
         async with get_client() as client:
             automation = AutomationCore(
                 **self.model_dump(exclude={"id", "owner_resource"})
             )
             await client.update_automation(automation_id=self.id, automation=automation)
 
+    @overload
+    @classmethod
+    async def read(cls, id: UUID, name: Optional[str] = ...) -> Self:
+        ...
+
+    @overload
+    @classmethod
+    async def read(cls, id: None = None, name: str = ...) -> Optional[Self]:
+        ...
+
     @classmethod
     @sync_compatible
     async def read(
-        cls: Type[Self], id: Optional[UUID] = None, name: Optional[str] = None
-    ) -> Self:
+        cls, id: Optional[UUID] = None, name: Optional[str] = None
+    ) -> Optional[Self]:
         """
         Read an automation by ID or name.
         automation = Automation.read(name="woodchonk")
@@ -145,13 +156,13 @@ class Automation(AutomationCore):
                     raise
                 if automation is None:
                     raise ValueError(f"Automation with ID {id!r} not found")
-                return Automation(**automation.model_dump())
+                return cls(**automation.model_dump())
             else:
+                if TYPE_CHECKING:
+                    assert name is not None
                 automation = await client.read_automations_by_name(name=name)
                 if len(automation) > 0:
-                    return (
-                        Automation(**automation[0].model_dump()) if automation else None
-                    )
+                    return cls(**automation[0].model_dump()) if automation else None
                 else:
                     raise ValueError(f"Automation with name {name!r} not found")
 
@@ -161,6 +172,9 @@ class Automation(AutomationCore):
         auto = Automation.read(id = 123)
         auto.delete()
         """
+        if self.id is None:
+            raise ValueError("Can't delete an automation without an id")
+
         async with get_client() as client:
             try:
                 await client.delete_automation(self.id)
@@ -177,6 +191,9 @@ class Automation(AutomationCore):
         auto = Automation.read(id = 123)
         auto.disable()
         """
+        if self.id is None:
+            raise ValueError("Can't disable an automation without an id")
+
         async with get_client() as client:
             try:
                 await client.pause_automation(self.id)
@@ -193,6 +210,9 @@ class Automation(AutomationCore):
         auto = Automation.read(id = 123)
         auto.enable()
         """
+        if self.id is None:
+            raise ValueError("Can't enable an automation without an id")
+
         async with get_client() as client:
             try:
                 await client.resume_automation(self.id)

{prefect-client-3.1.9 → prefect-client-3.1.10}/src/prefect/context.py

@@ -9,21 +9,10 @@ For more user-accessible information about the current run, see [`prefect.runtim
 import os
 import sys
 import warnings
+from collections.abc import AsyncGenerator, Generator, Mapping
 from contextlib import ExitStack, asynccontextmanager, contextmanager
 from contextvars import ContextVar, Token
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    AsyncGenerator,
-    Dict,
-    Generator,
-    Mapping,
-    Optional,
-    Set,
-    Type,
-    TypeVar,
-    Union,
-)
+from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union
 
 from pydantic import BaseModel, ConfigDict, Field, PrivateAttr
 from typing_extensions import Self
@@ -64,7 +53,7 @@ if TYPE_CHECKING:
 GLOBAL_SETTINGS_CONTEXT = None  # type: ignore
 
 
-def serialize_context() -> Dict[str, Any]:
+def serialize_context() -> dict[str, Any]:
     """
     Serialize the current context for use in a remote execution environment.
     """
@@ -84,7 +73,7 @@ def serialize_context() -> Dict[str, Any]:
 
 @contextmanager
 def hydrated_context(
-    serialized_context: Optional[Dict[str, Any]] = None,
+    serialized_context: Optional[dict[str, Any]] = None,
     client: Union[PrefectClient, SyncPrefectClient, None] = None,
 ):
     with ExitStack() as stack:
@@ -148,7 +137,7 @@ class ContextModel(BaseModel):
         self._token = None
 
     @classmethod
-    def get(cls: Type[Self]) -> Optional[Self]:
+    def get(cls: type[Self]) -> Optional[Self]:
         """Get the current context instance"""
         return cls.__var__.get(None)
 
@@ -173,7 +162,7 @@ class ContextModel(BaseModel):
         new._token = None
         return new
 
-    def serialize(self, include_secrets: bool = True) -> Dict[str, Any]:
+    def serialize(self, include_secrets: bool = True) -> dict[str, Any]:
         """
         Serialize the context model to a dictionary that can be pickled with cloudpickle.
         """
@@ -314,10 +303,10 @@ class RunContext(ContextModel):
         start_client_metrics_server()
 
     start_time: DateTime = Field(default_factory=lambda: DateTime.now("UTC"))
-    input_keyset: Optional[Dict[str, Dict[str, str]]] = None
+    input_keyset: Optional[dict[str, dict[str, str]]] = None
     client: Union[PrefectClient, SyncPrefectClient]
 
-    def serialize(self: Self, include_secrets: bool = True) -> Dict[str, Any]:
+    def serialize(self: Self, include_secrets: bool = True) -> dict[str, Any]:
         return self.model_dump(
             include={"start_time", "input_keyset"},
             exclude_unset=True,
@@ -344,7 +333,7 @@ class EngineContext(RunContext):
     flow_run: Optional[FlowRun] = None
     task_runner: TaskRunner[Any]
     log_prints: bool = False
-    parameters: Optional[Dict[str, Any]] = None
+    parameters: Optional[dict[str, Any]] = None
 
     # Flag signaling if the flow run context has been serialized and sent
     # to remote infrastructure.
@@ -355,10 +344,10 @@ class EngineContext(RunContext):
     persist_result: bool = Field(default_factory=get_default_persist_setting)
 
     # Counter for task calls allowing unique
-    task_run_dynamic_keys: Dict[str, Union[str, int]] = Field(default_factory=dict)
+    task_run_dynamic_keys: dict[str, Union[str, int]] = Field(default_factory=dict)
 
     # Counter for flow pauses
-    observed_flow_pauses: Dict[str, int] = Field(default_factory=dict)
+    observed_flow_pauses: dict[str, int] = Field(default_factory=dict)
 
     # Tracking for result from task runs in this flow run for dependency tracking
     # Holds the ID of the object returned by the task run and task run state
@@ -369,7 +358,7 @@ class EngineContext(RunContext):
 
     __var__: ContextVar[Self] = ContextVar("flow_run")
 
-    def serialize(self: Self, include_secrets: bool = True) -> Dict[str, Any]:
+    def serialize(self: Self, include_secrets: bool = True) -> dict[str, Any]:
         return self.model_dump(
             include={
                 "flow_run",
@@ -403,7 +392,7 @@ class TaskRunContext(RunContext):
     task: "Task[Any, Any]"
     task_run: TaskRun
     log_prints: bool = False
-    parameters: Dict[str, Any]
+    parameters: dict[str, Any]
 
     # Result handling
     result_store: ResultStore
@@ -411,7 +400,7 @@ class TaskRunContext(RunContext):
 
     __var__ = ContextVar("task_run")
 
-    def serialize(self: Self, include_secrets: bool = True) -> Dict[str, Any]:
+    def serialize(self: Self, include_secrets: bool = True) -> dict[str, Any]:
         return self.model_dump(
             include={
                 "task_run",
@@ -437,7 +426,7 @@ class TagsContext(ContextModel):
         current_tags: A set of current tags in the context
     """
 
-    current_tags: Set[str] = Field(default_factory=set)
+    current_tags: set[str] = Field(default_factory=set)
 
     @classmethod
     def get(cls) -> "TagsContext":
@@ -512,7 +501,7 @@ def get_settings_context() -> SettingsContext:
 
 
 @contextmanager
-def tags(*new_tags: str) -> Generator[Set[str], None, None]:
+def tags(*new_tags: str) -> Generator[set[str], None, None]:
     """
     Context manager to add tags to flow and task run calls.
 

{prefect-client-3.1.9 → prefect-client-3.1.10}/src/prefect/flows.py

@@ -37,7 +37,6 @@ from typing import (
 from uuid import UUID
 
 import pydantic
-from fastapi.encoders import jsonable_encoder
 from pydantic.v1 import BaseModel as V1BaseModel
 from pydantic.v1.decorator import ValidatedFunction as V1ValidatedFunction
 from pydantic.v1.errors import ConfigError  # TODO
@@ -613,6 +612,8 @@ class Flow(Generic[P, R]):
                 serialized_parameters[key] = f"<{type(value).__name__}>"
                 continue
             try:
+                from fastapi.encoders import jsonable_encoder
+
                 serialized_parameters[key] = jsonable_encoder(value)
             except (TypeError, ValueError):
                 logger.debug(