prefect-client 3.0.0rc1__py3-none-any.whl → 3.0.0rc3__py3-none-any.whl

prefect/client/schemas/objects.py

@@ -94,6 +94,14 @@ class StateType(AutoEnum):
     CANCELLING = AutoEnum.auto()
 
 
+TERMINAL_STATES = {
+    StateType.COMPLETED,
+    StateType.CANCELLED,
+    StateType.FAILED,
+    StateType.CRASHED,
+}
+
+
 class WorkPoolStatus(AutoEnum):
     """Enumeration of work pool statuses."""
 
@@ -280,7 +288,7 @@ class State(ObjectBaseModel, Generic[R]):
     def default_scheduled_start_time(self) -> Self:
         if self.type == StateType.SCHEDULED:
             if not self.state_details.scheduled_time:
-                self.state_details.scheduled_time = pendulum.now("utc")
+                self.state_details.scheduled_time = DateTime.now("utc")
         return self
 
     def is_scheduled(self) -> bool:
@@ -308,12 +316,7 @@ class State(ObjectBaseModel, Generic[R]):
         return self.type == StateType.CANCELLING
 
     def is_final(self) -> bool:
-        return self.type in {
-            StateType.CANCELLED,
-            StateType.FAILED,
-            StateType.COMPLETED,
-            StateType.CRASHED,
-        }
+        return self.type in TERMINAL_STATES
 
     def is_paused(self) -> bool:
         return self.type == StateType.PAUSED
@@ -419,8 +422,11 @@ class FlowRunPolicy(PrefectBaseModel):
     )
 
     @model_validator(mode="before")
-    def populate_deprecated_fields(cls, values):
-        return set_run_policy_deprecated_fields(values)
+    @classmethod
+    def populate_deprecated_fields(cls, values: Any):
+        if isinstance(values, dict):
+            return set_run_policy_deprecated_fields(values)
+        return values
 
 
 class FlowRun(ObjectBaseModel):
@@ -550,7 +556,8 @@ class FlowRun(ObjectBaseModel):
         examples=["State(type=StateType.COMPLETED)"],
     )
     job_variables: Optional[dict] = Field(
-        default=None, description="Job variables for the flow run."
+        default=None,
+        description="Job variables for the flow run.",
     )
 
     # These are server-side optimizations and should not be present on client models
@@ -911,6 +918,7 @@ class BlockDocument(ObjectBaseModel):
     _validate_name_format = field_validator("name")(validate_block_document_name)
 
     @model_validator(mode="before")
+    @classmethod
     def validate_name_is_present_if_not_anonymous(cls, values):
         return validate_name_present_on_nonanonymous_blocks(values)
 
@@ -1142,8 +1150,11 @@ class BlockDocumentReference(ObjectBaseModel):
     )
 
     @model_validator(mode="before")
+    @classmethod
     def validate_parent_and_ref_are_different(cls, values):
-        return validate_parent_and_ref_diff(values)
+        if isinstance(values, dict):
+            return validate_parent_and_ref_diff(values)
+        return values
 
 
 class Configuration(ObjectBaseModel):

prefect/client/subscriptions.py

@@ -9,7 +9,7 @@ from typing_extensions import Self
 
 from prefect._internal.schemas.bases import IDBaseModel
 from prefect.logging import get_logger
-from prefect.settings import PREFECT_API_KEY, PREFECT_API_URL
+from prefect.settings import PREFECT_API_KEY
 
 logger = get_logger(__name__)
 
@@ -23,10 +23,11 @@ class Subscription(Generic[S]):
         path: str,
         keys: List[str],
         client_id: Optional[str] = None,
+        base_url: Optional[str] = None,
     ):
         self.model = model
         self.client_id = client_id
-        base_url = PREFECT_API_URL.value().replace("http", "ws", 1)
+        base_url = base_url.replace("http", "ws", 1)
         self.subscription_url = f"{base_url}{path}"
 
         self.keys = keys

prefect/concurrency/asyncio.py

@@ -11,7 +11,7 @@ except ImportError:
     # pendulum < 3
     from pendulum.period import Period as Interval  # type: ignore
 
-from prefect import get_client
+from prefect.client.orchestration import get_client
 from prefect.client.schemas.responses import MinimalConcurrencyLimitResponse
 from prefect.utilities.timeout import timeout_async
 

prefect/concurrency/services.py

@@ -10,9 +10,9 @@ from typing import (
 import httpx
 from starlette import status
 
-from prefect import get_client
 from prefect._internal.concurrency import logger
 from prefect._internal.concurrency.services import QueueService
+from prefect.client.orchestration import get_client
 
 if TYPE_CHECKING:
     from prefect.client.orchestration import PrefectClient

prefect/context.py

@@ -29,13 +29,9 @@ from typing import (
     Union,
 )
 
-import anyio
-import anyio._backends._asyncio
-import anyio.abc
 import pendulum
 from pydantic import BaseModel, ConfigDict, Field, PrivateAttr
 from pydantic_extra_types.pendulum_dt import DateTime
-from sniffio import AsyncLibraryNotFoundError
 from typing_extensions import Self
 
 import prefect.logging
@@ -45,7 +41,6 @@ from prefect.client.orchestration import PrefectClient, SyncPrefectClient, get_c
 from prefect.client.schemas import FlowRun, TaskRun
 from prefect.events.worker import EventsWorker
 from prefect.exceptions import MissingContextError
-from prefect.futures import PrefectFuture
 from prefect.results import ResultFactory
 from prefect.settings import PREFECT_HOME, Profile, Settings
 from prefect.states import State
@@ -94,19 +89,12 @@ def hydrated_context(
             if settings_context := serialized_context.get("settings_context"):
                 stack.enter_context(SettingsContext(**settings_context))
             # Set up parent flow run context
-            # TODO: This task group isn't necessary in the new engine. Remove the background tasks
-            # attribute from FlowRunContext.
             client = client or get_client(sync_client=True)
             if flow_run_context := serialized_context.get("flow_run_context"):
-                try:
-                    task_group = anyio.create_task_group()
-                except AsyncLibraryNotFoundError:
-                    task_group = anyio._backends._asyncio.TaskGroup()
                 flow = flow_run_context["flow"]
                 flow_run_context = FlowRunContext(
                     **flow_run_context,
                     client=client,
-                    background_tasks=task_group,
                     result_factory=run_coro_as_sync(ResultFactory.from_flow(flow)),
                     task_runner=flow.task_runner.duplicate(),
                     detached=True,
@@ -367,13 +355,10 @@ class EngineContext(RunContext):
         task_run_states: A list of states for task runs created within this flow run
         task_run_results: A mapping of result ids to task run states for this flow run
         flow_run_states: A list of states for flow runs created within this flow run
-        sync_portal: A blocking portal for sync task/flow runs in an async flow
-        timeout_scope: The cancellation scope for flow level timeouts
     """
 
     flow: Optional["Flow"] = None
     flow_run: Optional[FlowRun] = None
-    autonomous_task_run: Optional[TaskRun] = None
     task_runner: TaskRunner
     log_prints: bool = False
     parameters: Optional[Dict[str, Any]] = None
@@ -391,19 +376,8 @@ class EngineContext(RunContext):
     # Counter for flow pauses
     observed_flow_pauses: Dict[str, int] = Field(default_factory=dict)
 
-    # Tracking for objects created by this flow run
-    task_run_futures: List[PrefectFuture] = Field(default_factory=list)
-    task_run_states: List[State] = Field(default_factory=list)
+    # Tracking for result from task runs in this flow run
     task_run_results: Dict[int, State] = Field(default_factory=dict)
-    flow_run_states: List[State] = Field(default_factory=list)
-
-    # The synchronous portal is only created for async flows for creating engine calls
-    # from synchronous task and subflow calls
-    sync_portal: Optional[anyio.abc.BlockingPortal] = None
-    timeout_scope: Optional[anyio.abc.CancelScope] = None
-
-    # Task group that can be used for background tasks during the flow run
-    background_tasks: anyio.abc.TaskGroup
 
     # Events worker to emit events to Prefect Cloud
     events: Optional[EventsWorker] = None

prefect/deployments/__init__.py

@@ -1,3 +1,4 @@
+from prefect._internal.compatibility.migration import getattr_migration
 import prefect.deployments.base
 import prefect.deployments.steps
 from prefect.deployments.base import (
@@ -15,3 +16,5 @@ from prefect.deployments.runner import (
 from prefect.deployments.flow_runs import (
     run_deployment,
 )
+
+__getattr__ = getattr_migration(__name__)

prefect/deployments/base.py

@@ -29,7 +29,7 @@ from prefect.utilities.templating import apply_values
 
 
 def create_default_prefect_yaml(
-    path: str, name: str = None, contents: Optional[Dict[str, Any]] = None
+    path: str, name: Optional[str] = None, contents: Optional[Dict[str, Any]] = None
 ) -> bool:
     """
     Creates default `prefect.yaml` file in the provided path if one does not already exist;
@@ -176,7 +176,9 @@ def _get_git_branch() -> Optional[str]:
 
 
 def initialize_project(
-    name: str = None, recipe: str = None, inputs: Optional[Dict[str, Any]] = None
+    name: Optional[str] = None,
+    recipe: Optional[str] = None,
+    inputs: Optional[Dict[str, Any]] = None,
 ) -> List[str]:
     """
     Initializes a basic project structure with base files.  If no name is provided, the name
@@ -398,7 +400,13 @@ async def _find_flow_functions_in_file(filename: str) -> List[Dict]:
             return decorated_functions
 
     for node in ast.walk(tree):
-        if isinstance(node, ast.FunctionDef):
+        if isinstance(
+            node,
+            (
+                ast.FunctionDef,
+                ast.AsyncFunctionDef,
+            ),
+        ):
             for decorator in node.decorator_list:
                 # handles @flow
                 is_name_match = (

prefect/deployments/deployments.py

@@ -0,0 +1,3 @@
+from .._internal.compatibility.migration import getattr_migration
+
+__getattr__ = getattr_migration(__name__)

prefect/deployments/steps/pull.py

@@ -1,6 +1,7 @@
 """
 Core set of steps for specifying a Prefect project pull step.
 """
+
 import os
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Optional

prefect/deployments/steps/utility.py

@@ -4,7 +4,7 @@ Utility project steps that are useful for managing a project's deployment lifecy
 Steps within this module can be used within a `build`, `push`, or `pull` deployment action.
 
 Example:
-    Use the `run_shell_script` setp to retrieve the short Git commit hash of the current 
+    Use the `run_shell_script` setp to retrieve the short Git commit hash of the current
         repository and use it as a Docker image tag:
     ```yaml
     build:
@@ -19,6 +19,7 @@ Example:
             dockerfile: auto
     ```
 """
+
 import io
 import os
 import shlex

prefect/engine.py

@@ -2,6 +2,7 @@ import os
 import sys
 from uuid import UUID
 
+from prefect._internal.compatibility.migration import getattr_migration
 from prefect.exceptions import (
     Abort,
     Pause,
@@ -70,3 +71,5 @@ if __name__ == "__main__":
         )
         # Let the exit code be determined by the base exception type
         raise
+
+__getattr__ = getattr_migration(__name__)

prefect/events/cli/automations.py

@@ -23,7 +23,7 @@ from prefect.exceptions import PrefectHTTPStatusError
 
 automations_app = PrefectTyper(
     name="automation",
-    help="Commands for managing automations.",
+    help="Manage automations.",
 )
 app.add_typer(automations_app, aliases=["automations"])
 

prefect/events/clients.py

@@ -63,6 +63,12 @@ def get_events_subscriber(
     reconnection_attempts: int = 10,
 ) -> "PrefectEventSubscriber":
     api_url = PREFECT_API_URL.value()
+    if not api_url:
+        raise ValueError(
+            "A Prefect server or Prefect Cloud is required to start an event "
+            "subscriber.  Please check the PREFECT_API_URL setting in your profile."
+        )
+
     if isinstance(api_url, str) and api_url.startswith(PREFECT_CLOUD_API_URL.value()):
         return PrefectCloudEventSubscriber(
             filter=filter, reconnection_attempts=reconnection_attempts
@@ -168,7 +174,7 @@ class PrefectEphemeralEventsClient(EventsClient):
             )
         from prefect.server.api.server import create_app
 
-        app = create_app()
+        app = create_app(ephemeral=True)
 
         self._http_client = PrefectHttpxAsyncClient(
             transport=httpx.ASGITransport(app=app, raise_app_exceptions=False),

prefect/events/schemas/events.py

@@ -83,6 +83,8 @@ class RelatedResource(Resource):
 class Event(PrefectBaseModel):
     """The client-side view of an event that has happened to a Resource"""
 
+    model_config = ConfigDict(extra="ignore")
+
     occurred: DateTime = Field(
         default_factory=lambda: pendulum.now("UTC"),
         description="When the event happened from the sender's perspective",

prefect/exceptions.py

@@ -400,3 +400,12 @@ class FlowPauseTimeout(PrefectException):
 
 class FlowRunWaitTimeout(PrefectException):
     """Raised when a flow run takes longer than a given timeout"""
+
+
+class PrefectImportError(ImportError):
+    """
+    An error raised when a Prefect object cannot be imported due to a move or removal.
+    """
+
+    def __init__(self, message: str) -> None:
+        super().__init__(message)

prefect/filesystems.py

@@ -16,6 +16,8 @@ from prefect.utilities.asyncutils import run_sync_in_worker_thread, sync_compati
 from prefect.utilities.compat import copytree
 from prefect.utilities.filesystem import filter_files
 
+from ._internal.compatibility.migration import getattr_migration
+
 
 class ReadableFileSystem(Block, abc.ABC):
     _block_schema_capabilities = ["read-path"]
@@ -42,7 +44,7 @@ class ReadableDeploymentStorage(Block, abc.ABC):
 
     @abc.abstractmethod
     async def get_directory(
-        self, from_path: str = None, local_path: str = None
+        self, from_path: Optional[str] = None, local_path: Optional[str] = None
     ) -> None:
         pass
 
@@ -52,13 +54,16 @@ class WritableDeploymentStorage(Block, abc.ABC):
 
     @abc.abstractmethod
     async def get_directory(
-        self, from_path: str = None, local_path: str = None
+        self, from_path: Optional[str] = None, local_path: Optional[str] = None
     ) -> None:
         pass
 
     @abc.abstractmethod
     async def put_directory(
-        self, local_path: str = None, to_path: str = None, ignore_file: str = None
+        self,
+        local_path: Optional[str] = None,
+        to_path: Optional[str] = None,
+        ignore_file: Optional[str] = None,
     ) -> None:
         pass
 
@@ -103,18 +108,18 @@ class LocalFileSystem(WritableFileSystem, WritableDeploymentStorage):
         if path is None:
             return basepath
 
-        path: Path = Path(path).expanduser()
+        resolved_path: Path = Path(path).expanduser()
 
-        if not path.is_absolute():
-            path = basepath / path
+        if not resolved_path.is_absolute():
+            resolved_path = basepath / resolved_path
         else:
-            path = path.resolve()
-            if basepath not in path.parents and (basepath != path):
+            resolved_path = resolved_path.resolve()
+            if basepath not in resolved_path.parents and (basepath != resolved_path):
                 raise ValueError(
-                    f"Provided path {path} is outside of the base path {basepath}."
+                    f"Provided path {resolved_path} is outside of the base path {basepath}."
                 )
 
-        return path
+        return resolved_path
 
     @sync_compatible
     async def get_directory(
@@ -168,7 +173,10 @@ class LocalFileSystem(WritableFileSystem, WritableDeploymentStorage):
 
     @sync_compatible
     async def put_directory(
-        self, local_path: str = None, to_path: str = None, ignore_file: str = None
+        self,
+        local_path: Optional[str] = None,
+        to_path: Optional[str] = None,
+        ignore_file: Optional[str] = None,
     ) -> None:
         """
         Copies a directory from one place to another on the local filesystem.
@@ -506,3 +514,6 @@ class SMB(WritableFileSystem, WritableDeploymentStorage):
     @sync_compatible
     async def write_path(self, path: str, content: bytes) -> str:
         return await self.filesystem.write_path(path=path, content=content)
+
+
+__getattr__ = getattr_migration(__name__)