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

prefect/settings/models/server/events.py

@@ -1,9 +1,10 @@
 from datetime import timedelta
 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 ServerEventsSettings(PrefectBaseSettings):
@@ -11,7 +12,9 @@ class ServerEventsSettings(PrefectBaseSettings):
     Settings for controlling behavior of the events subsystem
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("server", "events"))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
+        ("server", "events")
+    )
 
     ###########################################################################
     # Events settings

prefect/settings/models/server/flow_run_graph.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 ServerFlowRunGraphSettings(PrefectBaseSettings):
@@ -10,7 +11,7 @@ class ServerFlowRunGraphSettings(PrefectBaseSettings):
     Settings for controlling behavior of the flow run graph
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "flow_run_graph")
     )
 

prefect/settings/models/server/root.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
 from prefect.types import LogLevel
 
 from .api import ServerAPISettings
@@ -22,7 +23,7 @@ class ServerSettings(PrefectBaseSettings):
     Settings for controlling server behavior
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("server",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("server",))
 
     logging_level: LogLevel = Field(
         default="WARNING",

prefect/settings/models/server/services.py

@@ -1,9 +1,10 @@
 from datetime import timedelta
 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 ServerServicesCancellationCleanupSettings(PrefectBaseSettings):
@@ -11,7 +12,7 @@ class ServerServicesCancellationCleanupSettings(PrefectBaseSettings):
     Settings for controlling the cancellation cleanup service
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "services", "cancellation_cleanup")
     )
 
@@ -41,7 +42,7 @@ class ServerServicesEventPersisterSettings(PrefectBaseSettings):
     Settings for controlling the event persister service
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "services", "event_persister")
     )
 
@@ -83,7 +84,7 @@ class ServerServicesFlowRunNotificationsSettings(PrefectBaseSettings):
     Settings for controlling the flow run notifications service
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "services", "flow_run_notifications")
     )
 
@@ -103,7 +104,7 @@ class ServerServicesForemanSettings(PrefectBaseSettings):
     Settings for controlling the foreman service
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "services", "foreman")
     )
 
@@ -184,7 +185,7 @@ class ServerServicesLateRunsSettings(PrefectBaseSettings):
     Settings for controlling the late runs service
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "services", "late_runs")
     )
 
@@ -228,7 +229,7 @@ class ServerServicesSchedulerSettings(PrefectBaseSettings):
     Settings for controlling the scheduler service
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "services", "scheduler")
     )
 
@@ -353,7 +354,7 @@ class ServerServicesPauseExpirationsSettings(PrefectBaseSettings):
     Settings for controlling the pause expiration service
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "services", "pause_expirations")
     )
 
@@ -389,7 +390,7 @@ class ServerServicesTaskRunRecorderSettings(PrefectBaseSettings):
     Settings for controlling the task run recorder service
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "services", "task_run_recorder")
     )
 
@@ -409,7 +410,7 @@ class ServerServicesTriggersSettings(PrefectBaseSettings):
     Settings for controlling the triggers service
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "services", "triggers")
     )
 
@@ -429,7 +430,9 @@ class ServerServicesSettings(PrefectBaseSettings):
     Settings for controlling server services
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("server", "services"))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
+        ("server", "services")
+    )
 
     cancellation_cleanup: ServerServicesCancellationCleanupSettings = Field(
         default_factory=ServerServicesCancellationCleanupSettings,

prefect/settings/models/server/tasks.py

@@ -1,9 +1,10 @@
 from datetime import timedelta
 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 ServerTasksSchedulingSettings(PrefectBaseSettings):
@@ -11,7 +12,7 @@ class ServerTasksSchedulingSettings(PrefectBaseSettings):
     Settings for controlling server-side behavior related to task scheduling
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
         ("server", "tasks", "scheduling")
     )
 
