prefect-client 3.1.14__py3-none-any.whl → 3.2.0__py3-none-any.whl

prefect/utilities/collections.py

@@ -253,8 +253,7 @@ def visit_collection(
     context: dict[str, VT] = ...,
     remove_annotations: bool = ...,
     _seen: Optional[set[int]] = ...,
-) -> Any:
-    ...
+) -> Any: ...
 
 
 @overload
@@ -267,8 +266,7 @@ def visit_collection(
     context: None = None,
     remove_annotations: bool = ...,
     _seen: Optional[set[int]] = ...,
-) -> Any:
-    ...
+) -> Any: ...
 
 
 @overload
@@ -281,8 +279,7 @@ def visit_collection(
     context: dict[str, VT] = ...,
     remove_annotations: bool = ...,
     _seen: Optional[set[int]] = ...,
-) -> Optional[Any]:
-    ...
+) -> Optional[Any]: ...
 
 
 @overload
@@ -295,8 +292,7 @@ def visit_collection(
     context: None = None,
     remove_annotations: bool = ...,
     _seen: Optional[set[int]] = ...,
-) -> Optional[Any]:
-    ...
+) -> Optional[Any]: ...
 
 
 @overload
@@ -309,8 +305,7 @@ def visit_collection(
     context: dict[str, VT] = ...,
     remove_annotations: bool = ...,
     _seen: Optional[set[int]] = ...,
-) -> None:
-    ...
+) -> None: ...
 
 
 def visit_collection(
@@ -545,13 +540,11 @@ def visit_collection(
 @overload
 def remove_nested_keys(
     keys_to_remove: list[HashableT], obj: NestedDict[HashableT, VT]
-) -> NestedDict[HashableT, VT]:
-    ...
+) -> NestedDict[HashableT, VT]: ...
 
 
 @overload
-def remove_nested_keys(keys_to_remove: list[HashableT], obj: Any) -> Any:
-    ...
+def remove_nested_keys(keys_to_remove: list[HashableT], obj: Any) -> Any: ...
 
 
 def remove_nested_keys(
@@ -579,13 +572,13 @@ def remove_nested_keys(
 
 
 @overload
-def distinct(iterable: Iterable[HashableT], key: None = None) -> Iterator[HashableT]:
-    ...
+def distinct(
+    iterable: Iterable[HashableT], key: None = None
+) -> Iterator[HashableT]: ...
 
 
 @overload
-def distinct(iterable: Iterable[T], key: Callable[[T], Hashable]) -> Iterator[T]:
-    ...
+def distinct(iterable: Iterable[T], key: Callable[[T], Hashable]) -> Iterator[T]: ...
 
 
 def distinct(
@@ -609,15 +602,13 @@ def distinct(
 @overload
 def get_from_dict(
     dct: NestedDict[str, VT], keys: Union[str, list[str]], default: None = None
-) -> Optional[VT]:
-    ...
+) -> Optional[VT]: ...
 
 
 @overload
 def get_from_dict(
     dct: NestedDict[str, VT], keys: Union[str, list[str]], default: R
-) -> Union[VT, R]:
-    ...
+) -> Union[VT, R]: ...
 
 
 def get_from_dict(

prefect/utilities/dispatch.py

@@ -45,15 +45,13 @@ def get_registry_for_type(cls: T) -> Optional[dict[str, T]]:
 @overload
 def get_dispatch_key(
     cls_or_instance: Any, allow_missing: Literal[False] = False
-) -> str:
-    ...
+) -> str: ...
 
 
 @overload
 def get_dispatch_key(
     cls_or_instance: Any, allow_missing: Literal[True] = ...
-) -> Optional[str]:
-    ...
+) -> Optional[str]: ...
 
 
 def get_dispatch_key(

prefect/utilities/dockerutils.py

@@ -331,7 +331,7 @@ class ImageBuilder:
     def assert_has_line(self, line: str) -> None:
         """Asserts that the given line is in the Dockerfile"""
         all_lines = "\n".join(
-            [f"  {i+1:>3}: {line}" for i, line in enumerate(self.dockerfile_lines)]
+            [f"  {i + 1:>3}: {line}" for i, line in enumerate(self.dockerfile_lines)]
         )
         message = (
             f"Expected {line!r} not found in Dockerfile.  Dockerfile:\n{all_lines}"
@@ -347,12 +347,12 @@ class ImageBuilder:
 
         surrounding_lines = "\n".join(
             [
-                f"  {i+1:>3}: {line}"
+                f"  {i + 1:>3}: {line}"
                 for i, line in enumerate(self.dockerfile_lines[i - 2 : i + 2])
             ]
         )
         message = (
-            f"Unexpected {line!r} found in Dockerfile at line {i+1}.  "
+            f"Unexpected {line!r} found in Dockerfile at line {i + 1}.  "
             f"Surrounding lines:\n{surrounding_lines}"
         )
 
@@ -368,7 +368,7 @@ class ImageBuilder:
 
         surrounding_lines = "\n".join(
             [
-                f"  {i+1:>3}: {line}"
+                f"  {i + 1:>3}: {line}"
                 for i, line in enumerate(
                     self.dockerfile_lines[second_index - 2 : first_index + 2]
                 )
@@ -377,8 +377,8 @@ class ImageBuilder:
 
         message = (
             f"Expected {first!r} to appear before {second!r} in the Dockerfile, but "
-            f"{first!r} was at line {first_index+1} and {second!r} as at line "
-            f"{second_index+1}.  Surrounding lines:\n{surrounding_lines}"
+            f"{first!r} was at line {first_index + 1} and {second!r} as at line "
+            f"{second_index + 1}.  Surrounding lines:\n{surrounding_lines}"
         )
 
         assert first_index < second_index, message

prefect/utilities/importtools.py

@@ -2,25 +2,19 @@ import ast
 import importlib
 import importlib.util
 import os
-import runpy
 import sys
 import threading
 import warnings
 from collections.abc import Iterable, Sequence
 from importlib.abc import Loader, MetaPathFinder
 from importlib.machinery import ModuleSpec
-from io import TextIOWrapper
 from logging import Logger
 from pathlib import Path
-from tempfile import NamedTemporaryFile
 from types import ModuleType
-from typing import TYPE_CHECKING, Any, Callable, NamedTuple, Optional, Union
-
-import fsspec  # type: ignore  # no typing stubs available
+from typing import TYPE_CHECKING, Any, Callable, NamedTuple, Optional
 
 from prefect.exceptions import ScriptError
 from prefect.logging.loggers import get_logger
-from prefect.utilities.filesystem import filename, is_local_path, tmpchdir
 
 logger: Logger = get_logger(__name__)
 
@@ -84,67 +78,6 @@ def from_qualified_name(name: str) -> Any:
     return getattr(module, attr_name)
 
 
-def objects_from_script(
-    path: str, text: Optional[Union[str, bytes]] = None
-) -> dict[str, Any]:
-    """
-    Run a python script and return all the global variables
-
-    Supports remote paths by copying to a local temporary file.
-
-    WARNING: The Python documentation does not recommend using runpy for this pattern.
-
-    > Furthermore, any functions and classes defined by the executed code are not
-    > guaranteed to work correctly after a runpy function has returned. If that
-    > limitation is not acceptable for a given use case, importlib is likely to be a
-    > more suitable choice than this module.
-
-    The function `load_script_as_module` uses importlib instead and should be used
-    instead for loading objects from scripts.
-
-    Args:
-        path: The path to the script to run
-        text: Optionally, the text of the script. Skips loading the contents if given.
-
-    Returns:
-        A dictionary mapping variable name to value
-
-    Raises:
-        ScriptError: if the script raises an exception during execution
-    """
-
-    def run_script(run_path: str) -> dict[str, Any]:
-        # Cast to an absolute path before changing directories to ensure relative paths
-        # are not broken
-        abs_run_path = os.path.abspath(run_path)
-        with tmpchdir(run_path):
-            try:
-                return runpy.run_path(abs_run_path)
-            except Exception as exc:
-                raise ScriptError(user_exc=exc, path=path) from exc
-
-    if text:
-        with NamedTemporaryFile(
-            mode="wt" if isinstance(text, str) else "wb",
-            prefix=f"run-{filename(path)}",
-            suffix=".py",
-        ) as tmpfile:
-            tmpfile.write(text)
-            tmpfile.flush()
-            return run_script(tmpfile.name)
-
-    else:
-        if not is_local_path(path):
-            # Remote paths need to be local to run
-            with fsspec.open(path) as f:  # type: ignore  # no typing stubs available
-                if TYPE_CHECKING:
-                    assert isinstance(f, TextIOWrapper)
-                contents = f.read()
-            return objects_from_script(path, contents)
-        else:
-            return run_script(path)
-
-
 def load_script_as_module(path: str) -> ModuleType:
     """Execute a script at the given path.
 

prefect/utilities/names.py

@@ -68,5 +68,5 @@ def obfuscate_string(s: str, show_tail: bool = False) -> str:
     # take up to 4 characters, but only after the 10th character
     suffix = s[10:][-4:]
     if suffix and show_tail:
-        result = f"{result[:-len(suffix)]}{suffix}"
+        result = f"{result[: -len(suffix)]}{suffix}"
     return result

prefect/utilities/processutils.py

@@ -256,8 +256,7 @@ async def run_process(
     task_status: anyio.abc.TaskStatus[T] = ...,
     task_status_handler: Callable[[anyio.abc.Process], T] = ...,
     **kwargs: Any,
-) -> anyio.abc.Process:
-    ...
+) -> anyio.abc.Process: ...
 
 
 @overload
@@ -270,8 +269,7 @@ async def run_process(
     task_status: Optional[anyio.abc.TaskStatus[int]] = ...,
     task_status_handler: None = None,
     **kwargs: Any,
-) -> anyio.abc.Process:
-    ...
+) -> anyio.abc.Process: ...
 
 
 @overload
@@ -284,8 +282,7 @@ async def run_process(
     task_status: Optional[anyio.abc.TaskStatus[T]] = None,
     task_status_handler: Optional[Callable[[anyio.abc.Process], T]] = None,
     **kwargs: Any,
-) -> anyio.abc.Process:
-    ...
+) -> anyio.abc.Process: ...
 
 
 async def run_process(

prefect/utilities/pydantic.py

@@ -52,15 +52,13 @@ def _unreduce_model(model_name: str, json: str) -> Any:
 
 
 @overload
-def add_cloudpickle_reduction(__model_cls: type[M]) -> type[M]:
-    ...
+def add_cloudpickle_reduction(__model_cls: type[M]) -> type[M]: ...
 
 
 @overload
 def add_cloudpickle_reduction(
     __model_cls: None = None, **kwargs: Any
-) -> Callable[[type[M]], type[M]]:
-    ...
+) -> Callable[[type[M]], type[M]]: ...
 
 
 def add_cloudpickle_reduction(
@@ -144,7 +142,7 @@ def add_type_dispatch(model_cls: type[M]) -> type[M]:
 
     elif not defines_dispatch_key and defines_type_field:
         field_type_annotation = model_cls.model_fields["type"].annotation
-        if field_type_annotation != str and field_type_annotation is not None:
+        if field_type_annotation is not str and field_type_annotation is not None:
             raise TypeError(
                 f"Model class {model_cls.__name__!r} defines a 'type' field with "
                 f"type {field_type_annotation.__name__!r} but it must be 'str'."
@@ -169,7 +167,7 @@ def add_type_dispatch(model_cls: type[M]) -> type[M]:
     def __init__(__pydantic_self__: M, **data: Any) -> None:
         type_string = (
             get_dispatch_key(__pydantic_self__)
-            if type(__pydantic_self__) != model_cls
+            if type(__pydantic_self__) is not model_cls
             else "__base__"
         )
         data.setdefault("type", type_string)

prefect/utilities/render_swagger.py

@@ -63,7 +63,7 @@ def swagger_lib(config: MkDocsConfig) -> dict[str, Any]:
     }
 
     extra_javascript = config.extra_javascript
-    extra_css = cast(list[str], config.extra_css)
+    extra_css = cast(list[str], config.extra_css)  # pyright: ignore[reportUnknownMemberType] incomplete type hint
     for lib in extra_javascript:
         if (
             os.path.basename(urllib.parse.urlparse(str(lib)).path)

prefect/utilities/schema_tools/hydration.py

@@ -8,11 +8,6 @@ from pydantic import BaseModel, Field
 from sqlalchemy.ext.asyncio import AsyncSession
 from typing_extensions import Self, TypeAlias, TypeIs
 
-from prefect.server.utilities.user_templates import (
-    TemplateSecurityError,
-    render_user_template_sync,
-    validate_user_template,
-)
 from prefect.types import StrictVariableValue
 
 
@@ -229,6 +224,12 @@ def json_handler(obj: dict[str, Any], ctx: HydrationContext):
 
 @handler("jinja")
 def jinja_handler(obj: dict[str, Any], ctx: HydrationContext) -> Any:
+    from prefect.server.utilities.user_templates import (
+        TemplateSecurityError,
+        render_user_template_sync,
+        validate_user_template,
+    )
+
     if "template" in obj:
         if isinstance(obj["template"], dict):
             dehydrated_jinja = _hydrate(obj["template"], ctx)

prefect/utilities/templating.py

@@ -4,6 +4,7 @@ import re
 from typing import (
     TYPE_CHECKING,
     Any,
+    Callable,
     Literal,
     NamedTuple,
     Optional,
@@ -92,15 +93,19 @@ def find_placeholders(template: T) -> set[Placeholder]:
 @overload
 def apply_values(
     template: T, values: dict[str, Any], remove_notset: Literal[True] = True
-) -> T:
-    ...
+) -> T: ...
 
 
 @overload
 def apply_values(
     template: T, values: dict[str, Any], remove_notset: Literal[False] = False
-) -> Union[T, type[NotSet]]:
-    ...
+) -> Union[T, type[NotSet]]: ...
+
+
+@overload
+def apply_values(
+    template: T, values: dict[str, Any], remove_notset: bool = False
+) -> Union[T, type[NotSet]]: ...
 
 
 def apply_values(
@@ -190,11 +195,13 @@ def apply_values(
 
 @inject_client
 async def resolve_block_document_references(
-    template: T, client: Optional["PrefectClient"] = None
+    template: T,
+    client: Optional["PrefectClient"] = None,
+    value_transformer: Optional[Callable[[str, Any], Any]] = None,
 ) -> Union[T, dict[str, Any]]:
     """
     Resolve block document references in a template by replacing each reference with
-    the data of the block document.
+    its value or the return value of the transformer function if provided.
 
     Recursively searches for block document references in dictionaries and lists.
 
@@ -251,6 +258,7 @@ async def resolve_block_document_references(
 
     Args:
         template: The template to resolve block documents in
+        value_transformer: A function that takes the block placeholder and the block value and returns replacement text for the template
 
     Returns:
         The template with block documents resolved
@@ -268,13 +276,15 @@ async def resolve_block_document_references(
         updated_template: dict[str, Any] = {}
         for key, value in template.items():
             updated_value = await resolve_block_document_references(
-                value, client=client
+                value, value_transformer=value_transformer, client=client
             )
             updated_template[key] = updated_value
         return updated_template
     elif isinstance(template, list):
         return [
-            await resolve_block_document_references(item, client=client)
+            await resolve_block_document_references(
+                item, value_transformer=value_transformer, client=client
+            )
             for item in template
         ]
     elif isinstance(template, str):
@@ -319,6 +329,9 @@ async def resolve_block_document_references(
                     )
                 value = from_dict
 
+            if value_transformer:
+                value = value_transformer(placeholder.full_match, value)
+
             return value
         else:
             raise ValueError(

prefect/utilities/visualization.py

@@ -42,8 +42,7 @@ def track_viz_task(
     task_name: str,
     parameters: dict[str, Any],
     viz_return_value: Optional[Any] = None,
-) -> Coroutine[Any, Any, Any]:
-    ...
+) -> Coroutine[Any, Any, Any]: ...
 
 
 @overload
@@ -52,8 +51,7 @@ def track_viz_task(
     task_name: str,
     parameters: dict[str, Any],
     viz_return_value: Optional[Any] = None,
-) -> Any:
-    ...
+) -> Any: ...
 
 
 def track_viz_task(

prefect/workers/base.py

@@ -939,9 +939,9 @@ class BaseWorker(abc.ABC, Generic[C, V, R]):
         was created from a deployment with a storage block.
         """
         if flow_run.deployment_id:
-            assert (
-                self._client and self._client._started
-            ), "Client must be started to check flow run deployment."
+            assert self._client and self._client._started, (
+                "Client must be started to check flow run deployment."
+            )
             deployment = await self._client.read_deployment(flow_run.deployment_id)
             if deployment.storage_document_id:
                 raise ValueError(

prefect/workers/block.py

@@ -1,6 +1,7 @@
 """
 2024-06-27: This surfaces an actionable error message for moved or removed objects in Prefect 3.0 upgrade.
 """
+
 from typing import Any, Callable
 
 from prefect._internal.compatibility.migration import getattr_migration

prefect/workers/cloud.py

@@ -1,6 +1,7 @@
 """
 2024-06-27: This surfaces an actionable error message for moved or removed objects in Prefect 3.0 upgrade.
 """
+
 from typing import Any, Callable
 
 from prefect._internal.compatibility.migration import getattr_migration

prefect/workers/process.py

@@ -13,6 +13,7 @@ to poll for flow runs.
 For more information about work pools and workers,
 checkout out the [Prefect docs](/concepts/work-pools/).
 """
+
 from __future__ import annotations
 
 import contextlib

{prefect_client-3.1.14.dist-info → prefect_client-3.2.0.dist-info}/METADATA

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