prefect-client 3.4.7.dev9__tar.gz → 3.4.8.dev1__tar.gz

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prefect-client
-Version: 3.4.7.dev9
+Version: 3.4.8.dev1
 Summary: Workflow orchestration and management.
 Project-URL: Changelog, https://github.com/PrefectHQ/prefect/releases
 Project-URL: Documentation, https://docs.prefect.io

prefect_client-3.4.8.dev1/src/prefect/_build_info.py

@@ -0,0 +1,5 @@
+# Generated by versioningit
+__version__ = "3.4.8.dev1"
+__build_date__ = "2025-06-28 08:08:07.921914+00:00"
+__git_commit__ = "ad8588bf008accaf375ce8744ca3cc3b0f3b134e"
+__dirty__ = False

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/src/prefect/assets/core.py

@@ -5,7 +5,7 @@ from typing import Any, ClassVar, Optional
 from pydantic import ConfigDict, Field
 
 from prefect._internal.schemas.bases import PrefectBaseModel
-from prefect.types import URILike
+from prefect.types import ValidAssetKey
 
 
 class AssetProperties(PrefectBaseModel):
@@ -37,7 +37,7 @@ class Asset(PrefectBaseModel):
 
     model_config: ClassVar[ConfigDict] = ConfigDict(frozen=True)
 
