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

prefect/runner/submit.py

@@ -1,11 +1,13 @@
+from __future__ import annotations
+
 import asyncio
 import inspect
 import uuid
-from typing import Any, Dict, List, Optional, Union, overload
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, overload
 
 import anyio
 import httpx
-from typing_extensions import Literal
+from typing_extensions import Literal, TypeAlias
 
 from prefect.client.orchestration import get_client
 from prefect.client.schemas.filters import FlowRunFilter, TaskRunFilter
@@ -22,12 +24,17 @@ from prefect.states import Pending
 from prefect.tasks import Task
 from prefect.utilities.asyncutils import sync_compatible
 
-logger = get_logger("webserver")
+if TYPE_CHECKING:
+    import logging
+
+logger: "logging.Logger" = get_logger("webserver")
+
+FlowOrTask: TypeAlias = Union[Flow[Any, Any], Task[Any, Any]]
 
 
 async def _submit_flow_to_runner(
-    flow: Flow,
-    parameters: Dict[str, Any],
+    flow: Flow[Any, Any],
+    parameters: dict[str, Any],
     retry_failed_submissions: bool = True,
 ) -> FlowRun:
     """
@@ -91,7 +98,7 @@ async def _submit_flow_to_runner(
 
 @overload
 def submit_to_runner(
-    prefect_callable: Union[Flow, Task],
+    prefect_callable: Union[Flow[Any, Any], Task[Any, Any]],
     parameters: Dict[str, Any],
     retry_failed_submissions: bool = True,
 ) -> FlowRun:
@@ -100,19 +107,19 @@ def submit_to_runner(
 
 @overload
 def submit_to_runner(
-    prefect_callable: Union[Flow, Task],
-    parameters: List[Dict[str, Any]],
+    prefect_callable: Union[Flow[Any, Any], Task[Any, Any]],
+    parameters: list[dict[str, Any]],
     retry_failed_submissions: bool = True,
-) -> List[FlowRun]:
+) -> list[FlowRun]:
     ...
 
 
 @sync_compatible
 async def submit_to_runner(
-    prefect_callable: Union[Flow, Task],
-    parameters: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None,
+    prefect_callable: FlowOrTask,
+    parameters: Optional[Union[dict[str, Any], list[dict[str, Any]]]] = None,
     retry_failed_submissions: bool = True,
-) -> Union[FlowRun, List[FlowRun]]:
+) -> Union[FlowRun, list[FlowRun]]:
     """
     Submit a callable in the background via the runner webserver one or more times.
 

prefect/runtime/deployment.py

