prefect-client 3.0.11__py3-none-any.whl → 3.1.0__py3-none-any.whl

prefect/settings/models/experiments.py

@@ -0,0 +1,24 @@
+from pydantic import AliasChoices, AliasPath, Field
+
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
+
+
+class ExperimentsSettings(PrefectBaseSettings):
+    """
+    Settings for configuring experimental features
+    """
+
+    model_config = _build_settings_config(("experiments",))
+
+    warn: bool = Field(
+        default=True,
+        description="If `True`, warn on usage of experimental features.",
+        validation_alias=AliasChoices(
+            AliasPath("warn"), "prefect_experiments_warn", "prefect_experimental_warn"
+        ),
+    )
+
+    worker_logging_to_api_enabled: bool = Field(
+        default=False,
+        description="Enables the logging of worker logs to Prefect Cloud.",
+    )

prefect/settings/models/flows.py

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

prefect/settings/models/internal.py

@@ -1,14 +1,11 @@
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 from prefect.types import LogLevel
 
 
 class InternalSettings(PrefectBaseSettings):
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_INTERNAL_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("internal",))
 
     logging_level: LogLevel = Field(
         default="ERROR",

prefect/settings/models/logging.py

@@ -2,10 +2,9 @@ from pathlib import Path
 from typing import Annotated, Literal, Optional, Union
 
 from pydantic import AfterValidator, AliasChoices, AliasPath, Field, model_validator
-from pydantic_settings import SettingsConfigDict
 from typing_extensions import Self
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 from prefect.types import LogLevel
 
 
@@ -26,9 +25,7 @@ class LoggingToAPISettings(PrefectBaseSettings):
     Settings for controlling logging to the API
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_LOGGING_TO_API_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("logging", "to_api"))
 
     enabled: bool = Field(
         default=True,
@@ -81,9 +78,7 @@ class LoggingSettings(PrefectBaseSettings):
     Settings for controlling logging behavior
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_LOGGING_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("logging",))
 
     level: LogLevel = Field(
         default="INFO",

prefect/settings/models/results.py

@@ -2,9 +2,8 @@ from pathlib import Path
 from typing import Optional
 
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ResultsSettings(PrefectBaseSettings):
@@ -12,9 +11,7 @@ class ResultsSettings(PrefectBaseSettings):
     Settings for controlling result storage behavior
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_RESULTS_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("results",))
 
     default_serializer: str = Field(
         default="pickle",

prefect/settings/models/root.py

@@ -11,10 +11,9 @@ from typing import (
 from urllib.parse import urlparse
 
 from pydantic import BeforeValidator, Field, SecretStr, model_validator
-from pydantic_settings import SettingsConfigDict
 from typing_extensions import Self
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 from prefect.settings.models.tasks import TasksSettings
 from prefect.settings.models.testing import TestingSettings
 from prefect.settings.models.worker import WorkerSettings
@@ -25,6 +24,7 @@ from .cli import CLISettings
 from .client import ClientSettings
 from .cloud import CloudSettings
 from .deployments import DeploymentsSettings
+from .experiments import ExperimentsSettings
 from .flows import FlowsSettings
 from .internal import InternalSettings
 from .logging import LoggingSettings
@@ -43,12 +43,7 @@ class Settings(PrefectBaseSettings):
     See https://docs.pydantic.dev/latest/concepts/pydantic_settings
     """
 
-    model_config = SettingsConfigDict(
-        env_file=".env",
-        env_prefix="PREFECT_",
-        env_nested_delimiter=None,
-        extra="ignore",
-    )
+    model_config = _build_settings_config()
 
     home: Annotated[Path, BeforeValidator(lambda x: Path(x).expanduser())] = Field(
         default=Path("~") / ".prefect",
@@ -90,6 +85,11 @@ class Settings(PrefectBaseSettings):
         description="Settings for configuring deployments defaults",
     )
 
+    experiments: ExperimentsSettings = Field(
+        default_factory=ExperimentsSettings,
+        description="Settings for controlling experimental features",
+    )
+
     flows: FlowsSettings = Field(
         default_factory=FlowsSettings,
         description="Settings for controlling flow behavior",
@@ -149,30 +149,6 @@ class Settings(PrefectBaseSettings):
         """,
     )
 
-    experimental_warn: bool = Field(
-        default=True,
-        description="If `True`, warn on usage of experimental features.",
-    )
-
-    # this setting needs to be removed
-    async_fetch_state_result: bool = Field(
-        default=False,
-        description="""
-        Determines whether `State.result()` fetches results automatically or not.
-        In Prefect 2.6.0, the `State.result()` method was updated to be async
-        to facilitate automatic retrieval of results from storage which means when
-        writing async code you must `await` the call. For backwards compatibility,
-        the result is not retrieved by default for async users. You may opt into this
-        per call by passing  `fetch=True` or toggle this setting to change the behavior
-        globally.
-        """,
-    )
-
-    experimental_enable_schedule_concurrency: bool = Field(
-        default=False,
-        description="Whether or not to enable concurrency for scheduled tasks.",
-    )
-
     ###########################################################################
     # allow deprecated access to PREFECT_SOME_SETTING_NAME
 
@@ -295,9 +271,32 @@ class Settings(PrefectBaseSettings):
         Returns:
             A new Settings object.
         """
+        # To restore defaults, we need to resolve the setting path and then
+        # set the default value on the new settings object. When restoring
+        # defaults, all settings sources will be ignored.
         restore_defaults_obj = {}
         for r in restore_defaults or []:
-            set_in_dict(restore_defaults_obj, r.accessor, True)
+            path = r.accessor.split(".")
+            model = self
+            for key in path[:-1]:
+                model = model.model_fields[key].annotation
+                assert model is not None, f"Invalid setting path: {r.accessor}"
+
+            model_field = model.model_fields[path[-1]]
+            assert model is not None, f"Invalid setting path: {r.accessor}"
+            if hasattr(model_field, "default"):
+                default = model_field.default
+            elif (
+                hasattr(model_field, "default_factory") and model_field.default_factory
+            ):
+                default = model_field.default_factory()
+            else:
+                raise ValueError(f"No default value for setting: {r.accessor}")
+            set_in_dict(
+                restore_defaults_obj,
+                r.accessor,
+                default,
+            )
         updates = updates or {}
         set_defaults = set_defaults or {}
 
@@ -312,7 +311,8 @@ class Settings(PrefectBaseSettings):
         new_settings = self.__class__.model_validate(
             deep_merge_dicts(
                 set_defaults_obj,
-                self.model_dump(exclude_unset=True, exclude=restore_defaults_obj),
+                self.model_dump(exclude_unset=True),
+                restore_defaults_obj,
                 updates_obj,
             )
         )

prefect/settings/models/runner.py

@@ -1,7 +1,6 @@
 from pydantic import Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 from prefect.types import LogLevel
 
 
@@ -10,9 +9,7 @@ class RunnerServerSettings(PrefectBaseSettings):
     Settings for controlling runner server behavior
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_RUNNER_SERVER_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("runner", "server"))
 
     enable: bool = Field(
         default=False,
@@ -45,9 +42,7 @@ class RunnerSettings(PrefectBaseSettings):
     Settings for controlling runner behavior
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_RUNNER_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("runner",))
 
     process_limit: int = Field(
         default=5,

prefect/settings/models/server/api.py

@@ -1,9 +1,8 @@
 from datetime import timedelta
 
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerAPISettings(PrefectBaseSettings):
@@ -11,9 +10,7 @@ class ServerAPISettings(PrefectBaseSettings):
     Settings for controlling API server behavior
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_API_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server", "api"))
 
     host: str = Field(
         default="127.0.0.1",

prefect/settings/models/server/database.py

@@ -3,10 +3,9 @@ from typing import Optional
 from urllib.parse import quote_plus
 
 from pydantic import AliasChoices, AliasPath, Field, SecretStr, model_validator
-from pydantic_settings import SettingsConfigDict
 from typing_extensions import Literal, Self
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerDatabaseSettings(PrefectBaseSettings):
@@ -14,11 +13,7 @@ class ServerDatabaseSettings(PrefectBaseSettings):
     Settings for controlling server database behavior
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_DATABASE_",
-        env_file=".env",
-        extra="ignore",
-    )
+    model_config = _build_settings_config(("server", "database"))
 
     connection_url: Optional[SecretStr] = Field(
         default=None,

prefect/settings/models/server/deployments.py

@@ -1,13 +1,10 @@
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerDeploymentsSettings(PrefectBaseSettings):
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_DEPLOYMENTS_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server", "deployments"))
 
     concurrency_slot_wait_seconds: float = Field(
         default=30.0,

prefect/settings/models/server/ephemeral.py

@@ -1,7 +1,6 @@
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerEphemeralSettings(PrefectBaseSettings):
@@ -9,9 +8,7 @@ class ServerEphemeralSettings(PrefectBaseSettings):
     Settings for controlling ephemeral server behavior
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_EPHEMERAL_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server", "ephemeral"))
 
     enabled: bool = Field(
         default=False,

prefect/settings/models/server/events.py

@@ -1,9 +1,8 @@
 from datetime import timedelta
 
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerEventsSettings(PrefectBaseSettings):
@@ -11,9 +10,7 @@ class ServerEventsSettings(PrefectBaseSettings):
     Settings for controlling behavior of the events subsystem
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_EVENTS_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server", "events"))
 
     ###########################################################################
     # Events settings

prefect/settings/models/server/flow_run_graph.py

@@ -1,7 +1,6 @@
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerFlowRunGraphSettings(PrefectBaseSettings):
@@ -9,9 +8,7 @@ class ServerFlowRunGraphSettings(PrefectBaseSettings):
     Settings for controlling behavior of the flow run graph
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_FLOW_RUN_GRAPH_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server", "flow_run_graph"))
 
     max_nodes: int = Field(
         default=10000,

prefect/settings/models/server/root.py

@@ -2,9 +2,8 @@ from pathlib import Path
 from typing import Optional
 
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 from prefect.types import LogLevel
 
 from .api import ServerAPISettings
@@ -23,9 +22,7 @@ class ServerSettings(PrefectBaseSettings):
     Settings for controlling server behavior
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server",))
 
     logging_level: LogLevel = Field(
         default="WARNING",

prefect/settings/models/server/services.py

@@ -1,9 +1,8 @@
 from datetime import timedelta
 
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerServicesCancellationCleanupSettings(PrefectBaseSettings):
@@ -11,10 +10,8 @@ class ServerServicesCancellationCleanupSettings(PrefectBaseSettings):
     Settings for controlling the cancellation cleanup service
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_CANCELLATION_CLEANUP_",
-        env_file=".env",
-        extra="ignore",
+    model_config = _build_settings_config(
+        ("server", "services", "cancellation_cleanup")
     )
 
     enabled: bool = Field(
@@ -43,11 +40,7 @@ class ServerServicesEventPersisterSettings(PrefectBaseSettings):
     Settings for controlling the event persister service
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_EVENT_PERSISTER_",
-        env_file=".env",
-        extra="ignore",
-    )
+    model_config = _build_settings_config(("server", "services", "event_persister"))
 
     enabled: bool = Field(
         default=True,
@@ -87,10 +80,8 @@ class ServerServicesFlowRunNotificationsSettings(PrefectBaseSettings):
     Settings for controlling the flow run notifications service
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_FLOW_RUN_NOTIFICATIONS_",
-        env_file=".env",
-        extra="ignore",
+    model_config = _build_settings_config(
+        ("server", "services", "flow_run_notifications")
     )
 
     enabled: bool = Field(
@@ -109,11 +100,7 @@ class ServerServicesForemanSettings(PrefectBaseSettings):
     Settings for controlling the foreman service
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_FOREMAN_",
-        env_file=".env",
-        extra="ignore",
-    )
+    model_config = _build_settings_config(("server", "services", "foreman"))
 
     enabled: bool = Field(
         default=True,
@@ -192,9 +179,7 @@ class ServerServicesLateRunsSettings(PrefectBaseSettings):
     Settings for controlling the late runs service
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_LATE_RUNS_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server", "services", "late_runs"))
 
     enabled: bool = Field(
         default=True,
@@ -236,9 +221,7 @@ class ServerServicesSchedulerSettings(PrefectBaseSettings):
     Settings for controlling the scheduler service
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_SCHEDULER_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server", "services", "scheduler"))
 
     enabled: bool = Field(
         default=True,
@@ -361,11 +344,7 @@ class ServerServicesPauseExpirationsSettings(PrefectBaseSettings):
     Settings for controlling the pause expiration service
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_PAUSE_EXPIRATIONS_",
-        env_file=".env",
-        extra="ignore",
-    )
+    model_config = _build_settings_config(("server", "services", "pause_expirations"))
 
     enabled: bool = Field(
         default=True,
@@ -399,11 +378,7 @@ class ServerServicesTaskRunRecorderSettings(PrefectBaseSettings):
     Settings for controlling the task run recorder service
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_TASK_RUN_RECORDER_",
-        env_file=".env",
-        extra="ignore",
-    )
+    model_config = _build_settings_config(("server", "services", "task_run_recorder"))
 
     enabled: bool = Field(
         default=True,
@@ -421,11 +396,7 @@ class ServerServicesTriggersSettings(PrefectBaseSettings):
     Settings for controlling the triggers service
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_TRIGGERS_",
-        env_file=".env",
-        extra="ignore",
-    )
+    model_config = _build_settings_config(("server", "services", "triggers"))
 
     enabled: bool = Field(
         default=True,
@@ -443,9 +414,7 @@ class ServerServicesSettings(PrefectBaseSettings):
     Settings for controlling server services
     """
 
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_SERVICES_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server", "services"))
 
     cancellation_cleanup: ServerServicesCancellationCleanupSettings = Field(
         default_factory=ServerServicesCancellationCleanupSettings,

prefect/settings/models/server/tasks.py

@@ -1,9 +1,8 @@
 from datetime import timedelta
 
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerTasksSchedulingSettings(PrefectBaseSettings):
@@ -11,11 +10,7 @@ class ServerTasksSchedulingSettings(PrefectBaseSettings):
     Settings for controlling server-side behavior related to task scheduling
     """
 
-    model_config = SettingsConfigDict(
-        env_file=".env",
-        env_prefix="PREFECT_SERVER_TASKS_SCHEDULING_",
-        extra="ignore",
-    )
+    model_config = _build_settings_config(("server", "tasks", "scheduling"))
 
     max_scheduled_queue_size: int = Field(
         default=1000,
@@ -53,11 +48,7 @@ class ServerTasksSettings(PrefectBaseSettings):
     Settings for controlling server-side behavior related to tasks
     """
 
-    model_config = SettingsConfigDict(
-        env_file=".env",
-        env_prefix="PREFECT_SERVER_TASKS_",
-        extra="ignore",
-    )
+    model_config = _build_settings_config(("server", "tasks"))
 
     tag_concurrency_slot_wait_seconds: float = Field(
         default=30,

prefect/settings/models/server/ui.py

@@ -1,15 +1,12 @@
 from typing import Optional
 
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerUISettings(PrefectBaseSettings):
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_SERVER_UI_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("server", "ui"))
 
     enabled: bool = Field(
         default=True,

prefect/settings/models/tasks.py

@@ -1,15 +1,12 @@
 from typing import Optional, Union
 
 from pydantic import AliasChoices, AliasPath, Field
-from pydantic_settings import SettingsConfigDict
 
-from prefect.settings.base import PrefectBaseSettings
+from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class TasksRunnerSettings(PrefectBaseSettings):
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_TASKS_RUNNER_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("tasks", "runner"))
 
     thread_pool_max_workers: Optional[int] = Field(
         default=None,
@@ -24,9 +21,7 @@ class TasksRunnerSettings(PrefectBaseSettings):
 
 
 class TasksSchedulingSettings(PrefectBaseSettings):
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_TASKS_SCHEDULING_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("tasks", "scheduling"))
 
     default_storage_block: Optional[str] = Field(
         default=None,
@@ -50,9 +45,7 @@ class TasksSchedulingSettings(PrefectBaseSettings):
 
 
 class TasksSettings(PrefectBaseSettings):
-    model_config = SettingsConfigDict(
-        env_prefix="PREFECT_TASKS_", env_file=".env", extra="ignore"
-    )
+    model_config = _build_settings_config(("tasks",))
 
     refresh_cache: bool = Field(
         default=False,
@@ -80,6 +73,12 @@ class TasksSettings(PrefectBaseSettings):
         ),
     )
 
+    default_persist_result: Optional[bool] = Field(
+        default=None,
+        description="If `True`, results will be persisted by default for all tasks. Set to `False` to disable persistence by default. "
+        "Note that setting to `False` will override the behavior set by a parent flow or task.",
+    )
+
     runner: TasksRunnerSettings = Field(
         default_factory=TasksRunnerSettings,
         description="Settings for controlling task runner behavior",