prefect 3.4.8.dev1__tar.gz → 3.4.8.dev3__tar.gz

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/PKG-INFO

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

prefect-3.4.8.dev3/src/prefect/_build_info.py

@@ -0,0 +1,5 @@
+# Generated by versioningit
+__version__ = "3.4.8.dev3"
+__build_date__ = "2025-07-02 08:09:51.026768+00:00"
+__git_commit__ = "8f38dd54f10623fac36f1e92fee6f3747c5053f3"
+__dirty__ = False

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/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-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/artifact.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from typing import Optional
 from uuid import UUID
 
+import orjson
 import typer
 from rich.pretty import Pretty
 from rich.table import Table
@@ -96,6 +97,12 @@ async def inspect(
         "--limit",
         help="The maximum number of artifacts to return.",
     ),
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json",
+    ),
 ):
     """
         View details about an artifact.
@@ -132,6 +139,8 @@ async def inspect(
             }
     ]
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
 
     async with get_client() as client:
         artifacts = await client.read_artifacts(
@@ -142,9 +151,15 @@ async def inspect(
         if not artifacts:
             exit_with_error(f"Artifact {key!r} not found.")
 
-        artifacts = [a.model_dump(mode="json") for a in artifacts]
+        artifacts_json = [a.model_dump(mode="json") for a in artifacts]
 
-        app.console.print(Pretty(artifacts))
+        if output and output.lower() == "json":
+            json_output = orjson.dumps(
+                artifacts_json, option=orjson.OPT_INDENT_2
+            ).decode()
+            app.console.print(json_output)
+        else:
+            app.console.print(Pretty(artifacts_json))
 
 
 @artifact_app.command("delete")

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/concurrency_limit.py

@@ -3,7 +3,9 @@ Command line interface for working with concurrency limits.
 """
 
 import textwrap
+from typing import Optional
 
+import orjson
 import typer
 from rich.console import Group
 from rich.panel import Panel
@@ -57,11 +59,21 @@ async def create(tag: str, concurrency_limit: int):
 
 
 @concurrency_limit_app.command()
-async def inspect(tag: str):
+async def inspect(
+    tag: str,
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json",
+    ),
+):
     """
     View details about a concurrency limit. `active_slots` shows a list of TaskRun IDs
     which are currently using a concurrency slot.
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
 
     async with get_client() as client:
         try:
@@ -69,30 +81,35 @@ async def inspect(tag: str):
         except ObjectNotFound:
             exit_with_error(f"No concurrency limit found for the tag: {tag}")
 
-    trid_table = Table()
-    trid_table.add_column("Active Task Run IDs", style="cyan", no_wrap=True)
-
-    cl_table = Table(title=f"Concurrency Limit ID: [red]{str(result.id)}")
-    cl_table.add_column("Tag", style="green", no_wrap=True)
-    cl_table.add_column("Concurrency Limit", style="blue", no_wrap=True)
-    cl_table.add_column("Created", style="magenta", no_wrap=True)
-    cl_table.add_column("Updated", style="magenta", no_wrap=True)
-
-    for trid in sorted(result.active_slots):
-        trid_table.add_row(str(trid))
-
-    cl_table.add_row(
-        str(result.tag),
-        str(result.concurrency_limit),
-        Pretty(human_friendly_diff(result.created) if result.created else ""),
-        Pretty(human_friendly_diff(result.updated) if result.updated else ""),
-    )
+    if output and output.lower() == "json":
+        result_json = result.model_dump(mode="json")
+        json_output = orjson.dumps(result_json, option=orjson.OPT_INDENT_2).decode()
+        app.console.print(json_output)
+    else:
+        trid_table = Table()
+        trid_table.add_column("Active Task Run IDs", style="cyan", no_wrap=True)
+
+        cl_table = Table(title=f"Concurrency Limit ID: [red]{str(result.id)}")
+        cl_table.add_column("Tag", style="green", no_wrap=True)
+        cl_table.add_column("Concurrency Limit", style="blue", no_wrap=True)
+        cl_table.add_column("Created", style="magenta", no_wrap=True)
+        cl_table.add_column("Updated", style="magenta", no_wrap=True)
+
+        for trid in sorted(result.active_slots):
+            trid_table.add_row(str(trid))
+
+        cl_table.add_row(
+            str(result.tag),
+            str(result.concurrency_limit),
+            Pretty(human_friendly_diff(result.created) if result.created else ""),
+            Pretty(human_friendly_diff(result.updated) if result.updated else ""),
+        )
 
-    group = Group(
-        cl_table,
-        trid_table,
-    )
-    app.console.print(Panel(group, expand=False))
+        group = Group(
+            cl_table,
+            trid_table,
+        )
+        app.console.print(Panel(group, expand=False))
 
 
 @concurrency_limit_app.command()

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/deploy.py

@@ -1354,14 +1354,16 @@ def _parse_name_from_pattern(
 
     Example:
 
-    >>> deploy_configs = [
-    ...     {"name": "my-deployment-1", "entrypoint": "flow-name-1"},
-    ...     {"name": "my-deployment-2", "entrypoint": "flow-name-2"},
-    ...     {"name": "my-deployment-3", "entrypoint": "flow-name-3"},
-    ... ]
-
-    >>> _parse_name_from_pattern(deploy_configs, "flow-name-1/*")
-    ["my-deployment-1"]
+    ```python
+    deploy_configs = [
+        {"name": "my-deployment-1", "entrypoint": "flow-name-1"},
+        {"name": "my-deployment-2", "entrypoint": "flow-name-2"},
+        {"name": "my-deployment-3", "entrypoint": "flow-name-3"},
+    ]
+
+    _parse_name_from_pattern(deploy_configs, "flow-name-1/*")
+    # ["my-deployment-1"]
+    ```
 
     Args:
         deploy_configs: A list of deploy configs

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/deployment.py

@@ -13,6 +13,7 @@ from datetime import datetime, timedelta, timezone
 from typing import TYPE_CHECKING, Any, Optional, TypedDict
 from uuid import UUID
 
+import orjson
 import typer
 import yaml
 from rich.console import Console
@@ -215,7 +216,15 @@ class RichTextIO:
 
 
 @deployment_app.command()
-async def inspect(name: str):
+async def inspect(
+    name: str,
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json",
+    ),
+):
     """
     View details about a deployment.
 