@@ -51,7 +52,9 @@ class ServerTasksSettings(PrefectBaseSettings):
     Settings for controlling server-side behavior related to tasks
     """
 
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("server", "tasks"))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
+        ("server", "tasks")
+    )
 
     tag_concurrency_slot_wait_seconds: float = Field(
         default=30,

prefect/settings/models/server/ui.py

@@ -1,12 +1,13 @@
 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 ServerUISettings(PrefectBaseSettings):
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("server", "ui"))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("server", "ui"))
 
     enabled: bool = Field(
         default=True,

prefect/settings/models/tasks.py

@@ -1,12 +1,15 @@
 from typing import ClassVar, Optional, 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 TasksRunnerSettings(PrefectBaseSettings):
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("tasks", "runner"))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
+        ("tasks", "runner")
+    )
 
     thread_pool_max_workers: Optional[int] = Field(
         default=None,
@@ -21,7 +24,9 @@ class TasksRunnerSettings(PrefectBaseSettings):
 
 
 class TasksSchedulingSettings(PrefectBaseSettings):
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("tasks", "scheduling"))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
+        ("tasks", "scheduling")
+    )
 
     default_storage_block: Optional[str] = Field(
         default=None,
@@ -45,7 +50,7 @@ class TasksSchedulingSettings(PrefectBaseSettings):
 
 
 class TasksSettings(PrefectBaseSettings):
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("tasks",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("tasks",))
 
     refresh_cache: bool = Field(
         default=False,

prefect/settings/models/testing.py

@@ -1,12 +1,13 @@
 from typing import Any, 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 TestingSettings(PrefectBaseSettings):
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("testing",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("testing",))
 
     test_mode: bool = Field(
         default=False,

prefect/settings/models/worker.py

@@ -1,12 +1,15 @@
 from typing import ClassVar
 
-from pydantic import ConfigDict, Field
+from pydantic import 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 WorkerWebserverSettings(PrefectBaseSettings):
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("worker", "webserver"))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(
+        ("worker", "webserver")
+    )
 
     host: str = Field(
         default="0.0.0.0",
@@ -20,7 +23,7 @@ class WorkerWebserverSettings(PrefectBaseSettings):
 
 
 class WorkerSettings(PrefectBaseSettings):
-    model_config: ClassVar[ConfigDict] = _build_settings_config(("worker",))
+    model_config: ClassVar[SettingsConfigDict] = build_settings_config(("worker",))
 
     heartbeat_seconds: float = Field(
         default=30,

prefect/settings/profiles.py

@@ -7,10 +7,9 @@ from typing import (
     ClassVar,
     Dict,
     Iterable,
-    List,
+    Iterator,
     Optional,
     Set,
-    Tuple,
     Union,
 )
 
@@ -77,8 +76,8 @@ class Profile(BaseModel):
             if value is not None
         }
 
-    def validate_settings(self):
-        errors: List[Tuple[Setting, ValidationError]] = []
+    def validate_settings(self) -> None:
+        errors: list[tuple[Setting, ValidationError]] = []
         for setting, value in self.settings.items():
             try:
                 model_fields = Settings.model_fields
@@ -109,7 +108,9 @@ class ProfilesCollection:
     def __init__(
         self, profiles: Iterable[Profile], active: Optional[str] = None
     ) -> None:
-        self.profiles_by_name = {profile.name: profile for profile in profiles}
+        self.profiles_by_name: dict[str, Profile] = {
+            profile.name: profile for profile in profiles
+        }
         self.active_name = active
 
     @property
@@ -128,7 +129,7 @@ class ProfilesCollection:
             return None
         return self[self.active_name]
 
-    def set_active(self, name: Optional[str], check: bool = True):
+    def set_active(self, name: Optional[str], check: bool = True) -> None:
         """
         Set the active profile name in the collection.
 
