prefect-client 2.16.3__py3-none-any.whl → 2.16.5__py3-none-any.whl

prefect/{packaging → deprecated/packaging}/file.py

@@ -1,5 +1,11 @@
+"""
+DEPRECATION WARNING:
+This module is deprecated as of March 2024 and will not be available after September 2024.
+"""
+
 from uuid import UUID
 
+from prefect._internal.compatibility.deprecated import deprecated_class
 from prefect._internal.pydantic import HAS_PYDANTIC_V2
 
 if HAS_PYDANTIC_V2:
@@ -12,15 +18,22 @@ from typing_extensions import Literal
 from prefect.blocks.core import Block
 from prefect.client.orchestration import PrefectClient
 from prefect.client.utilities import inject_client
+from prefect.deprecated.packaging.base import PackageManifest, Packager, Serializer
+from prefect.deprecated.packaging.serializers import SourceSerializer
 from prefect.filesystems import LocalFileSystem, ReadableFileSystem, WritableFileSystem
 from prefect.flows import Flow
-from prefect.packaging.base import PackageManifest, Packager, Serializer
-from prefect.packaging.serializers import SourceSerializer
 from prefect.settings import PREFECT_HOME
 from prefect.utilities.hashing import stable_hash
 
 
+@deprecated_class(start_date="Mar 2024")
 class FilePackageManifest(PackageManifest):
+    """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of version March 2024 and will not be available after September 2024.
+    """
+
     type: Literal["file"] = "file"
     serializer: Serializer
     key: str
@@ -34,12 +47,17 @@ class FilePackageManifest(PackageManifest):
         return self.serializer.loads(content)
 
 
+@deprecated_class(start_date="Mar 2024")
 class FilePackager(Packager):
     """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of version March 2024 and will not be available after September 2024.
+
     This packager stores the flow as a single file.
 
     By default, the file is the source code of the module the flow is defined in.
-    Alternative serialization modes are available in `prefect.packaging.serializers`.
+    Alternative serialization modes are available in `prefect.deprecated.packaging.serializers`.
     """
 
     type: Literal["file"] = "file"

prefect/{packaging → deprecated/packaging}/orion.py

@@ -1,5 +1,11 @@
+"""
+DEPRECATION WARNING:
+This module is deprecated as of March 2024 and will not be available after September 2024.
+"""
+
 from uuid import UUID
 
+from prefect._internal.compatibility.deprecated import deprecated_class
 from prefect._internal.pydantic import HAS_PYDANTIC_V2
 
 if HAS_PYDANTIC_V2:
@@ -12,12 +18,19 @@ from typing_extensions import Literal
 from prefect.blocks.system import JSON
 from prefect.client.orchestration import PrefectClient
 from prefect.client.utilities import inject_client
+from prefect.deprecated.packaging.base import PackageManifest, Packager, Serializer
+from prefect.deprecated.packaging.serializers import SourceSerializer
 from prefect.flows import Flow
-from prefect.packaging.base import PackageManifest, Packager, Serializer
-from prefect.packaging.serializers import SourceSerializer
 
 
+@deprecated_class(start_date="Mar 2024")
 class OrionPackageManifest(PackageManifest):
+    """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of version March 2024 and will not be available after September 2024.
+    """
+
     type: Literal["orion"] = "orion"
     serializer: Serializer
     block_document_id: UUID
@@ -31,13 +44,18 @@ class OrionPackageManifest(PackageManifest):
         return self.serializer.loads(serialized_flow.encode())
 
 
+@deprecated_class(start_date="Mar 2024")
 class OrionPackager(Packager):
     """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of version March 2024 and will not be available after September 2024.
+
     This packager stores the flow as an anonymous JSON block in the Prefect database.
     The content of the block are encrypted at rest.
 
     By default, the content is the source code of the module the flow is defined in.
-    Alternative serialization modes are available in `prefect.packaging.serializers`.
+    Alternative serialization modes are available in `prefect.deprecated.packaging.serializers`.
     """
 
     type: Literal["orion"] = "orion"

prefect/{packaging → deprecated/packaging}/serializers.py

@@ -1,3 +1,8 @@
+"""
+DEPRECATION WARNING:
+This module is deprecated as of March 2024 and will not be available after September 2024.
+"""
+
 import base64
 import inspect
 import json
@@ -7,6 +12,7 @@ from pathlib import Path
 from tempfile import TemporaryDirectory
 from typing import Any, List
 
+from prefect._internal.compatibility.deprecated import deprecated_class
 from prefect._internal.pydantic import HAS_PYDANTIC_V2
 
 if HAS_PYDANTIC_V2:
@@ -16,7 +22,7 @@ else:
 
 from typing_extensions import Literal
 
-from prefect.packaging.base import Serializer
+from prefect.deprecated.packaging.base import Serializer
 from prefect.utilities.importtools import (
     from_qualified_name,
     load_script_as_module,
@@ -24,8 +30,13 @@ from prefect.utilities.importtools import (
 )
 
 
+@deprecated_class(start_date="Mar 2024")
 class PickleSerializer(Serializer):
     """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of version March 2024 and will not be available after September 2024.
+
     Serializes objects using the pickle protocol.
 
     If using cloudpickle, you may specify a list of 'pickle_modules'. These modules will
@@ -127,8 +138,13 @@ class PickleSerializer(Serializer):
         return pickler.loads(base64.decodebytes(blob))
 
 
+@deprecated_class(start_date="Mar 2024")
 class SourceSerializer(Serializer):
     """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of version March 2024 and will not be available after September 2024.
+
     Serializes objects by retrieving the source code of the module they are defined in.
 
     Creates a JSON blob with keys:
@@ -185,8 +201,13 @@ class SourceSerializer(Serializer):
         return getattr(module, document["symbol_name"])
 
 
+@deprecated_class(start_date="Mar 2024")
 class ImportSerializer(Serializer):
     """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of version March 2024 and will not be available after September 2024.
+
     Serializes objects by storing their importable path.
     """
 

prefect/engine.py

@@ -2002,10 +2002,14 @@ async def orchestrate_task_run(
     )
 
     # Emit an event to capture that the task run was in the `PENDING` state.
-    last_event = _emit_task_run_state_change_event(
+    last_event = emit_task_run_state_change_event(
         task_run=task_run, initial_state=None, validated_state=task_run.state
     )
-    last_state = task_run.state
+    last_state = (
+        Pending()
+        if flow_run_context and flow_run_context.autonomous_task_run
+        else task_run.state
+    )
 
     # Completed states with persisted results should have result data. If it's missing,
     # this could be a manual state transition, so we should use the Unknown result type
@@ -2094,7 +2098,7 @@ async def orchestrate_task_run(
                 break
 
     # Emit an event to capture the result of proposing a `RUNNING` state.
-    last_event = _emit_task_run_state_change_event(
+    last_event = emit_task_run_state_change_event(
         task_run=task_run,
         initial_state=last_state,
         validated_state=state,
@@ -2187,7 +2191,7 @@ async def orchestrate_task_run(
                     await _check_task_failure_retriable(task, task_run, terminal_state)
                 )
             state = await propose_state(client, terminal_state, task_run_id=task_run.id)
-            last_event = _emit_task_run_state_change_event(
+            last_event = emit_task_run_state_change_event(
                 task_run=task_run,
                 initial_state=last_state,
                 validated_state=state,
@@ -2220,7 +2224,7 @@ async def orchestrate_task_run(
                 )
                 # Attempt to enter a running state again
                 state = await propose_state(client, Running(), task_run_id=task_run.id)
-                last_event = _emit_task_run_state_change_event(
+                last_event = emit_task_run_state_change_event(
                     task_run=task_run,
                     initial_state=last_state,
                     validated_state=state,
@@ -2896,7 +2900,7 @@ async def check_api_reachable(client: PrefectClient, fail_message: str):
     API_HEALTHCHECKS[api_url] = get_deadline(60 * 10)
 
 
-def _emit_task_run_state_change_event(
+def emit_task_run_state_change_event(
     task_run: TaskRun,
     initial_state: Optional[State],
     validated_state: State,

prefect/events/clients.py

@@ -330,14 +330,20 @@ class PrefectCloudEventSubscriber:
         )
 
         try:
-            message = orjson.loads(await self._websocket.recv())
+            message: Dict[str, Any] = orjson.loads(await self._websocket.recv())
             logger.debug("  auth result %s", message)
-            assert message["type"] == "auth_success"
+            assert message["type"] == "auth_success", message.get("reason", "")
         except (AssertionError, ConnectionClosedError) as e:
             if isinstance(e, AssertionError) or e.code == WS_1008_POLICY_VIOLATION:
+                if isinstance(e, AssertionError):
+                    reason = e.args[0]
+                elif isinstance(e, ConnectionClosedError):
+                    reason = e.reason
+
                 raise Exception(
                     "Unable to authenticate to the event stream. Please ensure the "
-                    "provided api_key you are using is valid for this environment."
+                    "provided api_key you are using is valid for this environment. "
+                    f"Reason: {reason}"
                 ) from e
             raise
 

prefect/events/related.py

@@ -74,7 +74,7 @@ async def related_resources_from_run_context(
     if flow_run_id is None:
         return []
 
-    related_objects: list[ResourceCacheEntry] = []
+    related_objects: List[ResourceCacheEntry] = []
 
     async with get_client() as client:
 

prefect/events/schemas.py

@@ -372,9 +372,53 @@ class MetricTrigger(ResourceTrigger):
     )
 
 
-TriggerTypes: TypeAlias = Union[EventTrigger, MetricTrigger]
+class CompositeTrigger(Trigger, abc.ABC):
+    """
+    Requires some number of triggers to have fired within the given time period.
+    """
+
+    type: Literal["compound", "sequence"]
+    triggers: List["TriggerTypes"]
+    within: Optional[timedelta]
+
+
+class CompoundTrigger(CompositeTrigger):
+    """A composite trigger that requires some number of triggers to have
+    fired within the given time period"""
+
+    type: Literal["compound"] = "compound"
+    require: Union[int, Literal["any", "all"]]
+
+    @root_validator
+    def validate_require(cls, values: Dict[str, Any]) -> Dict[str, Any]:
+        require = values.get("require")
+
+        if isinstance(require, int):
+            if require < 1:
+                raise ValueError("required must be at least 1")
+            if require > len(values["triggers"]):
+                raise ValueError(
+                    "required must be less than or equal to the number of triggers"
+                )
+
+        return values
+
+
+class SequenceTrigger(CompositeTrigger):
+    """A composite trigger that requires some number of triggers to have fired
+    within the given time period in a specific order"""
+
+    type: Literal["sequence"] = "sequence"
+
+
+TriggerTypes: TypeAlias = Union[
+    EventTrigger, MetricTrigger, CompoundTrigger, SequenceTrigger
+]
 """The union of all concrete trigger types that a user may actually create"""
 
+CompoundTrigger.update_forward_refs()
+SequenceTrigger.update_forward_refs()
+
 
 class Automation(PrefectBaseModel):
     """Defines an action a user wants to take when a certain number of events

prefect/filesystems.py

@@ -10,6 +10,7 @@ from typing import Any, Dict, Optional, Tuple, Union
 import anyio
 import fsspec
 
+from prefect._internal.compatibility.deprecated import deprecated_class
 from prefect._internal.pydantic import HAS_PYDANTIC_V2
 
 if HAS_PYDANTIC_V2:
@@ -435,8 +436,17 @@ class RemoteFileSystem(WritableFileSystem, WritableDeploymentStorage):
         return self._filesystem
 
 
+@deprecated_class(
+    start_date="Mar 2024", help="Use the `S3Bucket` block from prefect-aws instead."
+)
 class S3(WritableFileSystem, WritableDeploymentStorage):
     """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of March 2024 and will not be available after September 2024.
+    It has been replaced by `S3Bucket` from the `prefect-aws` package, which offers enhanced functionality
+    and better a better user experience.
+
     Store data as a file on AWS S3.
 
     Example:
@@ -526,8 +536,16 @@ class S3(WritableFileSystem, WritableDeploymentStorage):
         return await self.filesystem.write_path(path=path, content=content)
 
 
+@deprecated_class(
+    start_date="Mar 2024", help="Use the `GcsBucket` block from prefect-gcp instead."
+)
 class GCS(WritableFileSystem, WritableDeploymentStorage):
     """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of March 2024 and will not be available after September 2024.
+    It has been replaced by `GcsBucket` from the `prefect-gcp` package, which offers enhanced functionality
+    and better a better user experience.
     Store data as a file on Google Cloud Storage.
 
     Example:
@@ -619,8 +637,18 @@ class GCS(WritableFileSystem, WritableDeploymentStorage):
         return await self.filesystem.write_path(path=path, content=content)
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help="Use the `AzureBlobStorageContainer` block from prefect-azure instead.",
+)
 class Azure(WritableFileSystem, WritableDeploymentStorage):
     """
+    DEPRECATION WARNING:
+
+    This class is deprecated as of March 2024 and will not be available after September 2024.
+    It has been replaced by `AzureBlobStorageContainer` from the `prefect-azure` package, which
+    offers enhanced functionality and better a better user experience.
+
     Store data as a file on Azure Datalake and Azure Blob Storage.
 
     Example:
@@ -869,9 +897,19 @@ class SMB(WritableFileSystem, WritableDeploymentStorage):
         return await self.filesystem.write_path(path=path, content=content)
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help="Use the `GitHubRepository` block from prefect-github instead.",
+)
 class GitHub(ReadableDeploymentStorage):
     """
-    Interact with files stored on GitHub repositories.
+        DEPRECATION WARNING:
+
+        This class is deprecated as of March 2024 and will not be available after September 2024.
+        It has been replaced by `GitHubRepository` from the `prefect-github` package, which offers
+        enhanced functionality and better a better user experience.
+    q
+        Interact with files stored on GitHub repositories.
     """
 
     _block_type_name = "GitHub"

prefect/flows.py

@@ -1345,8 +1345,12 @@ def flow(
     result_serializer: Optional[ResultSerializer] = None,
     cache_result_in_memory: bool = True,
     log_prints: Optional[bool] = None,
-    on_completion: Optional[List[Callable[[FlowSchema, FlowRun, State], None]]] = None,
-    on_failure: Optional[List[Callable[[FlowSchema, FlowRun, State], None]]] = None,
+    on_completion: Optional[
+        List[Callable[[FlowSchema, FlowRun, State], Union[Awaitable[None], None]]]
+    ] = None,
+    on_failure: Optional[
+        List[Callable[[FlowSchema, FlowRun, State], Union[Awaitable[None], None]]]
+    ] = None,
     on_cancellation: Optional[
         List[Callable[[FlowSchema, FlowRun, State], None]]
     ] = None,
@@ -1373,8 +1377,12 @@ def flow(
     result_serializer: Optional[ResultSerializer] = None,
     cache_result_in_memory: bool = True,
     log_prints: Optional[bool] = None,
-    on_completion: Optional[List[Callable[[FlowSchema, FlowRun, State], None]]] = None,
-    on_failure: Optional[List[Callable[[FlowSchema, FlowRun, State], None]]] = None,
+    on_completion: Optional[
+        List[Callable[[FlowSchema, FlowRun, State], Union[Awaitable[None], None]]]
+    ] = None,
+    on_failure: Optional[
+        List[Callable[[FlowSchema, FlowRun, State], Union[Awaitable[None], None]]]
+    ] = None,
     on_cancellation: Optional[
         List[Callable[[FlowSchema, FlowRun, State], None]]
     ] = None,

prefect/infrastructure/base.py

@@ -1,3 +1,11 @@
+"""
+DEPRECATION WARNING:
+
+This module is deprecated as of March 2024 and will not be available after September 2024.
+Infrastructure blocks have been replaced by workers, which offer enhanced functionality and better performance.
+
+For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.
+"""
 import abc
 import shlex
 import warnings
@@ -5,6 +13,7 @@ from typing import TYPE_CHECKING, Dict, List, Optional
 
 import anyio.abc
 
+from prefect._internal.compatibility.deprecated import deprecated_class
 from prefect._internal.compatibility.experimental import (
     EXPERIMENTAL_WARNING,
     ExperimentalFeature,
@@ -48,6 +57,12 @@ class InfrastructureResult(pydantic.BaseModel, abc.ABC):
         return self.status_code == 0
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help="Use the `BaseWorker` class to create custom infrastructure integrations instead."
+    " Refer to the upgrade guide for more information:"
+    " https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.",
+)
 class Infrastructure(Block, abc.ABC):
     _block_schema_capabilities = ["run-infrastructure"]
 

prefect/infrastructure/container.py

@@ -1,3 +1,11 @@
+"""
+DEPRECATION WARNING:
+
+This module is deprecated as of March 2024 and will not be available after September 2024.
+It has been replaced by the Docker worker from the prefect-docker package, which offers enhanced functionality and better performance.
+
+For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.
+"""
 import json
 import re
 import shlex
@@ -10,6 +18,7 @@ from typing import TYPE_CHECKING, Dict, Generator, List, Optional, Tuple, Union
 import anyio.abc
 import packaging.version
 
+from prefect._internal.compatibility.deprecated import deprecated_class
 from prefect._internal.pydantic import HAS_PYDANTIC_V2
 
 if HAS_PYDANTIC_V2:
@@ -54,6 +63,10 @@ class ImagePullPolicy(AutoEnum):
     NEVER = AutoEnum.auto()
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help="Use the `DockerRegistryCredentials` class from prefect-docker instead.",
+)
 class BaseDockerLogin(Block, ABC):
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/14a315b79990200db7341e42553e23650b34bb96-250x250.png"
     _block_schema_capabilities = ["docker-login"]
@@ -105,6 +118,10 @@ class BaseDockerLogin(Block, ABC):
         return docker_client
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help="Use the `DockerRegistryCredentials` class from prefect-docker instead.",
+)
 class DockerRegistry(BaseDockerLogin):
     """
     Connects to a Docker registry.
@@ -170,6 +187,12 @@ class DockerContainerResult(InfrastructureResult):
     """Contains information about a completed Docker container"""
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help="Use the Docker worker from prefect-docker instead."
+    " Refer to the upgrade guide for more information:"
+    " https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.",
+)
 class DockerContainer(Infrastructure):
     """
     Runs a command in a container.

prefect/infrastructure/kubernetes.py

@@ -1,3 +1,11 @@
+"""
+DEPRECATION WARNING:
+
+This module is deprecated as of March 2024 and will not be available after September 2024.
+It has been replaced by the Kubernetes worker from the prefect-kubernetes package, which offers enhanced functionality and better performance.
+
+For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.
+"""
 import copy
 import enum
 import json
@@ -11,6 +19,9 @@ from typing import TYPE_CHECKING, Any, Dict, Generator, List, Optional, Tuple, U
 import anyio.abc
 import yaml
 
+from prefect._internal.compatibility.deprecated import (
+    deprecated_class,
+)
 from prefect._internal.pydantic import HAS_PYDANTIC_V2
 
 if HAS_PYDANTIC_V2:
@@ -58,6 +69,12 @@ class KubernetesJobResult(InfrastructureResult):
     """Contains information about the final state of a completed Kubernetes Job"""
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help="Use the Kubernetes worker from prefect-kubernetes instead."
+    " Refer to the upgrade guide for more information:"
+    " https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.",
+)
 class KubernetesJob(Infrastructure):
     """
     Runs a command as a Kubernetes Job.

prefect/infrastructure/process.py

@@ -1,3 +1,12 @@
+"""
+DEPRECATION WARNING:
+
+This module is deprecated as of March 2024 and will not be available after September 2024.
+It has been replaced by the process worker from the `prefect.workers` module, which offers enhanced functionality and better performance.
+
+For upgrade instructions, see https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.
+"""
+
 import asyncio
 import contextlib
 import os
@@ -14,6 +23,7 @@ import anyio
 import anyio.abc
 import sniffio
 
+from prefect._internal.compatibility.deprecated import deprecated_class
 from prefect._internal.pydantic import HAS_PYDANTIC_V2
 
 if HAS_PYDANTIC_V2:
@@ -57,6 +67,12 @@ def _parse_infrastructure_pid(infrastructure_pid: str) -> Tuple[str, int]:
     return hostname, int(pid)
 
 
+@deprecated_class(
+    start_date="Mar 2024",
+    help="Use the process worker instead."
+    " Refer to the upgrade guide for more information:"
+    " https://docs.prefect.io/latest/guides/upgrade-guide-agents-to-workers/.",
+)
 class Process(Infrastructure):
     """
     Run a command in a new process.

prefect/server/api/collections_data/views/aggregate-worker-metadata.json

@@ -912,8 +912,7 @@
             "metadata": {
               "name": "{{ name }}",
               "annotations": {
-                "run.googleapis.com/launch-stage": "BETA",
-                "run.googleapis.com/vpc-access-connector": "{{ vpc_connector_name }}"
+                "run.googleapis.com/launch-stage": "BETA"
               }
             },
             "spec": {
@@ -941,6 +940,11 @@
                       "serviceAccountName": "{{ service_account_name }}"
                     }
                   }
+                },
+                "metadata": {
+                  "annotations": {
+                    "run.googleapis.com/vpc-access-connector": "{{ vpc_connector_name }}"
+                  }
                 }
               }
             }
@@ -1093,8 +1097,10 @@
             "launchStage": "{{ launch_stage }}",
             "template": {
               "template": {
+                "serviceAccount": "{{ service_account_name }}",
                 "maxRetries": "{{ max_retries }}",
                 "timeout": "{{ timeout }}",
+                "vpcAccess": "{{ vpc_connector_name }}",
                 "containers": [
                   {
                     "env": [],
@@ -1229,6 +1235,12 @@
               "title": "VPC Connector Name",
               "description": "The name of the VPC connector to use for the Cloud Run job.",
               "type": "string"
+            },
+            "service_account_name": {
+              "title": "Service Account Name",
+              "description": "The name of the service account to use for the task execution of Cloud Run Job. By default Cloud Run jobs run as the default Compute Engine Service Account.",
+              "example": "service-account@example.iam.gserviceaccount.com",
+              "type": "string"
             }
           },
           "definitions": {