prefect-client 3.1.11__py3-none-any.whl → 3.1.12__py3-none-any.whl

prefect/client/orchestration/_automations/client.py

@@ -0,0 +1,329 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from httpx import HTTPStatusError
+
+from prefect.client.orchestration.base import BaseAsyncClient, BaseClient
+from prefect.exceptions import ObjectNotFound
+
+if TYPE_CHECKING:
+    from uuid import UUID
+
+    from prefect.events.schemas.automations import Automation, AutomationCore
+
+
+class AutomationClient(BaseClient):
+    def create_automation(self, automation: "AutomationCore") -> "UUID":
+        """Creates an automation in Prefect Cloud."""
+        response = self.request(
+            "POST",
+            "/automations/",
+            json=automation.model_dump(mode="json"),
+        )
+        from uuid import UUID
+
+        return UUID(response.json()["id"])
+
+    def update_automation(
+        self, automation_id: "UUID", automation: "AutomationCore"
+    ) -> None:
+        """Updates an automation in Prefect Cloud."""
+        response = self.request(
+            "PUT",
+            "/automations/{id}",
+            path_params={"id": automation_id},
+            json=automation.model_dump(mode="json", exclude_unset=True),
+        )
+        response.raise_for_status()
+
+    def read_automations(self) -> list["Automation"]:
+        response = self.request("POST", "/automations/filter")
+        response.raise_for_status()
+        from prefect.events.schemas.automations import Automation
+
+        return Automation.model_validate_list(response.json())
+
+    def find_automation(self, id_or_name: "str | UUID") -> "Automation | None":
+        if isinstance(id_or_name, str):
+            name = id_or_name
+            try:
+                id = UUID(id_or_name)
+            except ValueError:
+                id = None
+        else:
+            id = id_or_name
+            name = str(id)
+
+        if id:
+            try:
+                automation = self.read_automation(id)
+                return automation
+            except HTTPStatusError as e:
+                if e.response.status_code == 404:
+                    raise ObjectNotFound(http_exc=e) from e
+
+        automations = self.read_automations()
+
+        # Look for it by an exact name
+        for automation in automations:
+            if automation.name == name:
+                return automation
+
+        # Look for it by a case-insensitive name
+        for automation in automations:
+            if automation.name.lower() == name.lower():
+                return automation
+
+        return None
+
+    def read_automation(self, automation_id: "UUID | str") -> "Automation | None":
+        response = self.request(
+            "GET", "/automations/{id}", path_params={"id": automation_id}
+        )
+        if response.status_code == 404:
+            return None
+        response.raise_for_status()
+        from prefect.events.schemas.automations import Automation
+
+        return Automation.model_validate(response.json())
+
+    def read_automations_by_name(self, name: str) -> list["Automation"]:
+        """
+        Query the Prefect API for an automation by name. Only automations matching the provided name will be returned.
+
+        Args:
+            name: the name of the automation to query
+
+        Returns:
+            a list of Automation model representations of the automations
+        """
+        from prefect.client.schemas.sorting import AutomationSort
+        from prefect.events.filters import (
+            AutomationFilter,
+            AutomationFilterName,
+        )
+
+        automation_filter = AutomationFilter(name=AutomationFilterName(any_=[name]))
+
+        response = self.request(
+            "POST",
+            "/automations/filter",
+            json={
+                "sort": AutomationSort.UPDATED_DESC,
+                "automations": automation_filter.model_dump(mode="json")
+                if automation_filter
+                else None,
+            },
+        )
+
+        response.raise_for_status()
+        from prefect.events.schemas.automations import Automation
+
+        return Automation.model_validate_list(response.json())
+
+    def pause_automation(self, automation_id: "UUID") -> None:
+        response = self.request(
+            "PATCH",
+            "/automations/{id}",
+            path_params={"id": automation_id},
+            json={"enabled": False},
+        )
+        response.raise_for_status()
+
+    def resume_automation(self, automation_id: "UUID") -> None:
+        response = self.request(
+            "PATCH",
+            "/automations/{id}",
+            path_params={"id": automation_id},
+            json={"enabled": True},
+        )
+        response.raise_for_status()
+
+    def delete_automation(self, automation_id: "UUID") -> None:
+        response = self.request(
+            "DELETE",
+            "/automations/{id}",
+            path_params={"id": automation_id},
+        )
+        if response.status_code == 404:
+            return
+
+        response.raise_for_status()
+
+    def read_resource_related_automations(self, resource_id: str) -> list["Automation"]:
+        response = self.request(
+            "GET",
+            "/automations/related-to/{resource_id}",
+            path_params={"resource_id": resource_id},
+        )
+        response.raise_for_status()
+        from prefect.events.schemas.automations import Automation
+
+        return Automation.model_validate_list(response.json())
+
+    def delete_resource_owned_automations(self, resource_id: str) -> None:
+        self.request(
+            "DELETE",
+            "/automations/owned-by/{resource_id}",
+            path_params={"resource_id": resource_id},
+        )
+
+
+class AutomationAsyncClient(BaseAsyncClient):
+    async def create_automation(self, automation: "AutomationCore") -> "UUID":
+        """Creates an automation in Prefect Cloud."""
+        response = await self.request(
+            "POST",
+            "/automations/",
+            json=automation.model_dump(mode="json"),
+        )
+        from uuid import UUID
+
+        return UUID(response.json()["id"])
+
+    async def update_automation(
+        self, automation_id: "UUID", automation: "AutomationCore"
+    ) -> None:
+        """Updates an automation in Prefect Cloud."""
+        response = await self.request(
+            "PUT",
+            "/automations/{id}",
+            path_params={"id": automation_id},
+            json=automation.model_dump(mode="json", exclude_unset=True),
+        )
+        response.raise_for_status()
+
+    async def read_automations(self) -> list["Automation"]:
+        response = await self.request("POST", "/automations/filter")
+        response.raise_for_status()
+        from prefect.events.schemas.automations import Automation
+
+        return Automation.model_validate_list(response.json())
+
+    async def find_automation(self, id_or_name: "str | UUID") -> "Automation | None":
+        if isinstance(id_or_name, str):
+            name = id_or_name
+            try:
+                id = UUID(id_or_name)
+            except ValueError:
+                id = None
+        else:
+            id = id_or_name
+            name = str(id)
+
+        if id:
+            try:
+                automation = await self.read_automation(id)
+                return automation
+            except HTTPStatusError as e:
+                if e.response.status_code == 404:
+                    raise ObjectNotFound(http_exc=e) from e
+
+        automations = await self.read_automations()
+
+        # Look for it by an exact name
+        for automation in automations:
+            if automation.name == name:
+                return automation
+
+        # Look for it by a case-insensitive name
+        for automation in automations:
+            if automation.name.lower() == name.lower():
+                return automation
+
+        return None
+
+    async def read_automation(self, automation_id: "UUID | str") -> "Automation | None":
+        response = await self.request(
+            "GET", "/automations/{id}", path_params={"id": automation_id}
+        )
+        if response.status_code == 404:
+            return None
+        response.raise_for_status()
+        from prefect.events.schemas.automations import Automation
+
+        return Automation.model_validate(response.json())
+
+    async def read_automations_by_name(self, name: str) -> list["Automation"]:
+        """
+        Query the Prefect API for an automation by name. Only automations matching the provided name will be returned.
+
+        Args:
+            name: the name of the automation to query
+
+        Returns:
+            a list of Automation model representations of the automations
+        """
+        from prefect.client.schemas.sorting import AutomationSort
+        from prefect.events.filters import (
+            AutomationFilter,
+            AutomationFilterName,
+        )
+
+        automation_filter = AutomationFilter(name=AutomationFilterName(any_=[name]))
+
+        response = await self.request(
+            "POST",
+            "/automations/filter",
+            json={
+                "sort": AutomationSort.UPDATED_DESC,
+                "automations": automation_filter.model_dump(mode="json")
+                if automation_filter
+                else None,
+            },
+        )
+
+        response.raise_for_status()
+        from prefect.events.schemas.automations import Automation
+
+        return Automation.model_validate_list(response.json())
+
+    async def pause_automation(self, automation_id: "UUID") -> None:
+        response = await self.request(
+            "PATCH",
+            "/automations/{id}",
+            path_params={"id": automation_id},
+            json={"enabled": False},
+        )
+        response.raise_for_status()
+
+    async def resume_automation(self, automation_id: "UUID") -> None:
+        response = await self.request(
+            "PATCH",
+            "/automations/{id}",
+            path_params={"id": automation_id},
+            json={"enabled": True},
+        )
+        response.raise_for_status()
+
+    async def delete_automation(self, automation_id: "UUID") -> None:
+        response = await self.request(
+            "DELETE",
+            "/automations/{id}",
+            path_params={"id": automation_id},
+        )
+        if response.status_code == 404:
+            return
+
+        response.raise_for_status()
+
+    async def read_resource_related_automations(
+        self, resource_id: str
+    ) -> list["Automation"]:
+        response = await self.request(
+            "GET",
+            "/automations/related-to/{resource_id}",
+            path_params={"resource_id": resource_id},
+        )
+        response.raise_for_status()
+        from prefect.events.schemas.automations import Automation
+
+        return Automation.model_validate_list(response.json())
+
+    async def delete_resource_owned_automations(self, resource_id: str) -> None:
+        await self.request(
+            "DELETE",
+            "/automations/owned-by/{resource_id}",
+            path_params={"resource_id": resource_id},
+        )