@@ -25,8 +25,10 @@ Available attributes:
         object or those directly provided via API for this run
 """
 
+from __future__ import annotations
+
 import os
-from typing import Any, Dict, List, Optional
+from typing import TYPE_CHECKING, Any, Callable, List, Optional
 
 from prefect._internal.concurrency.api import create_call, from_sync
 from prefect.client.orchestration import get_client
@@ -34,12 +36,17 @@ from prefect.context import FlowRunContext
 
 from .flow_run import _get_flow_run
 
+if TYPE_CHECKING:
+    from prefect.client.schemas.responses import DeploymentResponse
+
 __all__ = ["id", "flow_run_id", "name", "parameters", "version"]
 
-CACHED_DEPLOYMENT = {}
+CACHED_DEPLOYMENT: dict[str, "DeploymentResponse"] = {}
 
 
-type_cast = {
+type_cast: dict[
+    type[bool] | type[int] | type[float] | type[str] | type[None], Callable[[Any], Any]
+] = {
     bool: lambda x: x.lower() == "true",
     int: int,
     float: float,
@@ -88,7 +95,7 @@ def __dir__() -> List[str]:
     return sorted(__all__)
 
 
-async def _get_deployment(deployment_id):
+async def _get_deployment(deployment_id: str) -> "DeploymentResponse":
     # deployments won't change between calls so let's avoid the lifecycle of a client
     if CACHED_DEPLOYMENT.get(deployment_id):
         return CACHED_DEPLOYMENT[deployment_id]
@@ -115,7 +122,7 @@ def get_id() -> Optional[str]:
         return str(deployment_id)
 
 
-def get_parameters() -> Dict:
+def get_parameters() -> dict[str, Any]:
     run_id = get_flow_run_id()
     if run_id is None:
         return {}
@@ -126,7 +133,7 @@ def get_parameters() -> Dict:
     return flow_run.parameters or {}
 
 
-def get_name() -> Optional[Dict]:
+def get_name() -> Optional[str]:
     dep_id = get_id()
 
     if dep_id is None:
@@ -138,7 +145,7 @@ def get_name() -> Optional[Dict]:
     return deployment.name
 
 
-def get_version() -> Optional[Dict]:
+def get_version() -> Optional[str]:
     dep_id = get_id()
 
     if dep_id is None:
@@ -154,7 +161,7 @@ def get_flow_run_id() -> Optional[str]:
     return os.getenv("PREFECT__FLOW_RUN_ID")
 
 
-FIELDS = {
+FIELDS: dict[str, Callable[[], Any]] = {
     "id": get_id,
     "flow_run_id": get_flow_run_id,
     "parameters": get_parameters,

prefect/runtime/flow_run.py

@@ -20,8 +20,10 @@ Available attributes:
     - `run_count`: the number of times this flow run has been run
 """
 
+from __future__ import annotations
+
 import os
-from typing import Any, Dict, List, Optional
+from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional
 
 import pendulum
 
@@ -30,6 +32,9 @@ from prefect.client.orchestration import get_client
 from prefect.context import FlowRunContext, TaskRunContext
 from prefect.settings import PREFECT_API_URL, PREFECT_UI_URL
 