@@ -223,6 +232,7 @@ async def inspect(name: str):
     Example:
         \b
         $ prefect deployment inspect "hello-world/my-deployment"
+        $ prefect deployment inspect "hello-world/my-deployment" --output json
         {
             'id': '610df9c3-0fb4-4856-b330-67f588d20201',
             'created': '2022-08-01T18:36:25.192102+00:00',
@@ -257,6 +267,9 @@ async def inspect(name: str):
         }
 
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
+
     assert_deployment_name_format(name)
 
     async with get_client() as client:
@@ -283,7 +296,11 @@ async def inspect(name: str):
             )
         ]
 
-    app.console.print(Pretty(deployment_json))
+    if output and output.lower() == "json":
+        json_output = orjson.dumps(deployment_json, option=orjson.OPT_INDENT_2).decode()
+        app.console.print(json_output)
+    else:
+        app.console.print(Pretty(deployment_json))
 
 
 @schedule_app.command("create")

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/flow_run.py

@@ -14,6 +14,7 @@ from typing import List, Optional
 from uuid import UUID
 
 import httpx
+import orjson
 import typer
 from rich.markup import escape
 from rich.pretty import Pretty
@@ -55,10 +56,19 @@ async def inspect(
         "--web",
         help="Open the flow run in a web browser.",
     ),
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json",
+    ),
 ):
     """
     View details about a flow run.
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
+
     async with get_client() as client:
         try:
             flow_run = await client.read_flow_run(id)
@@ -78,7 +88,14 @@ async def inspect(
         await run_sync_in_worker_thread(webbrowser.open_new_tab, flow_run_url)
         exit_with_success(f"Opened flow run {id!r} in browser.")
     else:
-        app.console.print(Pretty(flow_run))
+        if output and output.lower() == "json":
+            flow_run_json = flow_run.model_dump(mode="json")
+            json_output = orjson.dumps(
+                flow_run_json, option=orjson.OPT_INDENT_2
+            ).decode()
+            app.console.print(json_output)
+        else:
+            app.console.print(Pretty(flow_run))
 
 
 @flow_run_app.command()

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/global_concurrency_limit.py

@@ -1,4 +1,3 @@
-from enum import Enum
 from pathlib import Path
 from typing import Optional
 
@@ -30,10 +29,6 @@ global_concurrency_limit_app: PrefectTyper = PrefectTyper(
 app.add_typer(global_concurrency_limit_app, aliases=["gcl"])
 
 
-class OutputFormat(Enum):
-    JSON = "json"
-
-
 @global_concurrency_limit_app.command("ls")
 async def list_global_concurrency_limits():
     """