@@ -142,7 +143,7 @@ class ProfilesCollection:
     def update_profile(
         self,
         name: str,
-        settings: Dict[Setting, Any],
+        settings: dict[Setting, Any],
         source: Optional[Path] = None,
     ) -> Profile:
         """
@@ -214,7 +215,7 @@ class ProfilesCollection:
             active=self.active_name,
         )
 
-    def to_dict(self):
+    def to_dict(self) -> dict[str, Any]:
         """
         Convert to a dictionary suitable for writing to disk.
         """
@@ -229,11 +230,11 @@ class ProfilesCollection:
     def __getitem__(self, name: str) -> Profile:
         return self.profiles_by_name[name]
 
-    def __iter__(self):
+    def __iter__(self) -> Iterator[str]:
         return self.profiles_by_name.__iter__()
 
-    def items(self):
-        return self.profiles_by_name.items()
+    def items(self) -> list[tuple[str, Profile]]:
+        return list(self.profiles_by_name.items())
 
     def __eq__(self, __o: object) -> bool:
         if not isinstance(__o, ProfilesCollection):
@@ -325,7 +326,7 @@ def load_profiles(include_defaults: bool = True) -> ProfilesCollection:
     return profiles
 
 
-def load_current_profile():
+def load_current_profile() -> Profile:
     """
     Load the current profile from the default and current profile paths.
 

prefect/settings/sources.py

@@ -2,7 +2,7 @@ import os
 import sys
 import warnings
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Tuple, Type
+from typing import Any, Dict, List, Mapping, Optional, Sequence, Tuple, Type
 
 import dotenv
 import toml
@@ -54,6 +54,7 @@ class EnvFilterSettingsSource(EnvSettingsSource):
             env_parse_none_str,
             env_parse_enums,
         )
+        self.env_vars: Mapping[str, str | None]
         if env_filter:
             if isinstance(self.env_vars, dict):
                 for key in env_filter:
@@ -97,7 +98,7 @@ class FilteredDotEnvSettingsSource(DotEnvSettingsSource):
                 for key in self.env_blacklist:
                     self.env_vars.pop(key, None)
             else:
