prefect-client 3.0.4__tar.gz → 3.0.6__tar.gz

{prefect-client-3.0.4/src/prefect_client.egg-info → prefect-client-3.0.6}/PKG-INFO

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

{prefect-client-3.0.4 → prefect-client-3.0.6}/setup.cfg

@@ -14,6 +14,7 @@ markers =
 	clear_db: marker to clear the database after test completion
 env = 
 	PREFECT_TEST_MODE = 1
+	PREFECT_UNIT_TEST_MODE = 1
 	PREFECT_LOGGING_SERVER_LEVEL = DEBUG
 asyncio_mode = auto
 asyncio_default_fixture_loop_scope = session
@@ -56,7 +57,7 @@ ignore_missing_imports = True
 
 [versioneer]
 VCS = git
-style = pep440
+style = pep440-pre
 versionfile_source = src/prefect/_version.py
 versionfile_build = prefect/_version.py
 version_regex = ^(\d+\.\d+\.\d+(?:[a-zA-Z0-9]+(?:\.[a-zA-Z0-9]+)*)?)$

{prefect-client-3.0.4 → prefect-client-3.0.6}/setup.py

@@ -3,10 +3,6 @@ from setuptools import find_packages, setup
 
 install_requires = open("requirements-client.txt").read().strip().split("\n")
 