@@ -81,12 +76,11 @@ async def inspect_global_concurrency_limit(
     name: str = typer.Argument(
         ..., help="The name of the global concurrency limit to inspect."
     ),
-    output: Optional[OutputFormat] = typer.Option(
+    output: Optional[str] = typer.Option(
         None,
         "--output",
         "-o",
-        help="Output format for the command.",
-        case_sensitive=False,
+        help="Specify an output format. Currently supports: json",
     ),
     file_path: Optional[Path] = typer.Option(
         None,
@@ -114,6 +108,9 @@ async def inspect_global_concurrency_limit(
         slot_decay_per_second (float): The slot decay per second.
 
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
+
     if file_path and not output:
         exit_with_error("The --file/-f option requires the --output option to be set.")
 
@@ -123,19 +120,17 @@ async def inspect_global_concurrency_limit(
         except ObjectNotFound:
             exit_with_error(f"Global concurrency limit {name!r} not found.")
 
-    if output:
-        gcl_limit = gcl_limit.model_dump(mode="json")
-        json_output = orjson.dumps(gcl_limit, option=orjson.OPT_INDENT_2).decode()
+    if output and output.lower() == "json":
+        gcl_limit_json = gcl_limit.model_dump(mode="json")
+        json_output = orjson.dumps(gcl_limit_json, option=orjson.OPT_INDENT_2).decode()
         if not file_path:
             app.console.print(json_output)
-
         else:
             with open(file_path, "w") as f:
                 f.write(json_output)
                 exit_with_success(
                     f"Global concurrency limit {name!r} written to {file_path}"
                 )
-
     else:
         app.console.print(Pretty(gcl_limit))
 

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/profile.py

@@ -8,6 +8,7 @@ import textwrap
 from typing import Optional
 
 import httpx
+import orjson
 import typer
 from rich.progress import Progress, SpinnerColumn, TextColumn
 from rich.table import Table
@@ -240,10 +241,19 @@ def inspect(
     name: Optional[str] = typer.Argument(
         None, help="Name of profile to inspect; defaults to active profile."
     ),
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json",
+    ),
 ):
     """
     Display settings from a given profile; defaults to active.
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
+
     profiles = prefect.settings.load_profiles()
     if name is None:
         current_profile = prefect.context.get_settings_context().profile
@@ -256,10 +266,21 @@ def inspect(
 
     if not profiles[name].settings:
         # TODO: Consider instructing on how to add settings.
-        print(f"Profile {name!r} is empty.")
+        if output and output.lower() == "json":
+            app.console.print("{}")
+        else:
+            print(f"Profile {name!r} is empty.")
+        return
 
-    for setting, value in profiles[name].settings.items():
-        app.console.print(f"{setting.name}='{value}'")
+    if output and output.lower() == "json":
+        profile_data = {
+            setting.name: value for setting, value in profiles[name].settings.items()
+        }
+        json_output = orjson.dumps(profile_data, option=orjson.OPT_INDENT_2).decode()
+        app.console.print(json_output)
+    else:
+        for setting, value in profiles[name].settings.items():
+            app.console.print(f"{setting.name}='{value}'")
 
 
 def show_profile_changes(

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/task_run.py

@@ -5,9 +5,10 @@ Command line interface for working with task runs
 import logging
 import webbrowser
 from datetime import datetime
-from typing import List, cast
+from typing import List, Optional, cast
 from uuid import UUID
 
+import orjson
 import typer
 from rich.pretty import Pretty
 from rich.table import Table
@@ -52,10 +53,19 @@ async def inspect(
         "--web",
         help="Open the task run in a web browser.",
     ),
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json",
+    ),
 ):
     """
     View details about a task run.
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
+
     async with get_client() as client:
         try:
             task_run = await client.read_task_run(id)
@@ -72,7 +82,14 @@ async def inspect(
         await run_sync_in_worker_thread(webbrowser.open_new_tab, task_run_url)
         exit_with_success(f"Opened task run {id!r} in browser.")
     else:
-        app.console.print(Pretty(task_run))
+        if output and output.lower() == "json":
+            task_run_json = task_run.model_dump(mode="json")
+            json_output = orjson.dumps(
+                task_run_json, option=orjson.OPT_INDENT_2
+            ).decode()
+            app.console.print(json_output)
+        else:
+            app.console.print(Pretty(task_run))
 
 
 @task_run_app.command()

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/variable.py

@@ -1,6 +1,7 @@
 import json
 from typing import Any, Dict, List, Optional, Union
 
+import orjson
 import typer
 from rich.pretty import Pretty
 from rich.table import Table
@@ -62,6 +63,12 @@ async def list_variables(
 @variable_app.command("inspect")
 async def inspect(
     name: str,
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json",
+    ),
 ):
     """
     View details about a variable.
@@ -69,6 +76,8 @@ async def inspect(
     Arguments:
         name: the name of the variable to inspect
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
 
     async with get_client() as client:
         variable = await client.read_variable_by_name(
@@ -77,7 +86,14 @@ async def inspect(
         if not variable:
             exit_with_error(f"Variable {name!r} not found.")
 
-        app.console.print(Pretty(variable))
+        if output and output.lower() == "json":
+            variable_json = variable.model_dump(mode="json")
+            json_output = orjson.dumps(
+                variable_json, option=orjson.OPT_INDENT_2
+            ).decode()
+            app.console.print(json_output)
+        else:
+            app.console.print(Pretty(variable))
 
 
 @variable_app.command("get")

{prefect-3.4.8.dev1 → prefect-3.4.8.dev3}/src/prefect/cli/work_pool.py

@@ -7,8 +7,9 @@ from __future__ import annotations
 import datetime
 import json
 import textwrap
-from typing import Annotated, Any
+from typing import Annotated, Any, Optional
 
+import orjson
 import typer
 from rich.pretty import Pretty
 from rich.table import Table
@@ -318,6 +319,12 @@ async def ls(
 @work_pool_app.command()
 async def inspect(
     name: str = typer.Argument(..., help="The name of the work pool to inspect."),
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json",
+    ),
 ):
     """
     Inspect a work pool.
@@ -325,12 +332,23 @@ async def inspect(
     \b
     Examples:
         $ prefect work-pool inspect "my-pool"
+        $ prefect work-pool inspect "my-pool" --output json
 
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
+
     async with get_client() as client:
         try:
             pool = await client.read_work_pool(work_pool_name=name)
-            app.console.print(Pretty(pool))
+            if output and output.lower() == "json":
+                pool_json = pool.model_dump(mode="json")
+                json_output = orjson.dumps(
+                    pool_json, option=orjson.OPT_INDENT_2
+                ).decode()
+                app.console.print(json_output)
+            else:
+                app.console.print(Pretty(pool))
         except ObjectNotFound:
             exit_with_error(f"Work pool {name!r} not found!")
 
@@ -731,13 +749,23 @@ async def storage_inspect(
             ..., help="The name of the work pool to display storage configuration for."
         ),
     ],
+    output: Optional[str] = typer.Option(
+        None,
+        "--output",
+        "-o",
+        help="Specify an output format. Currently supports: json",
+    ),
 ):
     """
     EXPERIMENTAL: Inspect the storage configuration for a work pool.
 
     Examples:
         $ prefect work-pool storage inspect "my-pool"
+        $ prefect work-pool storage inspect "my-pool" --output json
     """
+    if output and output.lower() != "json":
+        exit_with_error("Only 'json' output format is supported.")
+
     async with get_client() as client:
         try:
             work_pool = await client.read_work_pool(work_pool_name=work_pool_name)
@@ -750,28 +778,51 @@ async def storage_inspect(
 
             storage_type = _determine_storage_type(work_pool.storage_configuration)
             if not storage_type:
-                app.console.print(
-                    f"No storage configuration found for work pool {work_pool_name!r}",
-                    style="yellow",
-                )
+                if output and output.lower() == "json":
+                    app.console.print("{}")
+                else:
+                    app.console.print(
+                        f"No storage configuration found for work pool {work_pool_name!r}",
+                        style="yellow",
+                    )
                 return
 
-            storage_table.add_row("type", storage_type)
-
-            # Add other storage settings, filtering out None values
-            if work_pool.storage_configuration.bundle_upload_step is not None:
-                fqn = list(work_pool.storage_configuration.bundle_upload_step.keys())[0]
-                config_values = work_pool.storage_configuration.bundle_upload_step[fqn]
-                for key, value in config_values.items():
-                    storage_table.add_row(key, str(value))
-
-            panel = Panel(
-                storage_table,
-                title=f"[bold]Storage Configuration for {work_pool_name}[/bold]",
-                expand=False,
-            )
+            if output and output.lower() == "json":
+                storage_data = {"type": storage_type}
+                if work_pool.storage_configuration.bundle_upload_step is not None:
+                    fqn = list(
+                        work_pool.storage_configuration.bundle_upload_step.keys()
+                    )[0]
+                    config_values = work_pool.storage_configuration.bundle_upload_step[
+                        fqn
+                    ]
+                    storage_data.update(config_values)
+
+                json_output = orjson.dumps(
+                    storage_data, option=orjson.OPT_INDENT_2
+                ).decode()
+                app.console.print(json_output)
+            else:
+                storage_table.add_row("type", storage_type)
+
+                # Add other storage settings, filtering out None values
+                if work_pool.storage_configuration.bundle_upload_step is not None:
+                    fqn = list(
+                        work_pool.storage_configuration.bundle_upload_step.keys()
+                    )[0]
+                    config_values = work_pool.storage_configuration.bundle_upload_step[
+                        fqn
+                    ]
+                    for key, value in config_values.items():
+                        storage_table.add_row(key, str(value))
+
+                panel = Panel(
+                    storage_table,
+                    title=f"[bold]Storage Configuration for {work_pool_name}[/bold]",
+                    expand=False,
+                )
 
-            app.console.print(panel)
+                app.console.print(panel)
 
         except ObjectNotFound:
             exit_with_error(f"Work pool {work_pool_name!r} does not exist.")