-    key: URILike
+    key: ValidAssetKey
     properties: Optional[AssetProperties] = Field(
         default=None,
         description="Properties of the asset. "

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/src/prefect/server/api/server.py

@@ -922,6 +922,8 @@ class SubprocessASGIServer:
                 self.server_process.wait(timeout=5)
             except subprocess.TimeoutExpired:
                 self.server_process.kill()
+                # Ensure the process is reaped to avoid ResourceWarning
+                self.server_process.wait()
             finally:
                 self.server_process = None
         if self.port in self._instances:

prefect_client-3.4.8.dev1/src/prefect/settings/models/_defaults.py

@@ -0,0 +1,152 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING, Any
+
+from pydantic import SecretStr, ValidationInfo
+
+if TYPE_CHECKING:
+    from prefect.settings.models.root import Settings
+
+
+def default_profiles_path(values: dict[str, Any]) -> Path:
+    """Default profiles_path based on home directory."""
+    home = values.get("home", Path("~/.prefect").expanduser())
+    if not isinstance(home, Path):
+        home = Path("~/.prefect").expanduser()
+    return home / "profiles.toml"
+
+
+def substitute_home_template(v: Any, info: ValidationInfo) -> Any:
+    """Validator that substitutes $PREFECT_HOME in a path string if present."""
+    home_path = info.data.get("home")
+
+    path_str: str | None = None
+    if isinstance(v, Path):
+        return v
+    elif isinstance(v, str):
+        path_str = v
+    elif v is None:
+        return None
+    else:
+        return v
+
+    if path_str and "$PREFECT_HOME" in path_str:
+        if home_path and isinstance(home_path, Path):
+            resolved_str = path_str.replace("$PREFECT_HOME", str(home_path))
+            try:
+                return Path(resolved_str)
+            except Exception as e:
+                raise ValueError(
+                    f"Error creating path after substituting $PREFECT_HOME: {e}"
+                ) from e
+        else:
+            raise ValueError(
+                f'Cannot resolve $PREFECT_HOME in "{path_str}" because '
+                f"PREFECT_HOME setting ({home_path!r}) is not a valid resolved path."
+            )
+
+    return path_str
+
+
+def default_local_storage_path(values: dict[str, Any]) -> Path:
+    """Default local_storage_path based on home directory."""
+    home = values.get("home")
+    if not isinstance(home, Path):
+        home = Path("~/.prefect").expanduser()
+    return home / "storage"
+
+
+def default_memo_store_path(values: dict[str, Any]) -> Path:
+    """Default memo_store_path based on home directory."""
+    home = values.get("home")
+    if not isinstance(home, Path):
+        home = Path("~/.prefect").expanduser()
+    return home / "memo_store.toml"
+
+
+def default_logging_config_path(values: dict[str, Any]) -> Path:
+    """Default logging_config_path based on home directory."""
+    home = values.get("home")
+    if not isinstance(home, Path):
+        home = Path("~/.prefect").expanduser()
+    return home / "logging.yml"
+
+
+def default_database_connection_url(settings: "Settings") -> SecretStr:
+    value: str = f"sqlite+aiosqlite:///{settings.home}/prefect.db"
+    if settings.server.database.driver == "postgresql+asyncpg":
+        required = [
+            "host",
+            "user",
+            "name",
+            "password",
+        ]
+        missing = [
+            attr for attr in required if getattr(settings.server.database, attr) is None
+        ]
+        if missing:
+            raise ValueError(
+                f"Missing required database connection settings: {', '.join(missing)}"
+            )
+
+        from sqlalchemy import URL
+
+        value = URL(
+            drivername=settings.server.database.driver,
+            host=settings.server.database.host,
+            port=settings.server.database.port or 5432,
+            username=settings.server.database.user,
+            password=(
+                settings.server.database.password.get_secret_value()
+                if settings.server.database.password
+                else None
+            ),
+            database=settings.server.database.name,
+            query=[],  # type: ignore
+        ).render_as_string(hide_password=False)
+
+    elif settings.server.database.driver == "sqlite+aiosqlite":
+        if settings.server.database.name:
+            value = (
+                f"{settings.server.database.driver}:///{settings.server.database.name}"
+            )
+        else:
+            value = f"sqlite+aiosqlite:///{settings.home}/prefect.db"
+
+    elif settings.server.database.driver:
+        raise ValueError(
+            f"Unsupported database driver: {settings.server.database.driver}"
+        )
+    return SecretStr(value)
+
+
+def default_ui_url(settings: "Settings") -> str | None:
+    value = settings.ui_url
+    if value is not None:
+        return value
+
+    # Otherwise, infer a value from the API URL
+    ui_url = api_url = settings.api.url
+
+    if not api_url:
+        return None
+    assert ui_url is not None
+
+    cloud_url = settings.cloud.api_url
+    cloud_ui_url = settings.cloud.ui_url
+    if api_url.startswith(cloud_url) and cloud_ui_url:
+        ui_url = ui_url.replace(cloud_url, cloud_ui_url)
+
+    if ui_url.endswith("/api"):
+        # Handles open-source APIs
+        ui_url = ui_url[:-4]
+
+    # Handles Cloud APIs with content after `/api`
+    ui_url = ui_url.replace("/api/", "/")
+
+    # Update routing
+    ui_url = ui_url.replace("/accounts/", "/account/")
+    ui_url = ui_url.replace("/workspaces/", "/workspace/")
+
+    return ui_url

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/src/prefect/settings/models/logging.py

@@ -1,6 +1,6 @@
 from functools import partial
 from pathlib import Path
-from typing import Annotated, Any, ClassVar, Literal, Optional, Union
+from typing import Annotated, Any, ClassVar, Literal, Union
 
 from pydantic import (
     AliasChoices,
@@ -15,6 +15,8 @@ from typing_extensions import Self
 from prefect.settings.base import PrefectBaseSettings, build_settings_config
 from prefect.types import LogLevel, validate_set_T_from_delim_string
 
+from ._defaults import default_logging_config_path
+
 
 def max_log_size_smaller_than_batch_size(values: dict[str, Any]) -> dict[str, Any]:
     """
@@ -95,9 +97,9 @@ class LoggingSettings(PrefectBaseSettings):
         description="The default logging level for Prefect loggers.",
     )
 
-    config_path: Optional[Path] = Field(
-        default=None,
-        description="The path to a custom YAML logging configuration file.",
+    config_path: Path = Field(
+        default_factory=default_logging_config_path,
+        description="A path to a logging configuration file. Defaults to $PREFECT_HOME/logging.yml",
         validation_alias=AliasChoices(
             AliasPath("config_path"),
             "prefect_logging_config_path",

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/src/prefect/settings/models/results.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pathlib import Path
 from typing import ClassVar, Optional
 
@@ -6,6 +8,8 @@ from pydantic_settings import SettingsConfigDict
 
 from prefect.settings.base import PrefectBaseSettings, build_settings_config
 
+from ._defaults import default_local_storage_path
+
 
 class ResultsSettings(PrefectBaseSettings):
     """
@@ -34,9 +38,9 @@ class ResultsSettings(PrefectBaseSettings):
         ),
     )
 
