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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prefect-client
-Version: 3.4.7.dev9
+Version: 3.4.8.dev2
 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.dev2/src/prefect/_build_info.py

@@ -0,0 +1,5 @@
+# Generated by versioningit
+__version__ = "3.4.8.dev2"
+__build_date__ = "2025-07-01 08:09:14.528238+00:00"
+__git_commit__ = "0efc8d5417789ba9a27156e816f1ce28ac0924ee"
+__dirty__ = False

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev2}/src/prefect/_internal/uuid7.py

@@ -74,17 +74,19 @@ def uuid7(
     Examples
     --------
 
-    >>> uuid7()
-    UUID('061cb26a-54b8-7a52-8000-2124e7041024')
-
-    >>> for fmt in ('bytes', 'hex', 'int', 'str', 'uuid', None):
-    ...     print(fmt, repr(uuid7(as_type=fmt)))
-    bytes b'\x06\x1c\xb8\xfe\x0f\x0b|9\x80\x00\tjt\x85\xb3\xbb'
-    hex '061cb8fe0f0b7c3980011863b956b758'
-    int 8124504378724980906989670469352026642
-    str '061cb8fe-0f0b-7c39-8003-d44a7ee0bdf6'
-    uuid UUID('061cb8fe-0f0b-7c39-8004-0489578299f6')
-    None UUID('061cb8fe-0f0f-7df2-8000-afd57c2bf446')
+    ```python
+    uuid7()
+    # UUID('061cb26a-54b8-7a52-8000-2124e7041024')
+
+    for fmt in ('bytes', 'hex', 'int', 'str', 'uuid', None):
+        print(fmt, repr(uuid7(as_type=fmt)))
+    # bytes b'\x06\x1c\xb8\xfe\x0f\x0b|9\x80\x00\tjt\x85\xb3\xbb'
+    # hex '061cb8fe0f0b7c3980011863b956b758'
+    # int 8124504378724980906989670469352026642
+    # str '061cb8fe-0f0b-7c39-8003-d44a7ee0bdf6'
+    # uuid UUID('061cb8fe-0f0b-7c39-8004-0489578299f6')
+    # None UUID('061cb8fe-0f0f-7df2-8000-afd57c2bf446')
+    ```
     """
     if ms is None:
         ms = time_func()

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev2}/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.dev2}/src/prefect/client/__init__.py

@@ -7,10 +7,10 @@ Explore the client by communicating with an in-memory webserver - no setup requi
 ```
 $ # start python REPL with native await functionality
 $ python -m asyncio
->>> from prefect.client.orchestration import get_client
->>> async with get_client() as client:
-...     response = await client.hello()
-...     print(response.json())
+from prefect.client.orchestration import get_client
+async with get_client() as client:
+    response = await client.hello()
+    print(response.json())
 👋
 ```
 </div>

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev2}/src/prefect/client/orchestration/__init__.py

@@ -292,15 +292,13 @@ class PrefectClient(
 
         Say hello to a Prefect REST API
 
-        <div class="terminal">
-        ```
-        >>> async with get_client() as client:
-        >>>     response = await client.hello()
-        >>>
-        >>> print(response.json())
+        ```python
+        async with get_client() as client:
+            response = await client.hello()
+
+        print(response.json())
         👋
         ```
-        </div>
     """
 
     def __init__(
@@ -1157,15 +1155,13 @@ class SyncPrefectClient(
 
         Say hello to a Prefect REST API
 
-        <div class="terminal">
-        ```
-        >>> with get_client(sync_client=True) as client:
-        >>>     response = client.hello()
-        >>>
-        >>> print(response.json())
+        ```python
+        with get_client(sync_client=True) as client:
+            response = client.hello()
+
+        print(response.json())
         👋
         ```
-        </div>
     """
 
     def __init__(

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev2}/src/prefect/client/schemas/objects.py

@@ -305,48 +305,58 @@ class State(TimeSeriesBaseModel, ObjectBaseModel, Generic[R]):
         Examples:
             Get the result from a flow state
 
-            >>> @flow
-            >>> def my_flow():
-            >>>     return "hello"
-            >>> my_flow(return_state=True).result()
-            hello
+            ```python
+            @flow
+            def my_flow():
+                return "hello"
+            my_flow(return_state=True).result()
+            # hello
+            ```
 
             Get the result from a failed state
 
-            >>> @flow
-            >>> def my_flow():
-            >>>     raise ValueError("oh no!")
-            >>> state = my_flow(return_state=True)  # Error is wrapped in FAILED state
-            >>> state.result()  # Raises `ValueError`
+            ```python
+            @flow
+            def my_flow():
+                raise ValueError("oh no!")
+            state = my_flow(return_state=True)  # Error is wrapped in FAILED state
+            state.result()  # Raises `ValueError`
+            ```
 
             Get the result from a failed state without erroring
 
-            >>> @flow
-            >>> def my_flow():
-            >>>     raise ValueError("oh no!")
-            >>> state = my_flow(return_state=True)
-            >>> result = state.result(raise_on_failure=False)
-            >>> print(result)
-            ValueError("oh no!")
+            ```python
+            @flow
+            def my_flow():
+                raise ValueError("oh no!")
+            state = my_flow(return_state=True)
+            result = state.result(raise_on_failure=False)
+            print(result)
+            # ValueError("oh no!")
+            ```
 
 
             Get the result from a flow state in an async context
 
-            >>> @flow
-            >>> async def my_flow():
-            >>>     return "hello"
-            >>> state = await my_flow(return_state=True)
-            >>> await state.result()
-            hello
+            ```python
+            @flow
+            async def my_flow():
+                return "hello"
+            state = await my_flow(return_state=True)
+            await state.result()
+            # hello
+            ```
 
             Get the result with `raise_on_failure` from a flow run in a different memory space
 
-            >>> @flow
-            >>> async def my_flow():
-            >>>     raise ValueError("oh no!")
-            >>> my_flow.deploy("my_deployment/my_flow")
-            >>> flow_run = run_deployment("my_deployment/my_flow")
-            >>> await flow_run.state.result(raise_on_failure=True) # Raises `ValueError("oh no!")`
+            ```python
+            @flow
+            async def my_flow():
+                raise ValueError("oh no!")
+            my_flow.deploy("my_deployment/my_flow")
+            flow_run = run_deployment("my_deployment/my_flow")
+            await flow_run.state.result(raise_on_failure=True) # Raises `ValueError("oh no!")`
+            ```
         """
         from prefect.states import get_state_result
 

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev2}/src/prefect/context.py

@@ -788,45 +788,55 @@ def tags(*new_tags: str) -> Generator[set[str], None, None]:
         The current set of tags
 
     Examples:
-        >>> from prefect import tags, task, flow
-        >>> @task
-        >>> def my_task():
-        >>>     pass
+        ```python
+        from prefect import tags, task, flow
+        @task
+        def my_task():
+            pass
+        ```
 
         Run a task with tags
 
-        >>> @flow
-        >>> def my_flow():
-        >>>     with tags("a", "b"):
-        >>>         my_task()  # has tags: a, b
+        ```python
+        @flow
+        def my_flow():
+            with tags("a", "b"):
+                my_task()  # has tags: a, b
+        ```
 
         Run a flow with tags
 
-        >>> @flow
-        >>> def my_flow():
-        >>>     pass
-        >>> with tags("a", "b"):
-        >>>     my_flow()  # has tags: a, b
+        ```python
+        @flow
+        def my_flow():
+            pass
+        with tags("a", "b"):
+            my_flow()  # has tags: a, b
+        ```
 
         Run a task with nested tag contexts
 
-        >>> @flow
-        >>> def my_flow():
-        >>>     with tags("a", "b"):
-        >>>         with tags("c", "d"):
-        >>>             my_task()  # has tags: a, b, c, d
-        >>>         my_task()  # has tags: a, b
+        ```python
+        @flow
+        def my_flow():
+            with tags("a", "b"):
+                with tags("c", "d"):
+                    my_task()  # has tags: a, b, c, d
+                my_task()  # has tags: a, b
+        ```
 
         Inspect the current tags
 
-        >>> @flow
-        >>> def my_flow():
-        >>>     with tags("c", "d"):
-        >>>         with tags("e", "f") as current_tags:
-        >>>              print(current_tags)
-        >>> with tags("a", "b"):
-        >>>     my_flow()
-        {"a", "b", "c", "d", "e", "f"}
+        ```python
+        @flow
+        def my_flow():
+            with tags("c", "d"):
+                with tags("e", "f") as current_tags:
+                     print(current_tags)
+        with tags("a", "b"):
+            my_flow()
+        # {"a", "b", "c", "d", "e", "f"}
+        ```
     """
     current_tags = TagsContext.get().current_tags
     _new_tags = current_tags.union(new_tags)

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev2}/src/prefect/deployments/steps/core.py

@@ -53,8 +53,8 @@ def _strip_version(requirement: str) -> str:
 
     Examples:
         ```python
-        >>> _strip_version("s3fs>=2.0.0<3.0.0")
-        "s3fs"
+        _strip_version("s3fs>=2.0.0<3.0.0")
+        # "s3fs"
         ```
     """
     # split on any of the characters in the set [<>=!~]

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev2}/src/prefect/events/cli/automations.py

@@ -107,6 +107,12 @@ async def inspect(
     id: Optional[str] = typer.Option(None, "--id", help="An automation's id"),
     yaml: bool = typer.Option(False, "--yaml", help="Output as YAML"),
     json: bool = typer.Option(False, "--json", help="Output as JSON"),
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json, yaml",
+    ),
 ):
     """
     Inspect an automation.
@@ -129,8 +135,12 @@ async def inspect(
 
         $ prefect automation inspect "my-automation" --yaml
 
-        $ prefect automation inspect "my-automation" --json
+        $ prefect automation inspect "my-automation" --output json
+        $ prefect automation inspect "my-automation" --output yaml
     """
+    if output and output.lower() not in ["json", "yaml"]:
+        exit_with_error("Only 'json' and 'yaml' output formats are supported.")
+
     if not id and not name:
         exit_with_error("Please provide either a name or an id.")
 
@@ -148,7 +158,7 @@ async def inspect(
             except (PrefectHTTPStatusError, ValueError):
                 exit_with_error(f"Automation with id {id!r} not found.")
 
-    if yaml or json:
+    if yaml or json or (output and output.lower() in ["json", "yaml"]):
 
         def no_really_json(obj: Type[BaseModel]):
             # Working around a weird bug where pydantic isn't rendering enums as strings
@@ -165,9 +175,9 @@ async def inspect(
         elif isinstance(automation, Automation):
             automation = no_really_json(automation)
 
-        if yaml:
+        if yaml or (output and output.lower() == "yaml"):
             app.console.print(pyyaml.dump(automation, sort_keys=False))
-        elif json:
+        elif json or (output and output.lower() == "json"):
             app.console.print(
                 orjson.dumps(automation, option=orjson.OPT_INDENT_2).decode()
             )

{prefect_client-3.4.7.dev9 → prefect_client-3.4.8.dev2}/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.dev2/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.dev2}/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.dev2}/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",