prefect-client 3.3.5.dev3__tar.gz → 3.3.6__tar.gz

{prefect_client-3.3.5.dev3 → prefect_client-3.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prefect-client
-Version: 3.3.5.dev3
+Version: 3.3.6
 Summary: Workflow orchestration and management.
 Project-URL: Changelog, https://github.com/PrefectHQ/prefect/releases
 Project-URL: Documentation, https://docs.prefect.io
@@ -47,7 +47,7 @@ Requires-Dist: prometheus-client>=0.20.0
 Requires-Dist: pydantic!=2.10.0,<3.0.0,>=2.9
 Requires-Dist: pydantic-core<3.0.0,>=2.12.0
 Requires-Dist: pydantic-extra-types<3.0.0,>=2.8.2
-Requires-Dist: pydantic-settings>2.2.1
+Requires-Dist: pydantic-settings!=2.9.0,<3.0.0,>2.2.1
 Requires-Dist: python-dateutil<3.0.0,>=2.8.2
 Requires-Dist: python-slugify<9.0,>=5.0
 Requires-Dist: python-socks[asyncio]<3.0,>=2.5.3

{prefect_client-3.3.5.dev3 → prefect_client-3.3.6}/pyproject.toml

@@ -51,7 +51,7 @@ dependencies = [
     "pydantic>=2.9,<3.0.0,!=2.10.0",
     "pydantic_core>=2.12.0,<3.0.0",
     "pydantic_extra_types>=2.8.2,<3.0.0",
-    "pydantic_settings>2.2.1",
+    "pydantic_settings>2.2.1,<3.0.0,!=2.9.0",
     "python-dateutil>=2.8.2,<3.0.0",
     "python-slugify>=5.0,<9.0",
     "python-socks[asyncio]>=2.5.3,<3.0",

prefect_client-3.3.6/src/prefect/_build_info.py

@@ -0,0 +1,5 @@
+# Generated by versioningit
+__version__ = "3.3.6"
+__build_date__ = "2025-04-24 19:25:40.923968+00:00"
+__git_commit__ = "01441afa228e34271ccd1ec7cacc03a23a20ec30"
+__dirty__ = False

prefect_client-3.3.5.dev3/src/prefect/_experimental/bundles.py → prefect_client-3.3.6/src/prefect/_experimental/bundles/__init__.py

@@ -8,9 +8,10 @@ import multiprocessing.context
 import os
 import subprocess
 import sys
+from pathlib import Path
 from typing import Any, TypedDict
 
-import cloudpickle
+import cloudpickle  # pyright: ignore[reportMissingTypeStubs]
 
 from prefect.client.schemas.objects import FlowRun
 from prefect.context import SettingsContext, get_settings_context, serialize_context
@@ -21,12 +22,18 @@ from prefect.settings.context import get_current_settings
 from prefect.settings.models.root import Settings
 from prefect.utilities.slugify import slugify
 
-try:
-    import uv
+from .execute import execute_bundle_from_file
 
-    uv_path = uv.find_uv_bin()
-except (ImportError, ModuleNotFoundError):
-    uv_path = "uv"
+
+def _get_uv_path() -> str:
+    try:
+        import uv
+
+        uv_path = uv.find_uv_bin()
+    except (ImportError, ModuleNotFoundError):
+        uv_path = "uv"
+
+    return uv_path
 
 
 class SerializedBundle(TypedDict):
@@ -45,7 +52,7 @@ def _serialize_bundle_object(obj: Any) -> str:
     """
     Serializes an object to a string.
     """
-    return base64.b64encode(gzip.compress(cloudpickle.dumps(obj))).decode()
+    return base64.b64encode(gzip.compress(cloudpickle.dumps(obj))).decode()  # pyright: ignore[reportUnknownMemberType]
 
 
 def _deserialize_bundle_object(serialized_obj: str) -> Any:
@@ -79,7 +86,7 @@ def create_bundle_for_flow_run(
         "flow_run": flow_run.model_dump(mode="json"),
         "dependencies": subprocess.check_output(
             [
-                uv_path,
+                _get_uv_path(),
                 "pip",
                 "freeze",
                 # Exclude editable installs because we won't be able to install them in the execution environment
@@ -99,7 +106,9 @@ def extract_flow_from_bundle(bundle: SerializedBundle) -> Flow[Any, Any]:
 
 
 def _extract_and_run_flow(
-    bundle: SerializedBundle, env: dict[str, Any] | None = None
+    bundle: SerializedBundle,
+    cwd: Path | str | None = None,
+    env: dict[str, Any] | None = None,
 ) -> None:
     """
     Extracts a flow from a bundle and runs it.
@@ -108,6 +117,7 @@ def _extract_and_run_flow(
 
     Args:
         bundle: The bundle to extract and run.
+        cwd: The working directory to use when running the flow.
         env: The environment to use when running the flow.
     """
 
@@ -120,6 +130,9 @@ def _extract_and_run_flow(
     context = _deserialize_bundle_object(bundle["context"])
     flow_run = FlowRun.model_validate(bundle["flow_run"])
 
+    if cwd:
+        os.chdir(cwd)
+
     with SettingsContext(
         profile=settings_context.profile,
         settings=Settings(),
@@ -138,6 +151,8 @@ def _extract_and_run_flow(
 
 def execute_bundle_in_subprocess(
     bundle: SerializedBundle,
+    env: dict[str, Any] | None = None,
+    cwd: Path | str | None = None,
 ) -> multiprocessing.context.SpawnProcess:
     """
     Executes a bundle in a subprocess.
@@ -150,11 +165,12 @@ def execute_bundle_in_subprocess(
     """
 
     ctx = multiprocessing.get_context("spawn")
+    env = env or {}
 
     # Install dependencies if necessary
     if dependencies := bundle.get("dependencies"):
         subprocess.check_call(
-            [uv_path, "pip", "install", *dependencies.split("\n")],
+            [_get_uv_path(), "pip", "install", *dependencies.split("\n")],
             # Copy the current environment to ensure we install into the correct venv
             env=os.environ,
         )
@@ -164,7 +180,9 @@ def execute_bundle_in_subprocess(
         kwargs={
             "bundle": bundle,
             "env": get_current_settings().to_environment_variables(exclude_unset=True)
-            | os.environ,
+            | os.environ
+            | env,
+            "cwd": cwd,
         },
     )
 
@@ -226,3 +244,13 @@ def convert_step_to_command(
     command.extend(["--key", key])
 
     return command
+
+
+__all__ = [
+    "execute_bundle_from_file",
+    "convert_step_to_command",
+    "create_bundle_for_flow_run",
+    "extract_flow_from_bundle",
+    "execute_bundle_in_subprocess",
+    "SerializedBundle",
+]

prefect_client-3.3.6/src/prefect/_experimental/bundles/execute.py

@@ -0,0 +1,34 @@
+import json
+
+import typer
+
+from prefect.utilities.asyncutils import run_coro_as_sync
+
+
+def execute_bundle_from_file(key: str):
+    """
+    Loads a bundle from a file and executes it.
+
+    Args:
+        key: The key of the bundle to execute.
+    """
+    with open(key, "r") as f:
+        bundle = json.load(f)
+
+    from prefect.runner.runner import Runner
+
+    run_coro_as_sync(Runner().execute_bundle(bundle))
+
+
+def _execute_bundle_from_file(key: str = typer.Option(...)):
+    """
+    Loads a bundle from a file and executes it.
+
+    Args:
+        key: The key of the bundle to execute.
+    """
+    execute_bundle_from_file(key)
+
+
+if __name__ == "__main__":
+    typer.run(_execute_bundle_from_file)

prefect_client-3.3.6/src/prefect/_versioning.py

@@ -0,0 +1,180 @@
+from __future__ import annotations
+
+import os
+from enum import Enum
+from typing import Any, Callable, Coroutine, Dict, Literal, Optional
+from urllib.parse import urlparse
+
+from anyio import run_process
+from pydantic import Field, model_validator
+
+from prefect.client.schemas.objects import VersionInfo
+
+
+class SimpleVersionInfo(VersionInfo):
+    type: Literal["prefect:simple"] = "prefect:simple"
+    version: str = Field(default="")
+    branch: Optional[str] = Field(default=None)
+    url: Optional[str] = Field(default=None)
+
+
+class GithubVersionInfo(VersionInfo):
+    type: Literal["vcs:github"] = "vcs:github"
+    version: str
+    branch: str
+    url: str
+    repository: str
+
+    @model_validator(mode="after")
+    def validate_branch(self):
+        if not self.branch:
+            raise ValueError("branch is required when type is 'vcs:github'")
+        return self
+
+
+class GitVersionInfo(VersionInfo):
+    type: Literal["vcs:git"] = "vcs:git"
+    version: str
+    branch: str
+    url: str
+    repository: str
+
+
+async def get_github_version_info(
+    version: Optional[str] = None,
+    branch: Optional[str] = None,
+    repository: Optional[str] = None,
+    url: Optional[str] = None,
+) -> GithubVersionInfo:
+    """Create a GithubVersionInfo object from provided values or environment variables.
+
+    Args:
+        version: The commit SHA, falls back to GITHUB_SHA env var
+        branch: The git branch, falls back to GITHUB_REF_NAME env var
+        repository: The repository name, falls back to GITHUB_REPOSITORY env var
+        url: The repository URL, constructed from GITHUB_SERVER_URL/GITHUB_REPOSITORY if not provided
+
+    Returns:
+        A GithubVersionInfo
+
+    Raises:
+        ValueError: If any required fields cannot be determined
+    """
+    version = version or os.getenv("GITHUB_SHA")
+    branch = branch or os.getenv("GITHUB_REF_NAME")
+    repository = repository or os.getenv("GITHUB_REPOSITORY")
+    url = url or f"{os.getenv('GITHUB_SERVER_URL')}/{repository}"
+
+    if not version:
+        raise ValueError("version is required - must be provided or set in GITHUB_SHA")
+    if not branch:
+        raise ValueError(
+            "branch is required - must be provided or set in GITHUB_REF_NAME"
+        )
+    if not repository:
+        raise ValueError(
+            "repository is required - must be provided or set in GITHUB_REPOSITORY"
+        )
+
+    return GithubVersionInfo(
+        type="vcs:github",
+        version=version,
+        branch=branch,
+        repository=repository,
+        url=url,
+    )
+
+
+async def get_git_version_info(
+    version: Optional[str] = None,
+    branch: Optional[str] = None,
+    url: Optional[str] = None,
+    repository: Optional[str] = None,
+) -> GitVersionInfo:
+    try:
+        if not version:
+            # Run git command and get stdout
+            result = await run_process(["git", "rev-parse", "HEAD"])
+            # Decode bytes to string and strip whitespace
+            version = result.stdout.decode().strip()
+
+        if not branch:
+            result = await run_process(["git", "rev-parse", "--abbrev-ref", "HEAD"])
+            branch = result.stdout.decode().strip()
+
+        if not repository:
+            result = await run_process(["git", "config", "--get", "remote.origin.url"])
+            remote_url = result.stdout.decode().strip()
+
+            # Extract just the repository name (last part of the path)
+            repo_url = urlparse(remote_url)
+            repository = repo_url.path.strip("/")
+            if repository.endswith(".git"):
+                repository = repository[:-4]
+
+        if not url and repository:
+            # Use the full remote URL as the URL
+            result = await run_process(["git", "config", "--get", "remote.origin.url"])
+            url = result.stdout.decode().strip()
+    except Exception as e:
+        raise ValueError(
+            f"Error getting git version info: {e}. You may not be in a git repository."
+        )
+
+    if not url:
+        raise ValueError("Could not determine git repository URL")
+
+    return GitVersionInfo(
+        type="vcs:git", version=version, branch=branch, url=url, repository=repository
+    )
+
+
+class VersionType(str, Enum):
+    SIMPLE = "prefect:simple"
+    GITHUB = "vcs:github"
+    GIT = "vcs:git"
+    DOCKER = "container:docker"
+
+
+async def get_inferred_version_info(
+    version_type: Optional[str] = None,
+) -> VersionInfo | None:
+    """
+    Attempts to infer version information from the environment.
+
+    Args:
+        version_type: Optional type of version info to get. If provided, only that
+                     type will be attempted.
+
+    Returns:
+        VersionInfo: The inferred version information
+
+    Raises:
+        ValueError: If unable to infer version info from any source
+    """
+    # Map version types to their getter functions
+    type_to_getter: Dict[str, Callable[..., Coroutine[Any, Any, Any]]] = {
+        VersionType.GITHUB: get_github_version_info,
+        VersionType.GIT: get_git_version_info,
+    }
+
+    # Default order of getters to try
+    default_getters = [
+        get_github_version_info,
+        get_git_version_info,
+    ]
+
+    if version_type:
+        if version_type not in type_to_getter:
+            raise ValueError(f"Unknown version type: {version_type}")
+        getters = [type_to_getter[version_type]]
+    else:
+        getters = default_getters
+
+    for getter in getters:
+        try:
+            return await getter()
+        except ValueError:
+            continue
+
+    return None

{prefect_client-3.3.5.dev3 → prefect_client-3.3.6}/src/prefect/cache_policies.py

@@ -33,9 +33,9 @@ def _register_stable_transforms() -> None:
     so that cache keys that utilize them are deterministic across invocations.
     """
     try:
-        import pandas as pd
+        import pandas as pd  # pyright: ignore
 
-        STABLE_TRANSFORMS[pd.DataFrame] = lambda df: [
+        STABLE_TRANSFORMS[pd.DataFrame] = lambda df: [  # pyright: ignore
             df[col] for col in sorted(df.columns)
         ]
     except (ImportError, ModuleNotFoundError):
@@ -183,7 +183,7 @@ class CompoundCachePolicy(CachePolicy):
     Any keys that return `None` will be ignored.
     """
 
-    policies: list[CachePolicy] = field(default_factory=list)
+    policies: list[CachePolicy] = field(default_factory=lambda: [])
 
     def __post_init__(self) -> None:
         # flatten any CompoundCachePolicies
@@ -349,7 +349,7 @@ class Inputs(CachePolicy):
     Policy that computes a cache key based on a hash of the runtime inputs provided to the task..
     """
 
-    exclude: list[str] = field(default_factory=list)
+    exclude: list[str] = field(default_factory=lambda: [])
 
     def compute_key(
         self,

{prefect_client-3.3.5.dev3 → prefect_client-3.3.6}/src/prefect/client/orchestration/_deployments/client.py

@@ -153,13 +153,14 @@ class DeploymentClient(BaseClient):
             if getattr(deployment_create, field) is None:
                 exclude.add(field)
 
-        json = deployment_create.model_dump(mode="json", exclude=exclude)
+        payload = deployment_create.model_dump(mode="json", exclude=exclude)
+        if deployment_create.version_info:
+            payload["version_info"] = deployment_create.version_info.model_dump(
+                mode="json"
+            )
+
+        response = self.request("POST", "/deployments/", json=payload)
 
-        response = self.request(
-            "POST",
-            "/deployments/",
-            json=json,
-        )
         deployment_id = response.json().get("id")
         if not deployment_id:
             raise RequestError(f"Malformed response: {response}")
@@ -179,15 +180,28 @@ class DeploymentClient(BaseClient):
         deployment_id: UUID,
         deployment: "DeploymentUpdate",
     ) -> None:
+        exclude_if_none = [
+            "version_info",
+        ]
+
+        exclude = {"name", "flow_name", "triggers"}
+        for field in exclude_if_none:
+            if getattr(deployment, field) is None:
+                exclude.add(field)
+
+        payload = deployment.model_dump(
+            mode="json",
+            exclude_unset=True,
+            exclude=exclude,
+        )
+        if deployment.version_info:
+            payload["version_info"] = deployment.version_info.model_dump(mode="json")
+
         self.request(
             "PATCH",
             "/deployments/{id}",
             path_params={"id": deployment_id},
-            json=deployment.model_dump(
-                mode="json",
-                exclude_unset=True,
-                exclude={"name", "flow_name", "triggers"},
-            ),
+            json=payload,
         )
 
     def _create_deployment_from_schema(self, schema: "DeploymentCreate") -> UUID:
@@ -733,13 +747,13 @@ class DeploymentAsyncClient(BaseAsyncClient):
             if getattr(deployment_create, field) is None:
                 exclude.add(field)
 
-        json = deployment_create.model_dump(mode="json", exclude=exclude)
+        payload = deployment_create.model_dump(mode="json", exclude=exclude)
+        if deployment_create.version_info:
+            payload["version_info"] = deployment_create.version_info.model_dump(
+                mode="json"
+            )
 
-        response = await self.request(
-            "POST",
-            "/deployments/",
-            json=json,
-        )
+        response = await self.request("POST", "/deployments/", json=payload)
         deployment_id = response.json().get("id")
         if not deployment_id:
             raise RequestError(f"Malformed response: {response}")
@@ -761,15 +775,28 @@ class DeploymentAsyncClient(BaseAsyncClient):
         deployment_id: UUID,
         deployment: "DeploymentUpdate",
     ) -> None:
+        exclude_if_none = [
+            "version_info",
+        ]
+
+        exclude = {"name", "flow_name", "triggers"}
+        for field in exclude_if_none:
+            if getattr(deployment, field) is None:
+                exclude.add(field)
+
+        payload = deployment.model_dump(
+            mode="json",
+            exclude_unset=True,
+            exclude=exclude,
+        )
+        if deployment.version_info:
+            payload["version_info"] = deployment.version_info.model_dump(mode="json")
+
         await self.request(
             "PATCH",
             "/deployments/{id}",
             path_params={"id": deployment_id},
-            json=deployment.model_dump(
-                mode="json",
-                exclude_unset=True,
-                exclude={"name", "flow_name", "triggers"},
-            ),
+            json=payload,
         )
 
     async def _create_deployment_from_schema(self, schema: "DeploymentCreate") -> UUID:

{prefect_client-3.3.5.dev3 → prefect_client-3.3.6}/src/prefect/concurrency/context.py

@@ -13,7 +13,9 @@ class ConcurrencyContext(ContextModel):
     # Track the slots that have been acquired but were not able to be released
     # due to cancellation or some other error. These slots are released when
     # the context manager exits.
-    cleanup_slots: list[tuple[list[str], int, float]] = Field(default_factory=list)
+    cleanup_slots: list[tuple[list[str], int, float]] = Field(
+        default_factory=lambda: []
+    )
 
     def __exit__(self, *exc_info: Any) -> None:
         if self.cleanup_slots:

{prefect_client-3.3.5.dev3 → prefect_client-3.3.6}/src/prefect/context.py

@@ -18,8 +18,6 @@ from typing import TYPE_CHECKING, Any, Callable, ClassVar, Optional, TypeVar, Un
 from pydantic import BaseModel, ConfigDict, Field, PrivateAttr
 from typing_extensions import Self
 
-import prefect.logging
-import prefect.logging.configuration
 import prefect.settings
 import prefect.types._datetime
 from prefect._internal.compatibility.migration import getattr_migration
@@ -128,7 +126,7 @@ class ContextModel(BaseModel):
         def __init__(self, **kwargs: Any) -> None: ...
 
     # The context variable for storing data must be defined by the child class
-    __var__: ClassVar[ContextVar[Self]]
+    __var__: ClassVar[ContextVar[Any]]
     _token: Optional[Token[Self]] = PrivateAttr(None)
     model_config: ClassVar[ConfigDict] = ConfigDict(
         arbitrary_types_allowed=True,

{prefect_client-3.3.5.dev3 → prefect_client-3.3.6}/src/prefect/deployments/runner.py

@@ -29,6 +29,8 @@ Example:
 
 """
 
+from __future__ import annotations
+
 import importlib
 import tempfile
 from datetime import datetime, timedelta
@@ -63,6 +65,7 @@ from prefect.client.schemas.filters import WorkerFilter, WorkerFilterStatus
 from prefect.client.schemas.objects import (
     ConcurrencyLimitConfig,
     ConcurrencyOptions,
+    VersionInfo,
 )
 from prefect.client.schemas.schedules import (
     SCHEDULE_TYPES,
@@ -281,7 +284,10 @@ class RunnerDeployment(BaseModel):
         return reconcile_schedules_runner(values)
 
     async def _create(
-        self, work_pool_name: Optional[str] = None, image: Optional[str] = None
+        self,
+        work_pool_name: Optional[str] = None,
+        image: Optional[str] = None,
+        version_info: VersionInfo | None = None,
     ) -> UUID:
         work_pool_name = work_pool_name or self.work_pool_name
 
@@ -312,6 +318,7 @@ class RunnerDeployment(BaseModel):
                 work_queue_name=self.work_queue_name,
                 work_pool_name=work_pool_name,
                 version=self.version,
+                version_info=version_info,
                 paused=self.paused,
                 schedules=self.schedules,
                 concurrency_limit=self.concurrency_limit,
@@ -367,7 +374,12 @@ class RunnerDeployment(BaseModel):
 
             return deployment_id
 
-    async def _update(self, deployment_id: UUID, client: PrefectClient):
+    async def _update(
+        self,
+        deployment_id: UUID,
+        client: PrefectClient,
+        version_info: VersionInfo | None,
+    ):
         parameter_openapi_schema = self._parameter_openapi_schema.model_dump(
             exclude_unset=True
         )
@@ -388,6 +400,7 @@ class RunnerDeployment(BaseModel):
             deployment_id,
             deployment=DeploymentUpdate(
                 **update_payload,
+                version_info=version_info,
                 parameter_openapi_schema=parameter_openapi_schema,
             ),
         )
@@ -428,7 +441,10 @@ class RunnerDeployment(BaseModel):
 
     @sync_compatible
     async def apply(
-        self, work_pool_name: Optional[str] = None, image: Optional[str] = None
+        self,
+        work_pool_name: Optional[str] = None,
+        image: Optional[str] = None,
+        version_info: VersionInfo | None = None,
     ) -> UUID:
         """
         Registers this deployment with the API and returns the deployment's ID.
@@ -439,7 +455,7 @@ class RunnerDeployment(BaseModel):
             image: The registry, name, and tag of the Docker image to
                 use for this deployment. Only used when the deployment is
                 deployed to a work pool.
-
+            version_info: Version information for the deployment.
         Returns:
             The ID of the created deployment.
         """
@@ -448,13 +464,13 @@ class RunnerDeployment(BaseModel):
             try:
                 deployment = await client.read_deployment_by_name(self.full_name)
             except ObjectNotFound:
-                return await self._create(work_pool_name, image)
+                return await self._create(work_pool_name, image, version_info)
             else:
                 if image:
                     self.job_variables["image"] = image
                 if work_pool_name:
                     self.work_pool_name = work_pool_name
-                return await self._update(deployment.id, client)
+                return await self._update(deployment.id, client, version_info)
 
     async def _create_slas(self, deployment_id: UUID, client: PrefectClient):
         if not isinstance(self._sla, list):

{prefect_client-3.3.5.dev3 → prefect_client-3.3.6}/src/prefect/events/clients.py

@@ -400,7 +400,7 @@ class PrefectEventsClient(EventsClient):
                 "Set PREFECT_DEBUG_MODE=1 to see the full error.",
                 self._events_socket_url,
                 str(e),
-                exc_info=PREFECT_DEBUG_MODE,
+                exc_info=PREFECT_DEBUG_MODE.value(),
             )
             raise