-    local_storage_path: Optional[Path] = Field(
-        default=None,
-        description="The path to a directory to store results in.",
+    local_storage_path: Path = Field(
+        default_factory=default_local_storage_path,
+        description="The default location for locally persisted results. Defaults to $PREFECT_HOME/storage.",
         validation_alias=AliasChoices(
             AliasPath("local_storage_path"),
             "prefect_results_local_storage_path",

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/src/prefect/settings/models/root.py

@@ -21,6 +21,12 @@ from prefect.settings.models.testing import TestingSettings
 from prefect.settings.models.worker import WorkerSettings
 from prefect.utilities.collections import deep_merge_dicts, set_in_dict
 
+from ._defaults import (
+    default_database_connection_url,
+    default_profiles_path,
+    default_ui_url,
+    substitute_home_template,
+)
 from .api import APISettings
 from .cli import CLISettings
 from .client import ClientSettings
@@ -52,9 +58,12 @@ class Settings(PrefectBaseSettings):
         description="The path to the Prefect home directory. Defaults to ~/.prefect",
     )
 
-    profiles_path: Optional[Path] = Field(
-        default=None,
-        description="The path to a profiles configuration file.",
+    profiles_path: Annotated[Path, BeforeValidator(substitute_home_template)] = Field(
+        default_factory=default_profiles_path,
+        description=(
+            "The path to a profiles configuration file. Supports $PREFECT_HOME templating."
+            " Defaults to $PREFECT_HOME/profiles.toml."
+        ),
     )
 
     debug_mode: bool = Field(
@@ -175,14 +184,14 @@ class Settings(PrefectBaseSettings):
 
     @model_validator(mode="after")
     def post_hoc_settings(self) -> Self:
-        """refactor on resolution of https://github.com/pydantic/pydantic/issues/9789
+        """Handle remaining complex default assignments that aren't yet migrated to dependent settings.
 
-        we should not be modifying __pydantic_fields_set__ directly, but until we can
-        define dependencies between defaults in a first-class way, we need clean up
-        post-hoc default assignments to keep set/unset fields correct after instantiation.
+        With Pydantic 2.10's dependent settings feature, we've migrated simple path-based defaults
+        to use default_factory. The remaining items here require access to the full Settings instance
+        or have complex interdependencies that will be migrated in future PRs.
         """
         if self.ui_url is None:
-            self.ui_url = _default_ui_url(self)
+            self.ui_url = default_ui_url(self)
             self.__pydantic_fields_set__.remove("ui_url")
         if self.server.ui.api_url is None:
             if self.api.url:
@@ -193,27 +202,15 @@ class Settings(PrefectBaseSettings):
                     f"http://{self.server.api.host}:{self.server.api.port}/api"
                 )
                 self.server.ui.__pydantic_fields_set__.remove("api_url")
-        if self.profiles_path is None or "PREFECT_HOME" in str(self.profiles_path):
-            self.profiles_path = Path(f"{self.home}/profiles.toml")
-            self.__pydantic_fields_set__.remove("profiles_path")
-        if self.results.local_storage_path is None:
-            self.results.local_storage_path = Path(f"{self.home}/storage")
-            self.results.__pydantic_fields_set__.remove("local_storage_path")
-        if self.server.memo_store_path is None:
-            self.server.memo_store_path = Path(f"{self.home}/memo_store.toml")
-            self.server.__pydantic_fields_set__.remove("memo_store_path")
         if self.debug_mode or self.testing.test_mode:
             self.logging.level = "DEBUG"
             self.internal.logging_level = "DEBUG"
             self.logging.__pydantic_fields_set__.remove("level")
             self.internal.__pydantic_fields_set__.remove("logging_level")
 
-        if self.logging.config_path is None:
-            self.logging.config_path = Path(f"{self.home}/logging.yml")
-            self.logging.__pydantic_fields_set__.remove("config_path")
         # Set default database connection URL if not provided
         if self.server.database.connection_url is None:
-            self.server.database.connection_url = _default_database_connection_url(self)
+            self.server.database.connection_url = default_database_connection_url(self)
             self.server.database.__pydantic_fields_set__.remove("connection_url")
         db_url = self.server.database.connection_url.get_secret_value()
         if (
@@ -238,6 +235,7 @@ class Settings(PrefectBaseSettings):
             )
             self.server.database.connection_url = SecretStr(db_url)
             self.server.database.__pydantic_fields_set__.remove("connection_url")
+
         return self
 
     @model_validator(mode="after")
@@ -330,37 +328,6 @@ class Settings(PrefectBaseSettings):
         return str(hash(tuple((key, value) for key, value in env_variables.items())))
 
 
-def _default_ui_url(settings: "Settings") -> Optional[str]:
-    value = settings.ui_url
-    if value is not None:
-        return value
-
-    # Otherwise, infer a value from the API URL
-    ui_url = api_url = settings.api.url
-
-    if not api_url:
-        return None
-    assert ui_url is not None
-
-    cloud_url = settings.cloud.api_url
-    cloud_ui_url = settings.cloud.ui_url
-    if api_url.startswith(cloud_url) and cloud_ui_url:
-        ui_url = ui_url.replace(cloud_url, cloud_ui_url)
-
-    if ui_url.endswith("/api"):
-        # Handles open-source APIs
-        ui_url = ui_url[:-4]
-
-    # Handles Cloud APIs with content after `/api`
-    ui_url = ui_url.replace("/api/", "/")
-
-    # Update routing
-    ui_url = ui_url.replace("/accounts/", "/account/")
-    ui_url = ui_url.replace("/workspaces/", "/workspace/")
-
-    return ui_url
-
-
 def _warn_on_misconfigured_api_url(settings: "Settings"):
     """
     Validator for settings warning if the API URL is misconfigured.
@@ -404,53 +371,5 @@ def _warn_on_misconfigured_api_url(settings: "Settings"):
     return settings
 
 
-def _default_database_connection_url(settings: "Settings") -> SecretStr:
-    value: str = f"sqlite+aiosqlite:///{settings.home}/prefect.db"
-    if settings.server.database.driver == "postgresql+asyncpg":
-        required = [
-            "host",
-            "user",
-            "name",
-            "password",
-        ]
-        missing = [
-            attr for attr in required if getattr(settings.server.database, attr) is None
-        ]
-        if missing:
-            raise ValueError(
-                f"Missing required database connection settings: {', '.join(missing)}"
-            )
-
-        from sqlalchemy import URL
-
-        value = URL(
-            drivername=settings.server.database.driver,
-            host=settings.server.database.host,
-            port=settings.server.database.port or 5432,
-            username=settings.server.database.user,
-            password=(
-                settings.server.database.password.get_secret_value()
-                if settings.server.database.password
-                else None
-            ),
-            database=settings.server.database.name,
-            query=[],  # type: ignore
-        ).render_as_string(hide_password=False)
-
-    elif settings.server.database.driver == "sqlite+aiosqlite":
-        if settings.server.database.name:
-            value = (
-                f"{settings.server.database.driver}:///{settings.server.database.name}"
-            )
-        else:
-            value = f"sqlite+aiosqlite:///{settings.home}/prefect.db"
-
-    elif settings.server.database.driver:
-        raise ValueError(
-            f"Unsupported database driver: {settings.server.database.driver}"
-        )
-    return SecretStr(value)
-
-
 def canonical_environment_prefix(settings: "Settings") -> str:
     return settings.model_config.get("env_prefix") or ""

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/src/prefect/settings/models/server/root.py

@@ -1,5 +1,7 @@
+from __future__ import annotations
+
 from pathlib import Path
-from typing import ClassVar, Optional
+from typing import ClassVar
 
 from pydantic import AliasChoices, AliasPath, Field
 from pydantic_settings import SettingsConfigDict
@@ -7,6 +9,7 @@ from pydantic_settings import SettingsConfigDict
 from prefect.settings.base import PrefectBaseSettings, build_settings_config
 from prefect.types import LogLevel
 
+from .._defaults import default_memo_store_path
 from .api import ServerAPISettings
 from .database import ServerDatabaseSettings
 from .deployments import ServerDeploymentsSettings
@@ -84,9 +87,9 @@ class ServerSettings(PrefectBaseSettings):
         ),
     )
 
-    memo_store_path: Optional[Path] = Field(
-        default=None,
-        description="The path to the memo store file.",
+    memo_store_path: Path = Field(
+        default_factory=default_memo_store_path,
+        description="Path to the memo store file. Defaults to $PREFECT_HOME/memo_store.toml",
         validation_alias=AliasChoices(
             AliasPath("memo_store_path"),
             "prefect_server_memo_store_path",

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/src/prefect/tasks.py

@@ -723,37 +723,44 @@ class Task(Generic[P, R]):
 
         Examples:
 
-            Create a new task from an existing task and update the name
+            Create a new task from an existing task and update the name:
 
-            >>> @task(name="My task")
-            >>> def my_task():
-            >>>     return 1
-            >>>
-            >>> new_task = my_task.with_options(name="My new task")
+            ```python
+            @task(name="My task")
+            def my_task():
+                return 1
 
-            Create a new task from an existing task and update the retry settings
+            new_task = my_task.with_options(name="My new task")
+            ```
 
-            >>> from random import randint
-            >>>
-            >>> @task(retries=1, retry_delay_seconds=5)
-            >>> def my_task():
-            >>>     x = randint(0, 5)
-            >>>     if x >= 3:  # Make a task that fails sometimes
-            >>>         raise ValueError("Retry me please!")
-            >>>     return x
-            >>>
-            >>> new_task = my_task.with_options(retries=5, retry_delay_seconds=2)
+            Create a new task from an existing task and update the retry settings:
 
-            Use a task with updated options within a flow
+            ```python
+            from random import randint
+
+            @task(retries=1, retry_delay_seconds=5)
+            def my_task():
+                x = randint(0, 5)
+                if x >= 3:  # Make a task that fails sometimes
+                    raise ValueError("Retry me please!")
+                return x
+
+            new_task = my_task.with_options(retries=5, retry_delay_seconds=2)
+            ```
+
+            Use a task with updated options within a flow:
+
+            ```python
+            @task(name="My task")
+            def my_task():
+                return 1
+
+            @flow
+            my_flow():
+                new_task = my_task.with_options(name="My new task")
+                new_task()
+            ```
 
-            >>> @task(name="My task")
-            >>> def my_task():
-            >>>     return 1
-            >>>
-            >>> @flow
-            >>> my_flow():
-            >>>     new_task = my_task.with_options(name="My new task")
-            >>>     new_task()
         """
         return Task(
             fn=self.fn,
@@ -2035,3 +2042,44 @@ class MaterializingTask(Task[P, R]):
             Asset(key=a) if isinstance(a, str) else a for a in assets
         ]
         self.materialized_by = materialized_by
+
+    def with_options(
+        self,
+        assets: Optional[Sequence[Union[str, Asset]]] = None,
+        **task_kwargs: Unpack[TaskOptions],
+    ) -> "MaterializingTask[P, R]":
+        import inspect
+
+        sig = inspect.signature(Task.__init__)
+
+        # Map parameter names to attribute names where they differ
+        # from parameter to attribute.
+        param_to_attr = {
+            "on_completion": "on_completion_hooks",
+            "on_failure": "on_failure_hooks",
+            "on_rollback": "on_rollback_hooks",
+            "on_commit": "on_commit_hooks",
+        }
+
+        # Build kwargs for Task constructor
+        init_kwargs = {}
+        for param_name in sig.parameters:
+            if param_name in ("self", "fn", "assets", "materialized_by"):
+                continue
+
+            attr_name = param_to_attr.get(param_name, param_name)
+            init_kwargs[param_name] = task_kwargs.get(
+                param_name, getattr(self, attr_name)
+            )
+
+        return MaterializingTask(
+            fn=self.fn,
+            assets=(
+                [Asset(key=a) if isinstance(a, str) else a for a in assets]
+                if assets is not None
+                else self.assets
+            ),
+            materialized_by=self.materialized_by,
+            # Now, the rest
+            **init_kwargs,
+        )

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/src/prefect/types/__init__.py

@@ -15,6 +15,7 @@ from .names import (
     WITHOUT_BANNED_CHARACTERS,
     MAX_VARIABLE_NAME_LENGTH,
     URILike,
+    ValidAssetKey,
 )
 from pydantic import (
     BeforeValidator,
@@ -216,6 +217,7 @@ __all__ = [
     "Name",
     "NameOrEmpty",
     "NonEmptyishName",
+    "ValidAssetKey",
     "SecretDict",
     "StatusCode",
     "StrictVariableValue",

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev1}/src/prefect/types/names.py

@@ -160,3 +160,53 @@ URILike = Annotated[
         examples=["s3://bucket/folder/data.csv", "postgres://dbtable"],
     ),
 ]
+
+
+MAX_ASSET_KEY_LENGTH = 512
+
+RESTRICTED_ASSET_CHARACTERS = [
+    "\n",
+    "\r",
+    "\t",
+    "\0",
+    " ",
+    "#",
+    "?",
+    "&",
+    "%",
+    '"',
+    "'",
+    "<",
+    ">",
+    "[",
+    "]",
+    "{",
+    "}",
+    "|",
+    "\\",
+    "^",
+    "`",
+]
+
+
+def validate_valid_asset_key(value: str) -> str:
+    """Validate asset key with character restrictions and length limit."""
+    for char in RESTRICTED_ASSET_CHARACTERS:
+        if char in value:
+            raise ValueError(f"Asset key cannot contain '{char}'")
+
+    if len(value) > MAX_ASSET_KEY_LENGTH:
+        raise ValueError(f"Asset key cannot exceed {MAX_ASSET_KEY_LENGTH} characters")
+
+    return validate_uri(value)
+
+
+ValidAssetKey = Annotated[
+    str,
+    AfterValidator(validate_valid_asset_key),
+    Field(
+        max_length=MAX_ASSET_KEY_LENGTH,
+        description=f"A URI-like string with a lowercase protocol, restricted characters, and max {MAX_ASSET_KEY_LENGTH} characters",
+        examples=["s3://bucket/folder/data.csv", "postgres://dbtable"],
+    ),
+]

prefect_client-3.4.7.dev9/src/prefect/_build_info.py

@@ -1,5 +0,0 @@
-# Generated by versioningit
-__version__ = "3.4.7.dev9"
-__build_date__ = "2025-06-26 08:09:22.695909+00:00"
-__git_commit__ = "6128bf88e0089a6ef517493eafb157d523ed0afd"
-__dirty__ = False