prefect-client 3.1.1__tar.gz → 3.1.2__tar.gz

{prefect-client-3.1.1/src/prefect_client.egg-info → prefect-client-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prefect-client
-Version: 3.1.1
+Version: 3.1.2
 Summary: Workflow orchestration and management.
 Home-page: https://www.prefect.io
 Author: Prefect Technologies, Inc.

{prefect-client-3.1.1 → prefect-client-3.1.2}/src/prefect/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-11-08T12:38:16-0800",
+ "date": "2024-11-12T13:38:45-0800",
  "dirty": true,
  "error": null,
- "full-revisionid": "6b50a2b9f9d4ebf59703c55e1156c6f79151f1c3",
- "version": "3.1.1"
+ "full-revisionid": "02b99f0a756f0395e4292952dcb2d963fc839750",
+ "version": "3.1.2"
 }
 '''  # END VERSION_JSON
 

{prefect-client-3.1.1 → prefect-client-3.1.2}/src/prefect/client/cloud.py

@@ -1,5 +1,6 @@
 import re
 from typing import Any, Dict, List, Optional, cast
+from uuid import UUID
 
 import anyio
 import httpx
@@ -12,6 +13,7 @@ from prefect.client.base import PrefectHttpxAsyncClient
 from prefect.client.schemas.objects import (
     IPAllowlist,
     IPAllowlistMyAccessResponse,
+    KeyValueLabels,
     Workspace,
 )
 from prefect.exceptions import ObjectNotFound, PrefectException
@@ -151,6 +153,25 @@ class CloudClient:
         response = await self.get(f"{self.account_base_url}/ip_allowlist/my_access")
         return IPAllowlistMyAccessResponse.model_validate(response)
 
+    async def update_flow_run_labels(
+        self, flow_run_id: UUID, labels: KeyValueLabels
+    ) -> httpx.Response:
+        """
+        Update the labels for a flow run.
+
+        Args:
+            flow_run_id: The identifier for the flow run to update.
+            labels: A dictionary of labels to update for the flow run.
+
+        Returns:
+            an `httpx.Response` object from the PATCH request
+        """
+
+        return await self._client.patch(
+            f"{self.workspace_base_url}/flow_runs/{flow_run_id}/labels",
+            json=labels,
+        )
+
     async def __aenter__(self):
         await self._client.__aenter__()
         return self

{prefect-client-3.1.1 → prefect-client-3.1.2}/src/prefect/client/orchestration.py

@@ -2613,7 +2613,7 @@ class PrefectClient:
             "heartbeat_interval_seconds": heartbeat_interval_seconds,
         }
         if worker_metadata:
-            params["worker_metadata"] = worker_metadata.model_dump(mode="json")
+            params["metadata"] = worker_metadata.model_dump(mode="json")
         if get_worker_id:
             params["return_id"] = get_worker_id
 

{prefect-client-3.1.1 → prefect-client-3.1.2}/src/prefect/client/schemas/objects.py

@@ -23,6 +23,9 @@ from pydantic import (
     HttpUrl,
     IPvAnyNetwork,
     SerializationInfo,
+    StrictBool,
+    StrictFloat,
+    StrictInt,
     Tag,
     field_validator,
     model_serializer,
@@ -68,6 +71,8 @@ if TYPE_CHECKING:
 
 R = TypeVar("R", default=Any)
 
+KeyValueLabels = dict[str, Union[StrictBool, StrictInt, StrictFloat, str]]
+
 
 DEFAULT_BLOCK_SCHEMA_VERSION = "non-versioned"
 DEFAULT_AGENT_WORK_POOL_NAME = "default-agent-pool"

{prefect-client-3.1.1 → prefect-client-3.1.2}/src/prefect/settings/base.py

@@ -17,6 +17,7 @@ from pydantic_settings import (
 
 from prefect.settings.sources import (
     EnvFilterSettingsSource,
+    FilteredDotEnvSettingsSource,
     PrefectTomlConfigSettingsSource,
     ProfileSettingsTomlLoader,
     PyprojectTomlConfigSettingsSource,
@@ -43,13 +44,14 @@ class PrefectBaseSettings(BaseSettings):
         See https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources
         """
         env_filter = set()
-        for field in settings_cls.model_fields.values():
+        for field_name, field in settings_cls.model_fields.items():
             if field.validation_alias is not None and isinstance(
                 field.validation_alias, AliasChoices
             ):
                 for alias in field.validation_alias.choices:
                     if isinstance(alias, AliasPath) and len(alias.path) > 0:
                         env_filter.add(alias.path[0])
+            env_filter.add(field_name)
         return (
             init_settings,
             EnvFilterSettingsSource(
@@ -62,7 +64,18 @@ class PrefectBaseSettings(BaseSettings):
                 env_parse_enums=cls.model_config.get("env_parse_enums"),
                 env_filter=list(env_filter),
             ),
-            dotenv_settings,
+            FilteredDotEnvSettingsSource(
+                settings_cls,
+                env_file=cls.model_config.get("env_file"),
+                env_file_encoding=cls.model_config.get("env_file_encoding"),
+                case_sensitive=cls.model_config.get("case_sensitive"),
+                env_prefix=cls.model_config.get("env_prefix"),
+                env_nested_delimiter=cls.model_config.get("env_nested_delimiter"),
+                env_ignore_empty=cls.model_config.get("env_ignore_empty"),
+                env_parse_none_str=cls.model_config.get("env_parse_none_str"),
+                env_parse_enums=cls.model_config.get("env_parse_enums"),
+                env_blacklist=list(env_filter),
+            ),
             file_secret_settings,
             PrefectTomlConfigSettingsSource(settings_cls),
             PyprojectTomlConfigSettingsSource(settings_cls),
@@ -92,7 +105,7 @@ class PrefectBaseSettings(BaseSettings):
             elif (value := env.get(key)) is not None:
                 env_variables[
                     f"{self.model_config.get('env_prefix')}{key.upper()}"
-                ] = str(value)
+                ] = _to_environment_variable_value(value)
         return env_variables
 
     @model_serializer(
@@ -191,3 +204,9 @@ def _build_settings_config(
         pyproject_toml_table_header=("tool", "prefect", *path),
         json_schema_extra=_add_environment_variables,
     )
+
+
+def _to_environment_variable_value(value: Any) -> str:
+    if isinstance(value, (list, set, tuple)):
+        return ",".join(str(v) for v in value)
+    return str(value)

{prefect-client-3.1.1 → prefect-client-3.1.2}/src/prefect/settings/sources.py

@@ -10,10 +10,15 @@ from pydantic import AliasChoices
 from pydantic.fields import FieldInfo
 from pydantic_settings import (
     BaseSettings,
+    DotEnvSettingsSource,
     EnvSettingsSource,
     PydanticBaseSettingsSource,
 )
-from pydantic_settings.sources import ConfigFileSourceMixin
+from pydantic_settings.sources import (
+    ENV_FILE_SENTINEL,
+    ConfigFileSourceMixin,
+    DotenvType,
+)
 
 from prefect.settings.constants import DEFAULT_PREFECT_HOME, DEFAULT_PROFILES_PATH
 from prefect.utilities.collections import get_from_dict
@@ -61,6 +66,44 @@ class EnvFilterSettingsSource(EnvSettingsSource):
                 }
 
 
+class FilteredDotEnvSettingsSource(DotEnvSettingsSource):
+    def __init__(
+        self,
+        settings_cls: type[BaseSettings],
+        env_file: Optional[DotenvType] = ENV_FILE_SENTINEL,
+        env_file_encoding: Optional[str] = None,
+        case_sensitive: Optional[bool] = None,
+        env_prefix: Optional[str] = None,
+        env_nested_delimiter: Optional[str] = None,
+        env_ignore_empty: Optional[bool] = None,
+        env_parse_none_str: Optional[str] = None,
+        env_parse_enums: Optional[bool] = None,
+        env_blacklist: Optional[List[str]] = None,
+    ) -> None:
+        super().__init__(
+            settings_cls,
+            env_file,
+            env_file_encoding,
+            case_sensitive,
+            env_prefix,
+            env_nested_delimiter,
+            env_ignore_empty,
+            env_parse_none_str,
+            env_parse_enums,
+        )
+        self.env_blacklist = env_blacklist
+        if self.env_blacklist:
+            if isinstance(self.env_vars, dict):
+                for key in self.env_blacklist:
+                    self.env_vars.pop(key, None)
+            else:
+                self.env_vars = {
+                    key: value
+                    for key, value in self.env_vars.items()  # type: ignore
+                    if key.lower() not in env_blacklist
+                }
+
+
 class ProfileSettingsTomlLoader(PydanticBaseSettingsSource):
     """
     Custom pydantic settings source to load profile settings from a toml file.
@@ -111,21 +154,34 @@ class ProfileSettingsTomlLoader(PydanticBaseSettingsSource):
     ) -> Tuple[Any, str, bool]:
         """Concrete implementation to get the field value from the profile settings"""
         if field.validation_alias:
+            # Use validation alias as the key to ensure profile value does not
+            # higher priority sources. Lower priority sources that use the
+            # field name can override higher priority sources that use the
+            # validation alias as seen in https://github.com/PrefectHQ/prefect/issues/15981
             if isinstance(field.validation_alias, str):
                 value = self.profile_settings.get(field.validation_alias.upper())
                 if value is not None:
-                    return value, field_name, self.field_is_complex(field)
+                    return value, field.validation_alias, self.field_is_complex(field)
             elif isinstance(field.validation_alias, AliasChoices):
+                value = None
+                lowest_priority_alias = next(
+                    choice
+                    for choice in reversed(field.validation_alias.choices)
+                    if isinstance(choice, str)
+                )
                 for alias in field.validation_alias.choices:
                     if not isinstance(alias, str):
                         continue
                     value = self.profile_settings.get(alias.upper())
                     if value is not None:
-                        return value, field_name, self.field_is_complex(field)
-
-        value = self.profile_settings.get(
-            f"{self.config.get('env_prefix','')}{field_name.upper()}"
-        )
+                        return (
+                            value,
+                            lowest_priority_alias,
+                            self.field_is_complex(field),
+                        )
+
+        name = f"{self.config.get('env_prefix','')}{field_name.upper()}"
+        value = self.profile_settings.get(name)
         return value, field_name, self.field_is_complex(field)
 
     def __call__(self) -> Dict[str, Any]:
@@ -164,7 +220,22 @@ class TomlConfigSettingsSourceBase(PydanticBaseSettingsSource, ConfigFileSourceM
             # if the value is a dict, it is likely a nested settings object and a nested
             # source will handle it
             value = None
-        return value, field_name, self.field_is_complex(field)
+        name = field_name
+        # Use validation alias as the key to ensure profile value does not
+        # higher priority sources. Lower priority sources that use the
+        # field name can override higher priority sources that use the
+        # validation alias as seen in https://github.com/PrefectHQ/prefect/issues/15981
+        if value is not None:
+            if field.validation_alias and isinstance(field.validation_alias, str):
+                name = field.validation_alias
+            elif field.validation_alias and isinstance(
+                field.validation_alias, AliasChoices
+            ):
+                for alias in reversed(field.validation_alias.choices):
+                    if isinstance(alias, str):
+                        name = alias
+                        break
+        return value, name, self.field_is_complex(field)
 
     def __call__(self) -> Dict[str, Any]:
         """Called by pydantic to get the settings from our custom source"""

{prefect-client-3.1.1 → prefect-client-3.1.2}/src/prefect/states.py

@@ -2,6 +2,7 @@ import asyncio
 import datetime
 import sys
 import traceback
+import uuid
 import warnings
 from collections import Counter
 from types import GeneratorType, TracebackType
@@ -220,7 +221,8 @@ async def exception_to_crashed_state(
         )
 
     if result_store:
-        data = result_store.create_result_record(exc)
+        key = uuid.uuid4().hex
+        data = result_store.create_result_record(exc, key=key)
     else:
         # Attach the exception for local usage, will not be available when retrieved
         # from the API
@@ -253,7 +255,8 @@ async def exception_to_failed_state(
         pass
 
     if result_store:
-        data = result_store.create_result_record(exc)
+        key = uuid.uuid4().hex
+        data = result_store.create_result_record(exc, key=key)
         if write_result:
             try:
                 await result_store.apersist_result_record(data)

{prefect-client-3.1.1 → prefect-client-3.1.2}/src/prefect/utilities/urls.py

@@ -2,7 +2,8 @@ import inspect
 import ipaddress
 import socket
 import urllib.parse
-from typing import TYPE_CHECKING, Any, Literal, Optional, Union
+from string import Formatter
+from typing import TYPE_CHECKING, Any, Dict, Literal, Optional, Union
 from urllib.parse import urlparse
 from uuid import UUID
 
@@ -22,7 +23,6 @@ logger = get_logger("utilities.urls")
 
 # The following objects are excluded from UI URL generation because we lack a
 # directly-addressable URL:
-#   worker
 #   artifact
 #   variable
 #   saved-search
@@ -38,6 +38,7 @@ UI_URL_FORMATS = {
     "deployment": "deployments/deployment/{obj_id}",
     "automation": "automations/automation/{obj_id}",
     "received-event": "events/event/{occurred}/{obj_id}",
+    "worker": "work-pools/work-pool/{work_pool_name}/worker/{obj_id}",
 }
 
 # The following objects are excluded from API URL generation because we lack a
@@ -134,6 +135,7 @@ def url_for(
     obj_id: Optional[Union[str, UUID]] = None,
     url_type: URLType = "ui",
     default_base_url: Optional[str] = None,
+    **additional_format_kwargs: Optional[Dict[str, Any]],
 ) -> Optional[str]:
     """
     Returns the URL for a Prefect object.
@@ -149,6 +151,8 @@ def url_for(
             Whether to return the URL for the UI (default) or API.
         default_base_url (str, optional):
             The default base URL to use if no URL is configured.
+        additional_format_kwargs (Dict[str, Any], optional):
+            Additional keyword arguments to pass to the URL format.
 
     Returns:
         Optional[str]: The URL for the given object or None if the object is not supported.
@@ -246,7 +250,18 @@ def url_for(
             occurred=obj.occurred.strftime("%Y-%m-%d"), obj_id=obj_id
         )
     else:
-        url = url_format.format(obj_id=obj_id)
+        obj_keys = [
+            fname
+            for _, fname, _, _ in Formatter().parse(url_format)
+            if fname is not None and fname != "obj_id"
+        ]
+
+        if not all(key in additional_format_kwargs for key in obj_keys):
+            raise ValueError(
+                f"Unable to generate URL for {name} because the following keys are missing: {', '.join(obj_keys)}"
+            )
+
+        url = url_format.format(obj_id=obj_id, **additional_format_kwargs)
 
     if not base_url.endswith("/"):
         base_url += "/"

{prefect-client-3.1.1 → prefect-client-3.1.2}/src/prefect/workers/base.py

@@ -18,6 +18,7 @@ from typing_extensions import Literal
 import prefect
 from prefect._internal.schemas.validators import return_v_or_none
 from prefect.client.base import ServerType
+from prefect.client.cloud import CloudClient, get_cloud_client
 from prefect.client.orchestration import PrefectClient, get_client
 from prefect.client.schemas.actions import WorkPoolCreate, WorkPoolUpdate
 from prefect.client.schemas.objects import (
@@ -439,6 +440,7 @@ class BaseWorker(abc.ABC):
         self._exit_stack: AsyncExitStack = AsyncExitStack()
         self._runs_task_group: Optional[anyio.abc.TaskGroup] = None
         self._client: Optional[PrefectClient] = None
+        self._cloud_client: Optional[CloudClient] = None
         self._last_polled_time: pendulum.DateTime = pendulum.now("utc")
         self._limit = limit
         self._limiter: Optional[anyio.CapacityLimiter] = None
@@ -630,9 +632,14 @@ class BaseWorker(abc.ABC):
             raise ValueError("`PREFECT_API_URL` must be set to start a Worker.")
 
         self._client = get_client()
+
         await self._exit_stack.enter_async_context(self._client)
         await self._exit_stack.enter_async_context(self._runs_task_group)
 
+        if self._client.server_type == ServerType.CLOUD:
+            self._cloud_client = get_cloud_client()
+            await self._exit_stack.enter_async_context(self._cloud_client)
+
         self.is_setup = True
 
     async def teardown(self, *exc_info):
@@ -740,7 +747,8 @@ class BaseWorker(abc.ABC):
             for dist in distributions()
             # PyPI packages often use dashes, but Python package names use underscores
             # because they must be valid identifiers.
-            if dist.metadata.get("Name").replace("-", "_") in installed_integrations
+            if (name := dist.metadata.get("Name"))
+            and (name.replace("-", "_") in installed_integrations)
         ]
 
         if integration_versions:
@@ -877,12 +885,18 @@ class BaseWorker(abc.ABC):
                     get_current_settings().experiments.worker_logging_to_api_enabled
                     and self.backend_id
                 ):
-                    worker_path = f"worker/{self.backend_id}"
-                    base_url = url_for("work-pool", self._work_pool.id)
+                    try:
+                        worker_url = url_for(
+                            "worker",
+                            obj_id=self.backend_id,
+                            work_pool_name=self._work_pool_name,
+                        )
 
-                    run_logger.info(
-                        f"Running on worker id: {self.backend_id}. See worker logs here: {base_url}/{worker_path}"
-                    )
+                        run_logger.info(
+                            f"Running on worker id: {self.backend_id}. See worker logs here: {worker_url}"
+                        )
+                    except ValueError as ve:
+                        run_logger.warning(f"Failed to generate worker URL: {ve}")
 
                 self._submitting_flow_run_ids.add(flow_run.id)
                 self._runs_task_group.start_soon(
@@ -970,6 +984,7 @@ class BaseWorker(abc.ABC):
         try:
             configuration = await self._get_configuration(flow_run)
             submitted_event = self._emit_flow_run_submitted_event(configuration)
+            await self._give_worker_labels_to_flow_run(flow_run.id)
             result = await self.run(
                 flow_run=flow_run,
                 task_status=task_status,
@@ -1191,6 +1206,19 @@ class BaseWorker(abc.ABC):
 
         await self._runs_task_group.start(wrapper)
 
+    async def _give_worker_labels_to_flow_run(self, flow_run_id: UUID):
+        """
+        Give this worker's identifying labels to the specified flow run.
+        """
+        if self._cloud_client:
+            await self._cloud_client.update_flow_run_labels(
+                flow_run_id,
+                {
+                    "prefect.worker.name": self.name,
+                    "prefect.worker.type": self.type,
+                },
+            )
+
     async def __aenter__(self):
         self._logger.debug("Entering worker context...")
         await self.setup()

{prefect-client-3.1.1 → prefect-client-3.1.2/src/prefect_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prefect-client
-Version: 3.1.1
+Version: 3.1.2
 Summary: Workflow orchestration and management.
 Home-page: https://www.prefect.io
 Author: Prefect Technologies, Inc.