prefect/client/orchestration/_blocks_documents/client.py

@@ -0,0 +1,334 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from httpx import HTTPStatusError
+
+from prefect.client.orchestration.base import BaseAsyncClient, BaseClient
+from prefect.exceptions import ObjectAlreadyExists, ObjectNotFound
+
+if TYPE_CHECKING:
+    from uuid import UUID
+
+    from prefect.client.schemas.actions import (
+        BlockDocumentCreate,
+        BlockDocumentUpdate,
+    )
+    from prefect.client.schemas.objects import (
+        BlockDocument,
+    )
+
+
+class BlocksDocumentClient(BaseClient):
+    def create_block_document(
+        self,
+        block_document: "BlockDocument | BlockDocumentCreate",
+        include_secrets: bool = True,
+    ) -> "BlockDocument":
+        """
+        Create a block document in the Prefect API. This data is used to configure a
+        corresponding Block.
+
+        Args:
+            include_secrets (bool): whether to include secret values
+                on the stored Block, corresponding to Pydantic's `SecretStr` and
+                `SecretBytes` fields. Note Blocks may not work as expected if
+                this is set to `False`.
+        """
+        block_document_data = block_document.model_dump(
+            mode="json",
+            exclude_unset=True,
+            exclude={"id", "block_schema", "block_type"},
+            context={"include_secrets": include_secrets},
+            serialize_as_any=True,
+        )
+        try:
+            response = self.request(
+                "POST",
+                "/block_documents/",
+                json=block_document_data,
+            )
+        except HTTPStatusError as e:
+            if e.response.status_code == 409:
+                raise ObjectAlreadyExists(http_exc=e) from e
+            else:
+                raise
+        from prefect.client.schemas.objects import BlockDocument
+
+        return BlockDocument.model_validate(response.json())
+
+    def update_block_document(
+        self,
+        block_document_id: "UUID",
+        block_document: "BlockDocumentUpdate",
+    ) -> None:
+        """
+        Update a block document in the Prefect API.
+        """
+        try:
+            self.request(
+                "PATCH",
+                "/block_documents/{id}",
+                path_params={"id": block_document_id},
+                json=block_document.model_dump(
+                    mode="json",
+                    exclude_unset=True,
+                    include={"data", "merge_existing_data", "block_schema_id"},
+                ),
+            )
+        except HTTPStatusError as e:
+            if e.response.status_code == 404:
+                raise ObjectNotFound(http_exc=e) from e
+            else:
+                raise
+
+    def delete_block_document(self, block_document_id: "UUID") -> None:
+        """
+        Delete a block document.
+        """
+        try:
+            self.request(
+                "DELETE",
+                "/block_documents/{id}",
+                path_params={"id": block_document_id},
+            )
+        except HTTPStatusError as e:
+            if e.response.status_code == 404:
+                raise ObjectNotFound(http_exc=e) from e
+            else:
+                raise
+
+    def read_block_document(
+        self,
+        block_document_id: "UUID",
+        include_secrets: bool = True,
+    ) -> "BlockDocument":
+        """
+        Read the block document with the specified ID.
+
+        Args:
+            block_document_id: the block document id
+            include_secrets (bool): whether to include secret values
+                on the Block, corresponding to Pydantic's `SecretStr` and
+                `SecretBytes` fields. These fields are automatically obfuscated
+                by Pydantic, but users can additionally choose not to receive
+                their values from the API. Note that any business logic on the
+                Block may not work if this is `False`.
+
+        Raises:
+            httpx.RequestError: if the block document was not found for any reason
+
+        Returns:
+            A block document or None.
+        """
+
+        try:
+            response = self.request(
+                "GET",
+                "/block_documents/{id}",
+                path_params={"id": block_document_id},
+                params=dict(include_secrets=include_secrets),
+            )
+        except HTTPStatusError as e:
+            if e.response.status_code == 404:
+                raise ObjectNotFound(http_exc=e) from e
+            else:
+                raise
+        from prefect.client.schemas.objects import BlockDocument
+
+        return BlockDocument.model_validate(response.json())
+
+    def read_block_documents(
+        self,
+        block_schema_type: str | None = None,
+        offset: int | None = None,
+        limit: int | None = None,
+        include_secrets: bool = True,
+    ) -> "list[BlockDocument]":
+        """
+        Read block documents
+
+        Args:
+            block_schema_type: an optional block schema type
+            offset: an offset
+            limit: the number of blocks to return
+            include_secrets (bool): whether to include secret values
+                on the Block, corresponding to Pydantic's `SecretStr` and
+                `SecretBytes` fields. These fields are automatically obfuscated
+                by Pydantic, but users can additionally choose not to receive
+                their values from the API. Note that any business logic on the
+                Block may not work if this is `False`.
+
+        Returns:
+            A list of block documents
+        """
+        response = self.request(
+            "POST",
+            "/block_documents/filter",
+            json=dict(
+                block_schema_type=block_schema_type,
+                offset=offset,
+                limit=limit,
+                include_secrets=include_secrets,
+            ),
+        )
+        from prefect.client.schemas.objects import BlockDocument
+
+        return BlockDocument.model_validate_list(response.json())
+
+
+class BlocksDocumentAsyncClient(BaseAsyncClient):
+    async def create_block_document(
+        self,
+        block_document: "BlockDocument | BlockDocumentCreate",
+        include_secrets: bool = True,
+    ) -> "BlockDocument":
+        """
+        Create a block document in the Prefect API. This data is used to configure a
+        corresponding Block.
+
+        Args:
+            include_secrets (bool): whether to include secret values
+                on the stored Block, corresponding to Pydantic's `SecretStr` and
+                `SecretBytes` fields. Note Blocks may not work as expected if
+                this is set to `False`.
+        """
+        block_document_data = block_document.model_dump(
+            mode="json",
+            exclude_unset=True,
+            exclude={"id", "block_schema", "block_type"},
+            context={"include_secrets": include_secrets},
+            serialize_as_any=True,
+        )
+        try:
+            response = await self.request(
+                "POST",
+                "/block_documents/",
+                json=block_document_data,
+            )
+        except HTTPStatusError as e:
+            if e.response.status_code == 409:
+                raise ObjectAlreadyExists(http_exc=e) from e
+            else:
+                raise
+        from prefect.client.schemas.objects import BlockDocument
+
+        return BlockDocument.model_validate(response.json())
+
+    async def update_block_document(
+        self,
+        block_document_id: "UUID",
+        block_document: "BlockDocumentUpdate",
+    ) -> None:
+        """
+        Update a block document in the Prefect API.
+        """
+        try:
+            await self.request(
+                "PATCH",
+                "/block_documents/{id}",
+                path_params={"id": block_document_id},
+                json=block_document.model_dump(
+                    mode="json",
+                    exclude_unset=True,
+                    include={"data", "merge_existing_data", "block_schema_id"},
+                ),
+            )
+        except HTTPStatusError as e:
+            if e.response.status_code == 404:
+                raise ObjectNotFound(http_exc=e) from e
+            else:
+                raise
+
+    async def delete_block_document(self, block_document_id: "UUID") -> None:
+        """
+        Delete a block document.
+        """
+        try:
+            await self.request(
+                "DELETE",
+                "/block_documents/{id}",
+                path_params={"id": block_document_id},
+            )
+        except HTTPStatusError as e:
+            if e.response.status_code == 404:
+                raise ObjectNotFound(http_exc=e) from e
+            else:
+                raise
+
+    async def read_block_document(
+        self,
+        block_document_id: "UUID",
+        include_secrets: bool = True,
+    ) -> "BlockDocument":
+        """
+        Read the block document with the specified ID.
+
+        Args:
+            block_document_id: the block document id
+            include_secrets (bool): whether to include secret values
+                on the Block, corresponding to Pydantic's `SecretStr` and
+                `SecretBytes` fields. These fields are automatically obfuscated
+                by Pydantic, but users can additionally choose not to receive
+                their values from the API. Note that any business logic on the
+                Block may not work if this is `False`.
+
+        Raises:
+            httpx.RequestError: if the block document was not found for any reason
+
+        Returns:
+            A block document or None.
+        """
+        try:
+            response = await self.request(
+                "GET",
+                "/block_documents/{id}",
+                path_params={"id": block_document_id},
+                params=dict(include_secrets=include_secrets),
+            )
+        except HTTPStatusError as e:
+            if e.response.status_code == 404:
+                raise ObjectNotFound(http_exc=e) from e
+            else:
+                raise
+        from prefect.client.schemas.objects import BlockDocument
+
+        return BlockDocument.model_validate(response.json())
+
+    async def read_block_documents(
+        self,
+        block_schema_type: str | None = None,
+        offset: int | None = None,
+        limit: int | None = None,
+        include_secrets: bool = True,
+    ) -> "list[BlockDocument]":
+        """
+        Read block documents
+
+        Args:
+            block_schema_type: an optional block schema type
+            offset: an offset
+            limit: the number of blocks to return
+            include_secrets (bool): whether to include secret values
+                on the Block, corresponding to Pydantic's `SecretStr` and
+                `SecretBytes` fields. These fields are automatically obfuscated
+                by Pydantic, but users can additionally choose not to receive
+                their values from the API. Note that any business logic on the
+                Block may not work if this is `False`.
+
+        Returns:
+            A list of block documents
+        """
+        response = await self.request(
+            "POST",
+            "/block_documents/filter",
+            json=dict(
+                block_schema_type=block_schema_type,
+                offset=offset,
+                limit=limit,
+                include_secrets=include_secrets,
+            ),
+        )
+        from prefect.client.schemas.objects import BlockDocument
+
+        return BlockDocument.model_validate_list(response.json())