-                self.env_vars = {
+                self.env_vars: dict[str, str | None] = {
                     key: value
                     for key, value in self.env_vars.items()  # type: ignore
                     if key.lower() not in env_blacklist
@@ -114,8 +115,8 @@ class ProfileSettingsTomlLoader(PydanticBaseSettingsSource):
     def __init__(self, settings_cls: Type[BaseSettings]):
         super().__init__(settings_cls)
         self.settings_cls = settings_cls
-        self.profiles_path = _get_profiles_path()
-        self.profile_settings = self._load_profile_settings()
+        self.profiles_path: Path = _get_profiles_path()
+        self.profile_settings: dict[str, Any] = self._load_profile_settings()
 
     def _load_profile_settings(self) -> Dict[str, Any]:
         """Helper method to load the profile settings from the profiles.toml file"""
@@ -213,14 +214,14 @@ class TomlConfigSettingsSourceBase(PydanticBaseSettingsSource, ConfigFileSourceM
     def __init__(self, settings_cls: Type[BaseSettings]):
         super().__init__(settings_cls)
         self.settings_cls = settings_cls
-        self.toml_data = {}
+        self.toml_data: dict[str, Any] = {}
 
-    def _read_file(self, path: Path) -> Dict[str, Any]:
+    def _read_file(self, path: Path) -> dict[str, Any]:
         return toml.load(path)
 
     def get_field_value(
         self, field: FieldInfo, field_name: str
-    ) -> Tuple[Any, str, bool]:
+    ) -> tuple[Any, str, bool]:
         """Concrete implementation to get the field value from toml data"""
         value = self.toml_data.get(field_name)
         if isinstance(value, dict):
@@ -244,9 +245,9 @@ class TomlConfigSettingsSourceBase(PydanticBaseSettingsSource, ConfigFileSourceM
                         break
         return value, name, self.field_is_complex(field)
 
-    def __call__(self) -> Dict[str, Any]:
+    def __call__(self) -> dict[str, Any]:
         """Called by pydantic to get the settings from our custom source"""
-        toml_setings: Dict[str, Any] = {}
+        toml_setings: dict[str, Any] = {}
         for field_name, field in self.settings_cls.model_fields.items():
             value, key, is_complex = self.get_field_value(field, field_name)
             if value is not None:
@@ -265,15 +266,15 @@ class PrefectTomlConfigSettingsSource(TomlConfigSettingsSourceBase):
         settings_cls: Type[BaseSettings],
     ):
         super().__init__(settings_cls)
-        self.toml_file_path = settings_cls.model_config.get(
-            "toml_file", DEFAULT_PREFECT_TOML_PATH
-        )
-        self.toml_data = self._read_files(self.toml_file_path)
-        self.toml_table_header = settings_cls.model_config.get(
+        self.toml_file_path: Path | str | Sequence[
+            Path | str
+        ] | None = settings_cls.model_config.get("toml_file", DEFAULT_PREFECT_TOML_PATH)
+        self.toml_data: dict[str, Any] = self._read_files(self.toml_file_path)
+        self.toml_table_header: tuple[str, ...] = settings_cls.model_config.get(
             "prefect_toml_table_header", tuple()
         )
         for key in self.toml_table_header:
-            self.toml_data = self.toml_data.get(key, {})
+            self.toml_data: dict[str, Any] = self.toml_data.get(key, {})
 
 
 class PyprojectTomlConfigSettingsSource(TomlConfigSettingsSourceBase):
@@ -284,13 +285,13 @@ class PyprojectTomlConfigSettingsSource(TomlConfigSettingsSourceBase):
         settings_cls: Type[BaseSettings],
     ):
         super().__init__(settings_cls)
-        self.toml_file_path = Path("pyproject.toml")
-        self.toml_data = self._read_files(self.toml_file_path)
-        self.toml_table_header = settings_cls.model_config.get(
+        self.toml_file_path: Path = Path("pyproject.toml")
+        self.toml_data: dict[str, Any] = self._read_files(self.toml_file_path)
+        self.toml_table_header: tuple[str, ...] = settings_cls.model_config.get(
             "pyproject_toml_table_header", ("tool", "prefect")
         )
         for key in self.toml_table_header:
-            self.toml_data = self.toml_data.get(key, {})
+            self.toml_data: dict[str, Any] = self.toml_data.get(key, {})
 
 
 def _is_test_mode() -> bool:

prefect/states.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import asyncio
 import datetime
 import sys
@@ -33,12 +35,14 @@ from prefect.utilities.asyncutils import in_async_main_thread, sync_compatible
 from prefect.utilities.collections import ensure_iterable
 
 if TYPE_CHECKING:
+    import logging
+
     from prefect.results import (
         R,
         ResultStore,
     )
 
-logger = get_logger("states")
+logger: "logging.Logger" = get_logger("states")
 
 
 @deprecated.deprecated_parameter(
@@ -245,8 +249,8 @@ async def exception_to_failed_state(
     exc: Optional[BaseException] = None,
     result_store: Optional["ResultStore"] = None,
     write_result: bool = False,
-    **kwargs,
-) -> State:
+    **kwargs: Any,
+) -> State[BaseException]:
     """
     Convenience function for creating `Failed` states from exceptions
     """
@@ -553,17 +557,17 @@ def is_state_iterable(obj: Any) -> TypeGuard[Iterable[State]]:
 
 
 class StateGroup:
-    def __init__(self, states: Iterable[State]) -> None:
-        self.states = states
-        self.type_counts = self._get_type_counts(states)
-        self.total_count = len(states)
-        self.cancelled_count = self.type_counts[StateType.CANCELLED]
-        self.final_count = sum(state.is_final() for state in states)
-        self.not_final_count = self.total_count - self.final_count
-        self.paused_count = self.type_counts[StateType.PAUSED]
+    def __init__(self, states: list[State]) -> None:
+        self.states: list[State] = states
+        self.type_counts: dict[StateType, int] = self._get_type_counts(states)
+        self.total_count: int = len(states)
+        self.cancelled_count: int = self.type_counts[StateType.CANCELLED]
+        self.final_count: int = sum(state.is_final() for state in states)
+        self.not_final_count: int = self.total_count - self.final_count
+        self.paused_count: int = self.type_counts[StateType.PAUSED]
 
     @property
-    def fail_count(self):
+    def fail_count(self) -> int:
         return self.type_counts[StateType.FAILED] + self.type_counts[StateType.CRASHED]
 
     def all_completed(self) -> bool:
@@ -741,7 +745,7 @@ def Suspended(
     pause_expiration_time: Optional[datetime.datetime] = None,
     pause_key: Optional[str] = None,
     **kwargs: Any,
-):
+) -> "State[R]":
     """Convenience function for creating `Suspended` states.
 
     Returns: