prefect-client 3.0.0rc20__py3-none-any.whl → 3.0.1__py3-none-any.whl

prefect/_internal/compatibility/migration.py

@@ -60,7 +60,7 @@ MOVED_IN_V3 = {
     "prefect.client:get_client": "prefect.client.orchestration:get_client",
 }
 
-upgrade_guide_msg = "Refer to the upgrade guide for more information: https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/."
+upgrade_guide_msg = "Refer to the upgrade guide for more information: https://docs.prefect.io/latest/resources/upgrade-agents-to-workers."
 
 REMOVED_IN_V3 = {
     "prefect.client.schemas.objects:MinimalDeploymentSchedule": "Use `prefect.client.schemas.actions.DeploymentScheduleCreate` instead.",

prefect/artifacts.py

@@ -31,7 +31,7 @@ if TYPE_CHECKING:
 class Artifact(ArtifactRequest):
     """
     An artifact is a piece of data that is created by a flow or task run.
-    https://docs.prefect.io/latest/concepts/artifacts/
+    https://docs.prefect.io/latest/develop/artifacts
 
     Arguments:
         type: A string identifying the type of artifact.

prefect/blocks/core.py

@@ -555,10 +555,9 @@ class Block(BaseModel, ABC):
         `<module>:11: No type or annotation for parameter 'write_json'`
         because griffe is unable to parse the types from pydantic.BaseModel.
         """
-        with disable_logger("griffe.docstrings.google"):
-            with disable_logger("griffe.agents.nodes"):
-                docstring = Docstring(cls.__doc__)
-                parsed = parse(docstring, Parser.google)
+        with disable_logger("griffe"):
+            docstring = Docstring(cls.__doc__)
+            parsed = parse(docstring, Parser.google)
         return parsed
 
     @classmethod

prefect/blocks/notifications.py

@@ -73,7 +73,7 @@ class AppriseNotificationBlock(AbstractAppriseNotificationBlock, ABC):
     A base class for sending notifications using Apprise, through webhook URLs.
     """
 
-    _documentation_url = "https://docs.prefect.io/ui/notifications/"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
     url: SecretStr = Field(
         default=...,
         title="Webhook URL",
@@ -100,7 +100,7 @@ class SlackWebhook(AppriseNotificationBlock):
 
     _block_type_name = "Slack Webhook"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/c1965ecbf8704ee1ea20d77786de9a41ce1087d1-500x500.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.SlackWebhook"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
 
     url: SecretStr = Field(
         default=...,
@@ -126,7 +126,7 @@ class MicrosoftTeamsWebhook(AppriseNotificationBlock):
     _block_type_name = "Microsoft Teams Webhook"
     _block_type_slug = "ms-teams-webhook"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/817efe008a57f0a24f3587414714b563e5e23658-250x250.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.MicrosoftTeamsWebhook"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
 
     url: SecretStr = Field(
         default=...,
@@ -181,7 +181,7 @@ class PagerDutyWebHook(AbstractAppriseNotificationBlock):
     _block_type_name = "Pager Duty Webhook"
     _block_type_slug = "pager-duty-webhook"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/8dbf37d17089c1ce531708eac2e510801f7b3aee-250x250.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.PagerDutyWebHook"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
 
     # The default cannot be prefect_default because NotifyPagerDuty's
     # PAGERDUTY_SEVERITY_MAP only has these notify types defined as keys
@@ -291,7 +291,7 @@ class TwilioSMS(AbstractAppriseNotificationBlock):
     _block_type_name = "Twilio SMS"
     _block_type_slug = "twilio-sms"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/8bd8777999f82112c09b9c8d57083ac75a4a0d65-250x250.png"  # noqa
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.TwilioSMS"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
 
     account_sid: str = Field(
         default=...,
@@ -360,7 +360,7 @@ class OpsgenieWebhook(AbstractAppriseNotificationBlock):
     _block_type_name = "Opsgenie Webhook"
     _block_type_slug = "opsgenie-webhook"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/d8b5bc6244ae6cd83b62ec42f10d96e14d6e9113-280x280.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.OpsgenieWebhook"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
 
     apikey: SecretStr = Field(
         default=...,
@@ -478,7 +478,7 @@ class MattermostWebhook(AbstractAppriseNotificationBlock):
     _block_type_name = "Mattermost Webhook"
     _block_type_slug = "mattermost-webhook"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/1350a147130bf82cbc799a5f868d2c0116207736-250x250.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.MattermostWebhook"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
 
     hostname: str = Field(
         default=...,
@@ -559,7 +559,7 @@ class DiscordWebhook(AbstractAppriseNotificationBlock):
     _block_type_name = "Discord Webhook"
     _block_type_slug = "discord-webhook"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/9e94976c80ef925b66d24e5d14f0d47baa6b8f88-250x250.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.DiscordWebhook"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
 
     webhook_id: SecretStr = Field(
         default=...,
@@ -658,7 +658,7 @@ class CustomWebhookNotificationBlock(NotificationBlock):
 
     _block_type_name = "Custom Webhook"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/c7247cb359eb6cf276734d4b1fbf00fb8930e89e-250x250.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.CustomWebhookNotificationBlock"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
 
     name: str = Field(title="Name", description="Name of the webhook.")
 
@@ -789,7 +789,7 @@ class SendgridEmail(AbstractAppriseNotificationBlock):
     _block_type_name = "Sendgrid Email"
     _block_type_slug = "sendgrid-email"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/82bc6ed16ca42a2252a5512c72233a253b8a58eb-250x250.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/notifications/#prefect.blocks.notifications.SendgridEmail"
+    _documentation_url = "https://docs.prefect.io/latest/automate/events/automations-triggers#sending-notifications-with-automations"
 
     api_key: SecretStr = Field(
         default=...,

prefect/blocks/system.py

@@ -44,7 +44,7 @@ class JSON(Block):
     """
 
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/4fcef2294b6eeb423b1332d1ece5156bf296ff96-48x48.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/system/#prefect.blocks.system.JSON"
+    _documentation_url = "https://docs.prefect.io/latest/develop/blocks"
 
     value: Any = Field(default=..., description="A JSON-compatible value.")
 
@@ -71,7 +71,7 @@ class String(Block):
     """
 
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/c262ea2c80a2c043564e8763f3370c3db5a6b3e6-48x48.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/system/#prefect.blocks.system.String"
+    _documentation_url = "https://docs.prefect.io/latest/develop/blocks"
 
     value: str = Field(default=..., description="A string value.")
 
@@ -99,7 +99,7 @@ class DateTime(Block):
 
     _block_type_name = "Date Time"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/8b3da9a6621e92108b8e6a75b82e15374e170ff7-48x48.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/system/#prefect.blocks.system.DateTime"
+    _documentation_url = "https://docs.prefect.io/latest/develop/blocks"
 
     value: PydanticDateTime = Field(
         default=...,
@@ -129,7 +129,7 @@ class Secret(Block, Generic[T]):
     """
 
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/c6f20e556dd16effda9df16551feecfb5822092b-48x48.png"
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/system/#prefect.blocks.system.Secret"
+    _documentation_url = "https://docs.prefect.io/latest/develop/blocks"
 
     value: Union[SecretStr, PydanticSecret[T]] = Field(
         default=...,

prefect/blocks/webhook.py

@@ -19,7 +19,9 @@ class Webhook(Block):
 
     _block_type_name = "Webhook"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/c7247cb359eb6cf276734d4b1fbf00fb8930e89e-250x250.png"  # type: ignore
-    _documentation_url = "https://docs.prefect.io/api-ref/prefect/blocks/webhook/#prefect.blocks.webhook.Webhook"
+    _documentation_url = (
+        "https://docs.prefect.io/latest/automate/events/webhook-triggers"
+    )
 
     method: Literal["GET", "POST", "PUT", "PATCH", "DELETE"] = Field(
         default="POST", description="The webhook request method. Defaults to `POST`."

prefect/client/cloud.py

@@ -73,9 +73,10 @@ class CloudClient:
             **httpx_settings, enable_csrf_support=False
         )
 
+        api_url = prefect.settings.PREFECT_API_URL.value() or ""
         if match := (
             re.search(PARSE_API_URL_REGEX, host)
-            or re.search(PARSE_API_URL_REGEX, prefect.settings.PREFECT_API_URL.value())
+            or re.search(PARSE_API_URL_REGEX, api_url)
         ):
             self.account_id, self.workspace_id = match.groups()
 

prefect/client/orchestration.py

@@ -24,6 +24,7 @@ import httpx
 import pendulum
 import pydantic
 from asgi_lifespan import LifespanManager
+from packaging import version
 from starlette import status
 from typing_extensions import ParamSpec
 
@@ -3329,6 +3330,32 @@ class PrefectClient:
     async def delete_resource_owned_automations(self, resource_id: str):
         await self._client.delete(f"/automations/owned-by/{resource_id}")
 
+    async def api_version(self) -> str:
+        res = await self._client.get("/admin/version")
+        return res.json()
+
+    def client_version(self) -> str:
+        return prefect.__version__
+
+    async def raise_for_api_version_mismatch(self):
+        # Cloud is always compatible as a server
+        if self.server_type == ServerType.CLOUD:
+            return
+
+        try:
+            api_version = await self.api_version()
+        except Exception as e:
+            raise RuntimeError(f"Failed to reach API at {self.api_url}") from e
+
+        api_version = version.parse(api_version)
+        client_version = version.parse(self.client_version())
+
+        if api_version.major != client_version.major:
+            raise RuntimeError(
+                f"Found incompatible versions: client: {client_version}, server: {api_version}. "
+                f"Major versions must match."
+            )
+
     async def __aenter__(self):
         """
         Start the client.
@@ -3622,6 +3649,32 @@ class SyncPrefectClient:
         """
         return self._client.get("/hello")
 
+    def api_version(self) -> str:
+        res = self._client.get("/admin/version")
+        return res.json()
+
+    def client_version(self) -> str:
+        return prefect.__version__
+
+    def raise_for_api_version_mismatch(self):
+        # Cloud is always compatible as a server
+        if self.server_type == ServerType.CLOUD:
+            return
+
+        try:
+            api_version = self.api_version()
+        except Exception as e:
+            raise RuntimeError(f"Failed to reach API at {self.api_url}") from e
+
+        api_version = version.parse(api_version)
+        client_version = version.parse(self.client_version())
+
+        if api_version.major != client_version.major:
+            raise RuntimeError(
+                f"Found incompatible versions: client: {client_version}, server: {api_version}. "
+                f"Major versions must match."
+            )
+
     def create_flow(self, flow: "FlowObject") -> UUID:
         """
         Create a flow in the Prefect API.
@@ -4147,7 +4200,7 @@ class SyncPrefectClient:
 
         response = self._client.post(
             "/artifacts/",
-            json=artifact.model_dump_json(exclude_unset=True),
+            json=artifact.model_dump(mode="json", exclude_unset=True),
         )
 
         return Artifact.model_validate(response.json())

prefect/context.py

@@ -40,11 +40,10 @@ 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.results import ResultFactory
+from prefect.results import ResultStore
 from prefect.settings import PREFECT_HOME, Profile, Settings
 from prefect.states import State
 from prefect.task_runners import TaskRunner
-from prefect.utilities.asyncutils import run_coro_as_sync
 from prefect.utilities.services import start_client_metrics_server
 
 T = TypeVar("T")
@@ -95,20 +94,15 @@ def hydrated_context(
                 flow_run_context = FlowRunContext(
                     **flow_run_context,
                     client=client,
-                    result_factory=run_coro_as_sync(ResultFactory.from_flow(flow)),
                     task_runner=task_runner,
                     detached=True,
                 )
                 stack.enter_context(flow_run_context)
             # Set up parent task run context
             if parent_task_run_context := serialized_context.get("task_run_context"):
-                parent_task = parent_task_run_context["task"]
                 task_run_context = TaskRunContext(
                     **parent_task_run_context,
                     client=client,
-                    result_factory=run_coro_as_sync(
-                        ResultFactory.from_autonomous_task(parent_task)
-                    ),
                 )
                 stack.enter_context(task_run_context)
             # Set up tags context
@@ -216,6 +210,7 @@ class SyncClientContext(ContextModel):
         self._context_stack += 1
         if self._context_stack == 1:
             self.client.__enter__()
+            self.client.raise_for_api_version_mismatch()
             return super().__enter__()
         else:
             return self
@@ -273,6 +268,7 @@ class AsyncClientContext(ContextModel):
         self._context_stack += 1
         if self._context_stack == 1:
             await self.client.__aenter__()
+            await self.client.raise_for_api_version_mismatch()
             return super().__enter__()
         else:
             return self
@@ -346,7 +342,7 @@ class EngineContext(RunContext):
     detached: bool = False
 
     # Result handling
-    result_factory: ResultFactory
+    result_store: ResultStore
 
     # Counter for task calls allowing unique
     task_run_dynamic_keys: Dict[str, int] = Field(default_factory=dict)
@@ -375,6 +371,7 @@ class EngineContext(RunContext):
                 "log_prints",
                 "start_time",
                 "input_keyset",
+                "result_store",
             },
             exclude_unset=True,
         )
@@ -399,7 +396,7 @@ class TaskRunContext(RunContext):
     parameters: Dict[str, Any]
 
     # Result handling
-    result_factory: ResultFactory
+    result_store: ResultStore
 
     __var__ = ContextVar("task_run")
 
@@ -412,6 +409,7 @@ class TaskRunContext(RunContext):
                 "log_prints",
                 "start_time",
                 "input_keyset",
+                "result_store",
             },
             exclude_unset=True,
         )

prefect/deployments/runner.py

@@ -508,7 +508,7 @@ class RunnerDeployment(BaseModel):
             no_file_location_error = (
                 "Flows defined interactively cannot be deployed. Check out the"
                 " quickstart guide for help getting started:"
-                " https://docs.prefect.io/latest/getting-started/quickstart"
+                " https://docs.prefect.io/latest/get-started/quickstart"
             )
             ## first see if an entrypoint can be determined
             flow_file = getattr(flow, "__globals__", {}).get("__file__")
@@ -851,14 +851,14 @@ async def deploy(
                 " or specify a remote storage location for the flow with `.from_source`."
                 " If you are attempting to deploy a flow to a local process work pool,"
                 " consider using `flow.serve` instead. See the documentation for more"
-                " information: https://docs.prefect.io/latest/concepts/flows/#serving-a-flow"
+                " information: https://docs.prefect.io/latest/deploy/run-flows-in-local-processes"
             )
         elif work_pool.type == "process" and not ignore_warnings:
             console.print(
                 "Looks like you're deploying to a process work pool. If you're creating a"
                 " deployment for local development, calling `.serve` on your flow is a great"
                 " way to get started. See the documentation for more information:"
-                " https://docs.prefect.io/latest/concepts/flows/#serving-a-flow. "
+                " https://docs.prefect.io/latest/deploy/run-flows-in-local-processes "
                 " Set `ignore_warnings=True` to suppress this message.",
                 style="yellow",
             )

prefect/exceptions.py

@@ -418,3 +418,9 @@ class SerializationError(PrefectException):
     """
     Raised when an object cannot be serialized.
     """
+
+
+class ConfigurationError(PrefectException):
+    """
+    Raised when a configuration is invalid.
+    """

prefect/filesystems.py

@@ -84,7 +84,7 @@ class LocalFileSystem(WritableFileSystem, WritableDeploymentStorage):
     _block_type_name = "Local File System"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/ad39089fa66d273b943394a68f003f7a19aa850e-48x48.png"
     _documentation_url = (
-        "https://docs.prefect.io/concepts/filesystems/#local-filesystem"
+        "https://docs.prefect.io/latest/develop/results#specifying-a-default-filesystem"
     )
 
     basepath: Optional[str] = Field(
@@ -260,7 +260,7 @@ class RemoteFileSystem(WritableFileSystem, WritableDeploymentStorage):
     _block_type_name = "Remote File System"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/e86b41bc0f9c99ba9489abeee83433b43d5c9365-48x48.png"
     _documentation_url = (
-        "https://docs.prefect.io/concepts/filesystems/#remote-file-system"
+        "https://docs.prefect.io/latest/develop/results#specifying-a-default-filesystem"
     )
 
     basepath: str = Field(
@@ -433,7 +433,9 @@ class SMB(WritableFileSystem, WritableDeploymentStorage):
 
     _block_type_name = "SMB"
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/3f624663f7beb97d011d011bffd51ecf6c499efc-195x195.png"
-    _documentation_url = "https://docs.prefect.io/concepts/filesystems/#smb"
+    _documentation_url = (
+        "https://docs.prefect.io/latest/develop/results#specifying-a-default-filesystem"
+    )
 
     share_path: str = Field(
         default=...,

prefect/flow_engine.py

@@ -47,7 +47,7 @@ from prefect.logging.loggers import (
     get_run_logger,
     patch_print,
 )
-from prefect.results import BaseResult, ResultFactory
+from prefect.results import BaseResult, ResultStore, get_current_result_store
 from prefect.settings import PREFECT_DEBUG_MODE
 from prefect.states import (
     Failed,
@@ -202,7 +202,9 @@ class FlowRunEngine(Generic[P, R]):
                 self.handle_exception(
                     exc,
                     msg=message,
-                    result_factory=run_coro_as_sync(ResultFactory.from_flow(self.flow)),
+                    result_store=get_current_result_store().update_for_flow(
+                        self.flow, _sync=True
+                    ),
                 )
                 self.short_circuit = True
                 self.call_hooks()
@@ -261,14 +263,14 @@ class FlowRunEngine(Generic[P, R]):
         return _result
 
     def handle_success(self, result: R) -> R:
-        result_factory = getattr(FlowRunContext.get(), "result_factory", None)
-        if result_factory is None:
-            raise ValueError("Result factory is not set")
+        result_store = getattr(FlowRunContext.get(), "result_store", None)
+        if result_store is None:
+            raise ValueError("Result store is not set")
         resolved_result = resolve_futures_to_states(result)
         terminal_state = run_coro_as_sync(
             return_value_to_state(
                 resolved_result,
-                result_factory=result_factory,
+                result_store=result_store,
                 write_result=True,
             )
         )
@@ -280,15 +282,14 @@ class FlowRunEngine(Generic[P, R]):
         self,
         exc: Exception,
         msg: Optional[str] = None,
-        result_factory: Optional[ResultFactory] = None,
+        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_factory=result_factory
-                or getattr(context, "result_factory", None),
+                result_store=result_store or getattr(context, "result_store", None),
                 write_result=True,
             )
         )
@@ -506,7 +507,9 @@ class FlowRunEngine(Generic[P, R]):
                     flow_run=self.flow_run,
                     parameters=self.parameters,
                     client=client,
-                    result_factory=run_coro_as_sync(ResultFactory.from_flow(self.flow)),
+                    result_store=get_current_result_store().update_for_flow(
+                        self.flow, _sync=True
+                    ),
                     task_runner=task_runner,
                 )
             )

prefect/flows.py

@@ -1032,8 +1032,6 @@ class Flow(Generic[P, R]):
             if not isinstance(storage, LocalStorage):
                 storage.set_base_path(Path(tmpdir))
                 await storage.pull_code()
-            storage.set_base_path(Path(tmpdir))
-            await storage.pull_code()
 
             full_entrypoint = str(storage.destination / entrypoint)
             flow: Flow = await from_async.wait_for_call_in_new_thread(

prefect/futures.py

@@ -179,7 +179,8 @@ class PrefectConcurrentFuture(PrefectWrappedFuture[R, concurrent.futures.Future]
             local_logger = logger
         local_logger.warning(
             "A future was garbage collected before it resolved."
-            " Please call `.wait()` or `.result()` on futures to ensure they resolve.",
+            " Please call `.wait()` or `.result()` on futures to ensure they resolve."
+            "\nSee https://docs.prefect.io/latest/develop/task-runners for more details.",
         )