prefect-client 3.0.3__py3-none-any.whl → 3.0.5__py3-none-any.whl

prefect/_internal/retries.py

@@ -2,11 +2,9 @@ import asyncio
 from functools import wraps
 from typing import Any, Callable, Tuple, Type
 
-from prefect.logging.loggers import get_logger
+from prefect._internal._logging import logger
 from prefect.utilities.math import clamped_poisson_interval
 
-logger = get_logger("retries")
-
 
 def exponential_backoff_with_jitter(
     attempt: int, base_delay: float, max_delay: float

prefect/_internal/schemas/validators.py

@@ -70,7 +70,7 @@ def validate_schema(schema: dict):
     try:
         if schema is not None:
             # Most closely matches the schemas generated by pydantic
-            jsonschema.Draft4Validator.check_schema(schema)
+            jsonschema.Draft202012Validator.check_schema(schema)
     except jsonschema.SchemaError as exc:
         raise ValueError(
             "The provided schema is not a valid json schema. Schema error:"

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/cloud.py

@@ -17,6 +17,7 @@ from prefect.client.schemas.objects import (
 from prefect.exceptions import ObjectNotFound, PrefectException
 from prefect.settings import (
     PREFECT_API_KEY,
+    PREFECT_API_URL,
     PREFECT_CLOUD_API_URL,
     PREFECT_UNIT_TEST_MODE,
 )
@@ -110,6 +111,14 @@ class CloudClient:
         )
         return workspaces
 
+    async def read_current_workspace(self) -> Workspace:
+        workspaces = await self.read_workspaces()
+        current_api_url = PREFECT_API_URL.value()
+        for workspace in workspaces:
+            if workspace.api_url() == current_api_url.rstrip("/"):
+                return workspace
+        raise ValueError("Current workspace not found")
+
     async def read_worker_metadata(self) -> Dict[str, Any]:
         response = await self.get(
             f"{self.workspace_base_url}/collections/work_pool_types"

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/schemas/objects.py

@@ -231,7 +231,9 @@ class State(ObjectBaseModel, Generic[R]):
 
         Args:
             raise_on_failure: a boolean specifying whether to raise an exception
-                if the state is of type `FAILED` and the underlying data is an exception
+                if the state is of type `FAILED` and the underlying data is an exception. When flow
+                was run in a different memory space (using `run_deployment`), this will only raise
+                if `fetch` is `True`.
             fetch: a boolean specifying whether to resolve references to persisted
                 results into data. For synchronous users, this defaults to `True`.
                 For asynchronous users, this defaults to `False` for backwards
@@ -297,6 +299,15 @@ class State(ObjectBaseModel, Generic[R]):
             >>> state = await my_flow(return_state=True)
             >>> await state.result()
             hello
+
+            Get the result with `raise_on_failure` from a flow run in a different memory space
+
+            >>> @flow
+            >>> async def my_flow():
+            >>>     raise ValueError("oh no!")
+            >>> my_flow.deploy("my_deployment/my_flow")
+            >>> flow_run = run_deployment("my_deployment/my_flow")
+            >>> await flow_run.state.result(raise_on_failure=True, fetch=True) # Raises `ValueError("oh no!")`
         """
         from prefect.states import get_state_result
 
@@ -316,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/subscriptions.py

@@ -84,13 +84,13 @@ class Subscription(Generic[S]):
             AssertionError,
             websockets.exceptions.ConnectionClosedError,
         ) as e:
-            if isinstance(e, AssertionError) or e.code == WS_1008_POLICY_VIOLATION:
+            if isinstance(e, AssertionError) or e.rcvd.code == WS_1008_POLICY_VIOLATION:
                 if isinstance(e, AssertionError):
                     reason = e.args[0]
                 elif isinstance(e, websockets.exceptions.ConnectionClosedError):
-                    reason = e.reason
+                    reason = e.rcvd.reason
 
-            if isinstance(e, AssertionError) or e.code == WS_1008_POLICY_VIOLATION:
+            if isinstance(e, AssertionError) or e.rcvd.code == WS_1008_POLICY_VIOLATION:
                 raise Exception(
                     "Unable to authenticate to the subscription. Please "
                     "ensure the provided `PREFECT_API_KEY` you are using is "

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/deployments/base.py

@@ -20,6 +20,7 @@ import yaml
 from ruamel.yaml import YAML
 
 from prefect.client.schemas.actions import DeploymentScheduleCreate
+from prefect.client.schemas.objects import ConcurrencyLimitStrategy
 from prefect.client.schemas.schedules import IntervalSchedule
 from prefect.logging import get_logger
 from prefect.settings import PREFECT_DEBUG_MODE
@@ -277,6 +278,17 @@ def _format_deployment_for_saving_to_prefect_file(
 
         deployment["schedules"] = schedules
 
+    if deployment.get("concurrency_limit"):
+        concurrency_limit = deployment["concurrency_limit"]
+        if isinstance(concurrency_limit, dict):
+            if isinstance(
+                concurrency_limit["collision_strategy"], ConcurrencyLimitStrategy
+            ):
+                concurrency_limit["collision_strategy"] = str(
+                    concurrency_limit["collision_strategy"].value
+                )
+        deployment["concurrency_limit"] = concurrency_limit
+
     return deployment
 
 

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/events/clients.py

@@ -34,6 +34,7 @@ from prefect.settings import (
     PREFECT_API_KEY,
     PREFECT_API_URL,
     PREFECT_CLOUD_API_URL,
+    PREFECT_DEBUG_MODE,
     PREFECT_SERVER_ALLOW_EPHEMERAL_MODE,
 )
 
@@ -67,6 +68,18 @@ EVENT_WEBSOCKET_CHECKPOINTS = Counter(
 logger = get_logger(__name__)
 
 
+def http_to_ws(url: str):
+    return url.replace("https://", "wss://").replace("http://", "ws://").rstrip("/")
+
+
+def events_in_socket_from_api_url(url: str):
+    return http_to_ws(url) + "/events/in"
+
+
+def events_out_socket_from_api_url(url: str):
+    return http_to_ws(url) + "/events/out"
+
+
 def get_events_client(
     reconnection_attempts: int = 10,
     checkpoint_every: int = 700,
@@ -251,12 +264,7 @@ class PrefectEventsClient(EventsClient):
                 "api_url must be provided or set in the Prefect configuration"
             )
 
-        self._events_socket_url = (
-            api_url.replace("https://", "wss://")
-            .replace("http://", "ws://")
-            .rstrip("/")
-            + "/events/in"
-        )
+        self._events_socket_url = events_in_socket_from_api_url(api_url)
         self._connect = connect(self._events_socket_url)
         self._websocket = None
         self._reconnection_attempts = reconnection_attempts
@@ -285,11 +293,26 @@ class PrefectEventsClient(EventsClient):
             self._websocket = None
             await self._connect.__aexit__(None, None, None)
 
-        self._websocket = await self._connect.__aenter__()
-
-        # make sure we have actually connected
-        pong = await self._websocket.ping()
-        await pong
+        try:
+            self._websocket = await self._connect.__aenter__()
+            # make sure we have actually connected
+            pong = await self._websocket.ping()
+            await pong
+        except Exception as e:
+            # The client is frequently run in a background thread
+            # so we log an additional warning to ensure
+            # surfacing the error to the user.
+            logger.warning(
+                "Unable to connect to %r. "
+                "Please check your network settings to ensure websocket connections "
+                "to the API are allowed. Otherwise event data (including task run data) may be lost. "
+                "Reason: %s. "
+                "Set PREFECT_DEBUG_MODE=1 to see the full error.",
+                self._events_socket_url,
+                str(e),
+                exc_info=PREFECT_DEBUG_MODE,
+            )
+            raise
 
         events_to_resend = self._unconfirmed_events
         # Clear the unconfirmed events here, because they are going back through emit
@@ -412,7 +435,6 @@ class PrefectCloudEventsClient(PrefectEventsClient):
             reconnection_attempts=reconnection_attempts,
             checkpoint_every=checkpoint_every,
         )
-
         self._connect = connect(
             self._events_socket_url,
             extra_headers={"Authorization": f"bearer {api_key}"},
@@ -468,11 +490,7 @@ class PrefectEventSubscriber:
         self._filter = filter or EventFilter()  # type: ignore[call-arg]
         self._seen_events = TTLCache(maxsize=SEEN_EVENTS_SIZE, ttl=SEEN_EVENTS_TTL)
 
-        socket_url = (
-            api_url.replace("https://", "wss://")
-            .replace("http://", "ws://")
-            .rstrip("/")
-        ) + "/events/out"
+        socket_url = events_out_socket_from_api_url(api_url)
 
         logger.debug("Connecting to %s", socket_url)
 
@@ -527,11 +545,11 @@ class PrefectEventSubscriber:
                 f"Reason: {e.args[0]}"
             )
         except ConnectionClosedError as e:
-            raise Exception(
-                "Unable to authenticate to the event stream. Please ensure the "
-                "provided api_key you are using is valid for this environment. "
-                f"Reason: {e.reason}"
-            ) from e
+            reason = getattr(e.rcvd, "reason", None)
+            msg = "Unable to authenticate to the event stream. Please ensure the "
+            msg += "provided api_key you are using is valid for this environment. "
+            msg += f"Reason: {reason}" if reason else ""
+            raise Exception(msg) from e
 
         from prefect.events.filters import EventOccurredFilter
 

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/filesystems.py

@@ -5,7 +5,7 @@ from typing import Any, Dict, Optional
 
 import anyio
 import fsspec
-from pydantic import Field, SecretStr, field_validator
+from pydantic import BaseModel, Field, SecretStr, field_validator
 
 from prefect._internal.schemas.validators import (
     stringify_path,
@@ -519,4 +519,29 @@ class SMB(WritableFileSystem, WritableDeploymentStorage):
         return await self.filesystem.write_path(path=path, content=content)
 
 
+class NullFileSystem(BaseModel):
+    """
+    A file system that does not store any data.
+    """
+
+    async def read_path(self, path: str) -> None:
+        pass
+
+    async def write_path(self, path: str, content: bytes) -> None:
+        pass
+
+    async def get_directory(
+        self, from_path: Optional[str] = None, local_path: Optional[str] = None
+    ) -> None:
+        pass
+
+    async def put_directory(
+        self,
+        local_path: Optional[str] = None,
+        to_path: Optional[str] = None,
+        ignore_file: Optional[str] = None,
+    ) -> None:
+        pass
+
+
 __getattr__ = getattr_migration(__name__)

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/flows.py

@@ -535,7 +535,7 @@ class Flow(Generic[P, R]):
 
         def resolve_block_reference(data: Any) -> Any:
             if isinstance(data, dict) and "$ref" in data:
-                return Block.load_from_ref(data["$ref"])
+                return Block.load_from_ref(data["$ref"], _sync=True)
             return data
 
         try:
@@ -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
@@ -1256,6 +1256,15 @@ class Flow(Generic[P, R]):
     ) -> T:
         ...
 
+    @overload
+    def __call__(
+        self: "Flow[P, Coroutine[Any, Any, T]]",
+        *args: P.args,
+        return_state: Literal[True],
+        **kwargs: P.kwargs,
+    ) -> Awaitable[State[T]]:
+        ...
+
     @overload
     def __call__(
         self: "Flow[P, T]",

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/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,
     ):
         """