-# grab and use the first three version digits (the generated tag)
-_version = versioneer.get_version().split(".")
-client_version = ".".join(_version[:3]).split("+")[0]
-
 setup(
     # Package metadata
     name="prefect-client",
@@ -23,7 +19,8 @@ setup(
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     # Versioning
-    version=client_version,
+    version=versioneer.get_version(),
+    cmdclass=versioneer.get_cmdclass(),
     # Package setup
     packages=find_packages(where="src"),
     package_dir={"": "src"},

prefect-client-3.0.6/src/prefect/_version.py

@@ -0,0 +1,21 @@
+
+# This file was generated by 'versioneer.py' (0.29) from
+# revision-control system data, or from the parent directory name of an
+# unpacked source archive. Distribution tarballs contain a pre-generated copy
+# of this file.
+
+import json
+
+version_json = '''
+{
+ "date": "2024-10-09T14:11:05-0400",
+ "dirty": true,
+ "error": null,
+ "full-revisionid": "aa5171d6067327a5390b820f414341b0a25df7e8",
+ "version": "3.0.6"
+}
+'''  # END VERSION_JSON
+
+
+def get_versions():
+    return json.loads(version_json)

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/cache_policies.py

@@ -219,7 +219,7 @@ class TaskSource(CachePolicy):
         except TypeError:
             lines = inspect.getsource(task_ctx.task.fn.__class__)
         except OSError as exc:
-            if "could not get source code" in str(exc):
+            if "source code" in str(exc):
                 lines = task_ctx.task.fn.__code__.co_code
             else:
                 raise

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/client/orchestration.py

@@ -1813,7 +1813,35 @@ class PrefectClient:
             response = await self._client.get(f"/deployments/name/{name}")
         except httpx.HTTPStatusError as e:
             if e.response.status_code == status.HTTP_404_NOT_FOUND:
-                raise prefect.exceptions.ObjectNotFound(http_exc=e) from e
+                from prefect.utilities.text import fuzzy_match_string
+
+                deployments = await self.read_deployments()
+                flow_name_map = {
+                    flow.id: flow.name
+                    for flow in await asyncio.gather(
+                        *[
+                            self.read_flow(flow_id)
+                            for flow_id in {d.flow_id for d in deployments}
+                        ]
+                    )
+                }
+
+                raise prefect.exceptions.ObjectNotFound(
+                    http_exc=e,
+                    help_message=(
+                        f"Deployment {name!r} not found; did you mean {fuzzy_match!r}?"
+                        if (
+                            fuzzy_match := fuzzy_match_string(
+                                name,
+                                [
+                                    f"{flow_name_map[d.flow_id]}/{d.name}"
+                                    for d in deployments
+                                ],
+                            )
+                        )
+                        else f"Deployment {name!r} not found. Try `prefect deployment ls` to find available deployments."
+                    ),
+                ) from e
             else:
                 raise
 
@@ -2543,7 +2571,7 @@ class PrefectClient:
 
     async def read_logs(
         self,
-        log_filter: LogFilter = None,
+        log_filter: Optional[LogFilter] = None,
         limit: Optional[int] = None,
         offset: Optional[int] = None,
         sort: LogSort = LogSort.TIMESTAMP_ASC,

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/client/schemas/objects.py

@@ -327,7 +327,11 @@ class State(ObjectBaseModel, Generic[R]):
         results should be sent to the API. Other data is only available locally.
         """
         from prefect.client.schemas.actions import StateCreate
-        from prefect.results import BaseResult, ResultRecord, should_persist_result
+        from prefect.results import (
+            BaseResult,
+            ResultRecord,
+            should_persist_result,
+        )
 
         if isinstance(self.data, BaseResult):
             data = self.data

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/context.py

@@ -11,7 +11,6 @@ import sys
 import warnings
 from contextlib import ExitStack, asynccontextmanager, contextmanager
 from contextvars import ContextVar, Token
-from pathlib import Path
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -40,7 +39,7 @@ from prefect.client.schemas import FlowRun, TaskRun
 from prefect.events.worker import EventsWorker
 from prefect.exceptions import MissingContextError
 from prefect.results import ResultStore, get_default_persist_setting
-from prefect.settings import PREFECT_HOME, Profile, Settings
+from prefect.settings import Profile, Settings
 from prefect.states import State
 from prefect.task_runners import TaskRunner
 from prefect.utilities.services import start_client_metrics_server
@@ -166,11 +165,13 @@ class ContextModel(BaseModel):
         new._token = None
         return new
 
-    def serialize(self) -> 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.
         """
-        return self.model_dump(exclude_unset=True)
+        return self.model_dump(
+            exclude_unset=True, context={"include_secrets": include_secrets}
+        )
 
 
 class SyncClientContext(ContextModel):
@@ -430,7 +431,7 @@ class TagsContext(ContextModel):
         # Return an empty `TagsContext` instead of `None` if no context exists
         return cls.__var__.get(TagsContext())
 
-    __var__ = ContextVar("tags")
+    __var__: ContextVar = ContextVar("tags")
 
 
 class SettingsContext(ContextModel):
@@ -447,7 +448,7 @@ class SettingsContext(ContextModel):
     profile: Profile
     settings: Settings
 
-    __var__ = ContextVar("settings")
+    __var__: ContextVar = ContextVar("settings")
 
     def __hash__(self) -> int:
         return hash(self.settings)
@@ -459,14 +460,11 @@ class SettingsContext(ContextModel):
         return_value = super().__enter__()
 
         try:
-            prefect_home = Path(self.settings.value_of(PREFECT_HOME))
+            prefect_home = self.settings.home
             prefect_home.mkdir(mode=0o0700, exist_ok=True)
         except OSError:
             warnings.warn(
-                (
-                    "Failed to create the Prefect home directory at "
-                    f"{self.settings.value_of(PREFECT_HOME)}"
-                ),
+                (f"Failed to create the Prefect home directory at {prefect_home}"),
                 stacklevel=2,
             )
 
@@ -609,12 +607,11 @@ def use_profile(
 
     # Create a copy of the profiles settings as we will mutate it
     profile_settings = profile.settings.copy()
-
     existing_context = SettingsContext.get()
     if existing_context and include_current_context:
         settings = existing_context.settings
     else:
-        settings = prefect.settings.get_settings_from_env()
+        settings = Settings()
 
     if not override_environment_variables:
         for key in os.environ:
@@ -662,12 +659,7 @@ def root_settings_context():
         )
         active_name = "ephemeral"
 
-    with use_profile(
-        profiles[active_name],
-        # Override environment variables if the profile was set by the CLI
-        override_environment_variables=profile_source == "by command line argument",
-    ) as settings_context:
-        return settings_context
+    return SettingsContext(profile=profiles[active_name], settings=Settings())
 
     # Note the above context is exited and the global settings context is used by
     # an override in the `SettingsContext.get` method.

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/deployments/flow_runs.py

@@ -5,10 +5,12 @@ from uuid import UUID
 import anyio
 import pendulum
 
+import prefect
 from prefect.client.schemas import FlowRun
 from prefect.client.utilities import inject_client
 from prefect.context import FlowRunContext, TaskRunContext
 from prefect.logging import get_logger
+from prefect.results import BaseResult, ResultRecordMetadata
 from prefect.states import Pending, Scheduled
 from prefect.tasks import Task
 from prefect.utilities.asyncutils import sync_compatible
@@ -18,6 +20,12 @@ if TYPE_CHECKING:
     from prefect.client.orchestration import PrefectClient
     from prefect.client.schemas.objects import FlowRun
 
+prefect.client.schemas.StateCreate.model_rebuild(
+    _types_namespace={
+        "BaseResult": BaseResult,
+        "ResultRecordMetadata": ResultRecordMetadata,
+    }
+)
 
 logger = get_logger(__name__)
 

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/exceptions.py

@@ -5,7 +5,7 @@ Prefect-specific exceptions.
 import inspect
 import traceback
 from types import ModuleType, TracebackType
-from typing import Callable, Dict, Iterable, List, Optional, Type
+from typing import Any, Callable, Dict, Iterable, List, Optional, Tuple, Type
 
 from httpx._exceptions import HTTPStatusError
 from pydantic import ValidationError
@@ -227,9 +227,19 @@ class ObjectNotFound(PrefectException):
     Raised when the client receives a 404 (not found) from the API.
     """
 
-    def __init__(self, http_exc: Exception, *args, **kwargs):
+    def __init__(
+        self,
+        http_exc: Exception,
+        help_message: Optional[str] = None,
+        *args,
+        **kwargs,
+    ):
         self.http_exc = http_exc
-        super().__init__(*args, **kwargs)
+        self.help_message = help_message
+        super().__init__(help_message, *args, **kwargs)
+
+    def __str__(self):
+        return self.help_message or super().__str__()
 
 
 class ObjectAlreadyExists(PrefectException):
@@ -424,3 +434,12 @@ class ConfigurationError(PrefectException):
     """
     Raised when a configuration is invalid.
     """
+
+
+class ProfileSettingsValidationError(PrefectException):
+    """
+    Raised when a profile settings are invalid.
+    """
+
+    def __init__(self, errors: List[Tuple[Any, ValidationError]]) -> None:
+        self.errors = errors

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/flow_engine.py

@@ -290,13 +290,16 @@ class FlowRunEngine(Generic[P, R]):
         result_store: Optional[ResultStore] = None,
     ) -> State:
         context = FlowRunContext.get()
-        terminal_state = run_coro_as_sync(
-            exception_to_failed_state(
-                exc,
-                message=msg or "Flow run encountered an exception:",
-                result_store=result_store or getattr(context, "result_store", None),
-                write_result=True,
-            )
+        terminal_state = cast(
+            State,
+            run_coro_as_sync(
+                exception_to_failed_state(
+                    exc,
+                    message=msg or "Flow run encountered an exception:",
+                    result_store=result_store or getattr(context, "result_store", None),
+                    write_result=True,
+                )
+            ),
         )
         state = self.set_state(terminal_state)
         if self.state.is_scheduled():

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/flows.py

@@ -593,7 +593,7 @@ class Flow(Generic[P, R]):
         # Get the updated parameter dict with cast values from the model
         cast_parameters = {
             k: v
-            for k, v in dict(model).items()
+            for k, v in model.__dict__.items()
             if k in model.model_fields_set or model.model_fields[k].default_factory
         }
         return cast_parameters

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/futures.py

@@ -116,7 +116,7 @@ class PrefectWrappedFuture(PrefectFuture, abc.ABC, Generic[R, F]):
         """The underlying future object wrapped by this Prefect future"""
         return self._wrapped_future
 
-    def add_done_callback(self, fn: Callable[[PrefectFuture], None]):
+    def add_done_callback(self, fn: Callable[[PrefectFuture[R]], None]):
         if not self._final_state:
 
             def call_with_self(future):
@@ -193,7 +193,7 @@ class PrefectDistributedFuture(PrefectFuture[R]):
     any task run scheduled in Prefect's API.
     """
 
-    done_callbacks: List[Callable[[PrefectFuture], None]] = []
+    done_callbacks: List[Callable[[PrefectFuture[R]], None]] = []
     waiter = None
 
     def wait(self, timeout: Optional[float] = None) -> None:
@@ -257,7 +257,7 @@ class PrefectDistributedFuture(PrefectFuture[R]):
             raise_on_failure=raise_on_failure, fetch=True
         )
 
-    def add_done_callback(self, fn: Callable[[PrefectFuture], None]):
+    def add_done_callback(self, fn: Callable[[PrefectFuture[R]], None]):
         if self._final_state:
             fn(self)
             return
@@ -331,9 +331,9 @@ class PrefectFutureList(list, Iterator, Generic[F]):
 
 
 def as_completed(
-    futures: List[PrefectFuture], timeout: Optional[float] = None
-) -> Generator[PrefectFuture, None]:
-    unique_futures: Set[PrefectFuture] = set(futures)
+    futures: List[PrefectFuture[R]], timeout: Optional[float] = None
+) -> Generator[PrefectFuture[R], None]:
+    unique_futures: Set[PrefectFuture[R]] = set(futures)
     total_futures = len(unique_futures)
     try:
         with timeout_context(timeout):
@@ -373,7 +373,7 @@ def as_completed(
 DoneAndNotDoneFutures = collections.namedtuple("DoneAndNotDoneFutures", "done not_done")
 
 
-def wait(futures: List[PrefectFuture], timeout=None) -> DoneAndNotDoneFutures:
+def wait(futures: List[PrefectFuture[R]], timeout=None) -> DoneAndNotDoneFutures:
     """
     Wait for the futures in the given sequence to complete.
 
@@ -404,10 +404,10 @@ def wait(futures: List[PrefectFuture], timeout=None) -> DoneAndNotDoneFutures:
             print(f"Not Done: {len(not_done)}")
         ```
     """
-    futures = set(futures)
-    done = {f for f in futures if f._final_state}
-    not_done = futures - done
-    if len(done) == len(futures):
+    _futures = set(futures)
+    done = {f for f in _futures if f._final_state}
+    not_done = _futures - done
+    if len(done) == len(_futures):
         return DoneAndNotDoneFutures(done, not_done)
     try:
         with timeout_context(timeout):
@@ -422,7 +422,7 @@ def wait(futures: List[PrefectFuture], timeout=None) -> DoneAndNotDoneFutures:
 
 
 def resolve_futures_to_states(
-    expr: Union[PrefectFuture, Any],
+    expr: Union[PrefectFuture[R], Any],
 ) -> Union[State, Any]:
     """
     Given a Python built-in collection, recursively find `PrefectFutures` and build a
@@ -431,7 +431,7 @@ def resolve_futures_to_states(
 
     Unsupported object types will be returned without modification.
     """
-    futures: Set[PrefectFuture] = set()
+    futures: Set[PrefectFuture[R]] = set()
 
     def _collect_futures(futures, expr, context):
         # Expressions inside quotes should not be traversed

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/logging/configuration.py

@@ -13,7 +13,7 @@ import yaml
 from prefect.settings import (
     PREFECT_LOGGING_EXTRA_LOGGERS,
     PREFECT_LOGGING_SETTINGS_PATH,
-    SETTING_VARIABLES,
+    get_current_settings,
 )
 from prefect.utilities.collections import dict_to_flatdict, flatdict_to_dict
 
@@ -31,18 +31,14 @@ def load_logging_config(path: Path) -> dict:
     """
     Loads logging configuration from a path allowing override from the environment
     """
+    current_settings = get_current_settings()
     template = string.Template(path.read_text())
+
     with warnings.catch_warnings():
         warnings.filterwarnings("ignore", category=DeprecationWarning)
         config = yaml.safe_load(
             # Substitute settings into the template in format $SETTING / ${SETTING}
-            template.substitute(
-                {
-                    setting.name: str(setting.value())
-                    for setting in SETTING_VARIABLES.values()
-                    if setting.value() is not None
-                }
-            )
+            template.substitute(current_settings.to_environment_variables())
         )
 
     # Load overrides from the environment

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/logging/handlers.py

@@ -6,7 +6,7 @@ import traceback
 import uuid
 import warnings
 from contextlib import asynccontextmanager
-from typing import Any, Dict, List, Type, Union
+from typing import Any, Dict, List, Optional, Type, Union
 
 import pendulum
 from rich.console import Console
@@ -30,7 +30,6 @@ from prefect.settings import (
     PREFECT_LOGGING_MARKUP,
     PREFECT_LOGGING_TO_API_BATCH_INTERVAL,
     PREFECT_LOGGING_TO_API_BATCH_SIZE,
-    PREFECT_LOGGING_TO_API_ENABLED,
     PREFECT_LOGGING_TO_API_MAX_LOG_SIZE,
     PREFECT_LOGGING_TO_API_WHEN_MISSING_FLOW,
 )
@@ -134,7 +133,7 @@ class APILogHandler(logging.Handler):
         try:
             profile = prefect.context.get_settings_context()
 
-            if not PREFECT_LOGGING_TO_API_ENABLED.value_from(profile.settings):
+            if not profile.settings.logging_to_api_enabled:
                 return  # Respect the global settings toggle
             if not getattr(record, "send_to_api", True):
                 return  # Do not send records that have opted out
@@ -242,7 +241,7 @@ class PrefectConsoleHandler(logging.StreamHandler):
         self,
         stream=None,
         highlighter: Highlighter = PrefectConsoleHighlighter,
-        styles: Dict[str, str] = None,
+        styles: Optional[Dict[str, str]] = None,
         level: Union[int, str] = logging.NOTSET,
     ):
         """

{prefect-client-3.0.4 → prefect-client-3.0.6}/src/prefect/results.py

@@ -1155,7 +1155,7 @@ class BaseResult(BaseModel, abc.ABC, Generic[R]):
             try:
                 subcls = lookup_type(cls, dispatch_key=kwargs["type"])
             except KeyError as exc:
-                raise ValidationError(errors=[exc], model=cls)
+                raise ValueError(f"Invalid type: {kwargs['type']}") from exc
             return super().__new__(subcls)
         else:
             return super().__new__(cls)