+if TYPE_CHECKING:
+    from prefect.client.schemas.objects import Flow, FlowRun, TaskRun
+
 __all__ = [
     "id",
     "tags",
@@ -56,7 +61,15 @@ def _pendulum_parse(dt: str) -> pendulum.DateTime:
     return pendulum.parse(dt, tz=None, strict=False).set(tz="UTC")
 
 
-type_cast = {
+type_cast: dict[
+    type[bool]
+    | type[int]
+    | type[float]
+    | type[str]
+    | type[None]
+    | type[pendulum.DateTime],
+    Callable[[Any], Any],
+] = {
     bool: lambda x: x.lower() == "true",
     int: int,
     float: float,
@@ -106,17 +119,17 @@ def __dir__() -> List[str]:
     return sorted(__all__)
 
 
-async def _get_flow_run(flow_run_id):
+async def _get_flow_run(flow_run_id: str) -> "FlowRun":
     async with get_client() as client:
         return await client.read_flow_run(flow_run_id)
 
 
-async def _get_task_run(task_run_id):
+async def _get_task_run(task_run_id: str) -> "TaskRun":
     async with get_client() as client:
         return await client.read_task_run(task_run_id)
 
 
-async def _get_flow_from_run(flow_run_id):
+async def _get_flow_from_run(flow_run_id: str) -> "Flow":
     async with get_client() as client:
         flow_run = await client.read_flow_run(flow_run_id)
         return await client.read_flow(flow_run.flow_id)
@@ -323,7 +336,7 @@ def get_job_variables() -> Optional[Dict[str, Any]]:
     return flow_run_ctx.flow_run.job_variables if flow_run_ctx else None
 
 
-FIELDS = {
+FIELDS: dict[str, Callable[[], Any]] = {
     "id": get_id,
     "tags": get_tags,
     "scheduled_start_time": get_scheduled_start_time,

prefect/runtime/task_run.py

@@ -15,15 +15,19 @@ Available attributes:
     - `task_name`: the name of the task
 """
 
+from __future__ import annotations
+
 import os
-from typing import Any, Dict, List, Optional
+from typing import Any, Callable, Dict, List, Optional
 
 from prefect.context import TaskRunContext
 
 __all__ = ["id", "tags", "name", "parameters", "run_count", "task_name"]
 
 
-type_cast = {
+type_cast: dict[
+    type[bool] | type[int] | type[float] | type[str] | type[None], Callable[[Any], Any]
+] = {
     bool: lambda x: x.lower() == "true",
     int: int,
     float: float,
@@ -118,7 +122,7 @@ def get_parameters() -> Dict[str, Any]:
         return {}
 
 
-FIELDS = {
+FIELDS: dict[str, Callable[[], Any]] = {
     "id": get_id,
     "tags": get_tags,
     "name": get_name,

prefect/settings/base.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import inspect
 from functools import partial
 from typing import Any, Dict, Tuple, Type
@@ -43,13 +45,17 @@ class PrefectBaseSettings(BaseSettings):
 
         See https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources
         """
-        env_filter = set()
+        env_filter: set[str] = set()
         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:
+                    if (
+                        isinstance(alias, AliasPath)
+                        and len(alias.path) > 0
+                        and isinstance(alias.path[0], str)
+                    ):
                         env_filter.add(alias.path[0])
             env_filter.add(field_name)
         return (
@@ -88,13 +94,12 @@ class PrefectBaseSettings(BaseSettings):
         include_secrets: bool = True,
     ) -> Dict[str, str]:
         """Convert the settings object to a dictionary of environment variables."""
-
         env: Dict[str, Any] = self.model_dump(
             exclude_unset=exclude_unset,
             mode="json",
             context={"include_secrets": include_secrets},
         )
-        env_variables = {}
+        env_variables: dict[str, str] = {}
         for key in self.model_fields.keys():
             if isinstance(child_settings := getattr(self, key), PrefectBaseSettings):
                 child_env = child_settings.to_environment_variables(
@@ -175,7 +180,7 @@ def _add_environment_variables(
     schema: Dict[str, Any], model: Type[PrefectBaseSettings]
 ) -> None:
     for property in schema["properties"]:
-        env_vars = []
+        env_vars: list[str] = []
         schema["properties"][property]["supported_environment_variables"] = env_vars
         field = model.model_fields[property]
         if inspect.isclass(field.annotation) and issubclass(
@@ -191,7 +196,7 @@ def _add_environment_variables(
             env_vars.append(f"{model.model_config.get('env_prefix')}{property.upper()}")
 
 
-def _build_settings_config(
+def build_settings_config(
     path: Tuple[str, ...] = tuple(), frozen: bool = False
 ) -> PrefectSettingsConfigDict:
     env_prefix = f"PREFECT_{'_'.join(path).upper()}_" if path else "PREFECT_"
@@ -207,7 +212,12 @@ def _build_settings_config(
     )
 
 
-def _to_environment_variable_value(value: Any) -> str:
+_build_settings_config = build_settings_config  # noqa # TODO: remove once all usage updated
+
+
+def _to_environment_variable_value(
+    value: list[object] | set[object] | tuple[object] | Any,
+) -> str:
     if isinstance(value, (list, set, tuple)):
         return ",".join(str(v) for v in value)
     return str(value)

prefect/settings/legacy.py

@@ -28,11 +28,11 @@ class Setting:
             self.accessor: str = accessor
 
     @property
-    def name(self):
+    def name(self) -> str:
         return self._name
 
     @property
-    def is_secret(self):
+    def is_secret(self) -> bool:
         if self._type in _SECRET_TYPES:
             return True
         for secret_type in _SECRET_TYPES:
@@ -40,7 +40,7 @@ class Setting:
                 return True
         return False
 
-    def default(self):
+    def default(self) -> Any:
         return self._default
 
     def value(self: Self) -> Any:
@@ -123,7 +123,7 @@ def _get_settings_fields(
     settings: Type[BaseSettings], accessor_prefix: Optional[str] = None
 ) -> Dict[str, "Setting"]:
     """Get the settings fields for the settings object"""
-    settings_fields: Dict[str, Setting] = {}
+    settings_fields: dict[str, Setting] = {}
     for field_name, field in settings.model_fields.items():
         if inspect.isclass(field.annotation) and issubclass(
             field.annotation, PrefectBaseSettings

prefect/settings/models/api.py

@@ -1,11 +1,12 @@
 import os
 from typing import ClassVar, Optional
 
-from pydantic import ConfigDict, Field, SecretStr
+from pydantic import Field, SecretStr
+from pydantic_settings import SettingsConfigDict
 
 from prefect.settings.base import (
     PrefectBaseSettings,
-    _build_settings_config,
+    build_settings_config,
 )
 
 
@@ -14,7 +15,7 @@ class APISettings(PrefectBaseSettings):
     Settings for interacting with the Prefect API
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("api",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("api",))
     url: Optional[str] = Field(
         default=None,
         description="The URL of the Prefect API. If not set, the client will attempt to infer it.",

prefect/settings/models/cli.py

@@ -1,10 +1,11 @@
 from typing import ClassVar, Optional
 
-from pydantic import ConfigDict, Field
+from pydantic import Field
+from pydantic_settings import SettingsConfigDict
 
 from prefect.settings.base import (
     PrefectBaseSettings,
-    _build_settings_config,
+    build_settings_config,
 )
 
 
@@ -13,7 +14,7 @@ class CLISettings(PrefectBaseSettings):
     Settings for controlling CLI behavior
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("cli",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("cli",))
 
     colors: bool = Field(
         default=True,

prefect/settings/models/client.py

@@ -1,10 +1,11 @@
 from typing import ClassVar
 
-from pydantic import AliasChoices, AliasPath, ConfigDict, Field
+from pydantic import AliasChoices, AliasPath, Field
+from pydantic_settings import SettingsConfigDict
 
 from prefect.settings.base import (
     PrefectBaseSettings,
-    _build_settings_config,
+    build_settings_config,
 )
 from prefect.types import ClientRetryExtraCodes
 
@@ -14,7 +15,9 @@ class ClientMetricsSettings(PrefectBaseSettings):
     Settings for controlling metrics reporting from the client
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("client", "metrics"))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
+        ("client", "metrics")
+    )
 
     enabled: bool = Field(
         default=False,
@@ -39,7 +42,7 @@ class ClientSettings(PrefectBaseSettings):
     Settings for controlling API client behavior
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("client",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("client",))
 
     max_retries: int = Field(
         default=5,

prefect/settings/models/cloud.py

@@ -1,12 +1,13 @@
 import re
 from typing import ClassVar, Optional
 
-from pydantic import ConfigDict, Field, model_validator
+from pydantic import Field, model_validator
+from pydantic_settings import SettingsConfigDict
 from typing_extensions import Self
 
 from prefect.settings.base import (
     PrefectBaseSettings,
-    _build_settings_config,
+    build_settings_config,
 )
 
 
@@ -32,7 +33,7 @@ class CloudSettings(PrefectBaseSettings):
     Settings for interacting with Prefect Cloud
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("cloud",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("cloud",))
 
     api_url: str = Field(
         default="https://api.prefect.cloud/api",

prefect/settings/models/deployments.py

@@ -1,8 +1,9 @@
 from typing import ClassVar, Optional
 
-from pydantic import AliasChoices, AliasPath, ConfigDict, Field
+from pydantic import AliasChoices, AliasPath, Field
+from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings, _build_settings_config
+from prefect.settings.base import PrefectBaseSettings, build_settings_config
 
 
 class DeploymentsSettings(PrefectBaseSettings):
@@ -10,7 +11,7 @@ class DeploymentsSettings(PrefectBaseSettings):
     Settings for configuring deployments defaults
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("deployments",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("deployments",))
 
     default_work_pool_name: Optional[str] = Field(
         default=None,

prefect/settings/models/experiments.py

@@ -1,8 +1,9 @@
 from typing import ClassVar
 
-from pydantic import AliasChoices, AliasPath, ConfigDict, Field
+from pydantic import AliasChoices, AliasPath, Field
+from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings, _build_settings_config
+from prefect.settings.base import PrefectBaseSettings, build_settings_config
 
 
 class ExperimentsSettings(PrefectBaseSettings):
@@ -10,7 +11,7 @@ class ExperimentsSettings(PrefectBaseSettings):
     Settings for configuring experimental features
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("experiments",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("experiments",))
 
     warn: bool = Field(
         default=True,

prefect/settings/models/flows.py

@@ -1,8 +1,9 @@
 from typing import ClassVar, Union
 
-from pydantic import AliasChoices, AliasPath, ConfigDict, Field
+from pydantic import AliasChoices, AliasPath, Field
+from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings, _build_settings_config
+from prefect.settings.base import PrefectBaseSettings, build_settings_config
 
 
 class FlowsSettings(PrefectBaseSettings):
@@ -10,7 +11,7 @@ class FlowsSettings(PrefectBaseSettings):
     Settings for controlling flow behavior
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("flows",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("flows",))
 
     default_retries: int = Field(
         default=0,

prefect/settings/models/internal.py

@@ -1,13 +1,14 @@
 from typing import ClassVar
 
-from pydantic import AliasChoices, AliasPath, ConfigDict, Field
+from pydantic import AliasChoices, AliasPath, Field
+from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings, _build_settings_config
+from prefect.settings.base import PrefectBaseSettings, build_settings_config
 from prefect.types import LogLevel
 
 
 class InternalSettings(PrefectBaseSettings):
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("internal",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("internal",))
 
     logging_level: LogLevel = Field(
         default="ERROR",

prefect/settings/models/logging.py

@@ -1,22 +1,22 @@
 from functools import partial
 from pathlib import Path
-from typing import Annotated, ClassVar, Literal, Optional, Union
+from typing import Annotated, Any, ClassVar, Literal, Optional, Union
 
 from pydantic import (
     AliasChoices,
     AliasPath,
     BeforeValidator,
-    ConfigDict,
     Field,
     model_validator,
 )
+from pydantic_settings import SettingsConfigDict
 from typing_extensions import Self
 
-from prefect.settings.base import PrefectBaseSettings, _build_settings_config
+from prefect.settings.base import PrefectBaseSettings, build_settings_config
 from prefect.types import LogLevel, validate_set_T_from_delim_string
 
 
-def max_log_size_smaller_than_batch_size(values):
+def max_log_size_smaller_than_batch_size(values: dict[str, Any]) -> dict[str, Any]:
     """
     Validator for settings asserting the batch size and match log size are compatible
     """
@@ -33,7 +33,9 @@ class LoggingToAPISettings(PrefectBaseSettings):
     Settings for controlling logging to the API
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("logging", "to_api"))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
+        ("logging", "to_api")
+    )
 
     enabled: bool = Field(
         default=True,
@@ -86,7 +88,7 @@ class LoggingSettings(PrefectBaseSettings):
     Settings for controlling logging behavior
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("logging",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("logging",))
 
     level: LogLevel = Field(
         default="INFO",

prefect/settings/models/results.py

@@ -1,9 +1,10 @@
 from pathlib import Path
 from typing import ClassVar, Optional
 
-from pydantic import AliasChoices, AliasPath, ConfigDict, Field
+from pydantic import AliasChoices, AliasPath, Field
+from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings, _build_settings_config
+from prefect.settings.base import PrefectBaseSettings, build_settings_config
 
 
 class ResultsSettings(PrefectBaseSettings):
@@ -11,7 +12,7 @@ class ResultsSettings(PrefectBaseSettings):
     Settings for controlling result storage behavior
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("results",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("results",))
 
     default_serializer: str = Field(
         default="pickle",