flyte 0.2.0b8__py3-none-any.whl → 0.2.0b9__py3-none-any.whl

flyte/cli/__init__.py

@@ -1,10 +1,3 @@
-"""
-# CLI for Flyte
-
-The flyte cli follows a simple verb based structure, where the top-level commands are verbs that describe the action
-to be taken, and the subcommands are nouns that describe the object of the action.
-"""
-
 from flyte.cli.main import main
 
 __all__ = ["main"]

flyte/cli/_abort.py

@@ -6,7 +6,7 @@ from flyte.cli import _common as common
 @click.group(name="abort")
 def abort():
     """
-    Abort a run.
+    Abort an ongoing process.
     """
 
 

flyte/cli/_common.py

@@ -58,7 +58,7 @@ DRY_RUN_OPTION = click.Option(
 
 def _common_options() -> List[click.Option]:
     """
-    Common options for that will be added to all commands and groups that inherit from CommandBase or GroupBase.
+    Common options that will be added to all commands and groups that inherit from CommandBase or GroupBase.
     """
     return [PROJECT_OPTION, DOMAIN_OPTION]
 
@@ -110,8 +110,8 @@ class CLIConfig:
 
 class InvokeBaseMixin:
     """
-    Mixin to catch grpc.RpcError, flyte.RpcError, other errors and other exceptions and raise them as
-     gclick.ClickException.
+    Mixin to catch grpc.RpcError, flyte.RpcError, other errors and other exceptions
+    and raise them as gclick.ClickException.
     """
 
     def invoke(self, ctx):

flyte/cli/_create.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import get_args
+from typing import Any, Dict, get_args
 
 import rich_click as click
 
@@ -10,7 +10,7 @@ from flyte.remote._secret import SecretTypes
 @click.group(name="create")
 def create():
     """
-    The create subcommand allows you to create resources in a Flyte deployment.
+    Create resources in a Flyte deployment.
     """
 
 
@@ -32,22 +32,26 @@ def secret(
     domain: str | None = None,
 ):
     """
-    Create a new secret, the name of the secret is required.
+    Create a new secret. The name of the secret is required. For example:
 
-    Examples:
     ```bash
-    flyte create secret my_secret --value my_value
+    $ flyte create secret my_secret --value my_value
     ```
-    If `--from-file` is specified, the value will be read from the file instead of being provided directly.
-    Example:
+
+    If `--from-file` is specified, the value will be read from the file instead of being provided directly:
+
     ```bash
-    flyte create secret my_secret --from-file /path/to/secret_file
+    $ flyte create secret my_secret --from-file /path/to/secret_file
     ```
-    Secret types can be used to create specific types of secrets. Some secrets are useful for image pull, while some
-    are `regular` / general purpose secrets.
-    Example:
+
+    The `--type` option can be used to create specific types of secrets.
+    Either `regular` or `image_pull` can be specified.
+    Secrets intended to access container images should be specified as `image_pull`.
+    Other secrets should be specified as `regular`.
+    If no type is specified, `regular` is assumed.
+
     ```bash
-    flyte create secret my_secret --type image_pull
+    $ flyte create secret my_secret --type image_pull
     ```
     """
     from flyte.remote import Secret
@@ -61,28 +65,28 @@ def secret(
 
 @create.command(cls=common.CommandBase)
 @click.option("--endpoint", type=str, help="Endpoint of the Flyte backend.")
-@click.option("--insecure", is_flag=True, help="Use insecure connection to the Flyte backend.")
+@click.option("--insecure", is_flag=True, help="Use an insecure connection to the Flyte backend.")
 @click.option(
     "--org",
     type=str,
     required=False,
-    help="Organization to use, this will override the organization in the config file.",
+    help="Organization to use, this will override the organization in the configusraion file.",
 )
 @click.option(
     "-o",
     "--output",
     type=click.Path(exists=False, writable=True),
     default=Path.cwd() / "config.yaml",
-    help="Path to the output dir where the config will be saved, defaults to current directory.",
+    help="Path to the output directory where the configuration will be saved. Defaults to current directory.",
     show_default=True,
 )
 @click.option(
     "--force",
     is_flag=True,
     default=False,
-    help="Force overwrite the config file if it already exists.",
+    help="Force overwrite of the configuration file if it already exists.",
     show_default=True,
-    prompt="Are you sure you want to overwrite the config file?",
+    prompt="Are you sure you want to overwrite the configuration file?",
     confirmation_prompt=True,
 )
 def config(
@@ -95,7 +99,7 @@ def config(
     force: bool = False,
 ):
     """
-    This command creates a configuration file for Flyte CLI.
+    Creates a configuration file for Flyte CLI.
     If the `--output` option is not specified, it will create a file named `config.yaml` in the current directory.
     If the file already exists, it will raise an error unless the `--force` option is used.
     """
@@ -104,18 +108,29 @@ def config(
     if output.exists() and not force:
         raise click.BadParameter(f"Output file {output} already exists. Use --force to overwrite.")
 
+    admin: Dict[str, Any] = {}
+    if endpoint:
+        admin["endpoint"] = endpoint
+    if insecure:
+        admin["insecure"] = insecure
+
+    task: Dict[str, str] = {}
+    if org:
+        task["org"] = org
+    if project:
+        task["project"] = project
+    if domain:
+        task["domain"] = domain
+
+    if not admin and not task:
+        raise click.BadParameter("At least one of --endpoint or --org must be provided.")
+
     with open(output, "w") as f:
-        d = {
-            "admin": {
-                "endpoint": endpoint,
-                "insecure": insecure,
-            },
-            "task": {
-                "org": org,
-                "project": project,
-                "domain": domain,
-            },
-        }
+        d: Dict[str, Any] = {}
+        if admin:
+            d["admin"] = admin
+        if task:
+            d["task"] = task
         yaml.dump(d, f)
 
     click.echo(f"Config file created at {output}")

flyte/cli/_delete.py

@@ -6,7 +6,7 @@ import flyte.cli._common as common
 @click.group(name="delete")
 def delete():
     """
-    The delete subcommand allows you to remove resources from a Flyte deployment.
+    Remove resources from a Flyte deployment.
     """
 
 
@@ -15,7 +15,7 @@ def delete():
 @click.pass_obj
 def secret(cfg: common.CLIConfig, name: str, project: str | None = None, domain: str | None = None):
     """
-    Delete a secret, the name of the secret is required.
+    Delete a secret. The name of the secret is required.
     """
     from flyte.remote import Secret
 

flyte/cli/_deploy.py

@@ -61,7 +61,7 @@ class DeployArguments:
     @classmethod
     def options(cls) -> List[click.Option]:
         """
-        Return the set of base parameters added to every pyflyte run workflow subcommand.
+        Return the set of base parameters added to every flyte run workflow subcommand.
         """
         return [common.get_option_from_metadata(f.metadata) for f in fields(cls) if f.metadata]
 
@@ -87,7 +87,7 @@ class DeployEnvCommand(click.Command):
 
 class EnvPerFileGroup(common.ObjectsPerFileGroup):
     """
-    Group that creates a command for each task in the current directory that is not __init__.py.
+    Group that creates a command for each task in the current directory that is not `__init__.py`.
     """
 
     def __init__(self, filename: Path, deploy_args: DeployArguments, *args, **kwargs):
@@ -111,7 +111,7 @@ class EnvPerFileGroup(common.ObjectsPerFileGroup):
 
 class EnvFiles(common.FileGroup):
     """
-    Group that creates a command for each file in the current directory that is not __init__.py.
+    Group that creates a command for each file in the current directory that is not `__init__.py`.
     """
 
     common_options_enabled = False

flyte/cli/_gen.py

@@ -1,3 +1,4 @@
+import textwrap
 from os import getcwd
 from typing import Generator, Tuple
 
@@ -9,7 +10,7 @@ import flyte.cli._common as common
 @click.group(name="gen")
 def gen():
     """
-    Generate documentation
+    Generate documentation.
     """
 
 
@@ -18,7 +19,7 @@ def gen():
 @click.pass_obj
 def docs(cfg: common.CLIConfig, doc_type: str, project: str | None = None, domain: str | None = None):
     """
-    Generate documentation
+    Generate documentation.
     """
     if doc_type == "markdown":
         markdown(cfg)
@@ -82,7 +83,7 @@ def markdown(cfg: common.CLIConfig):
         output.append(f"{'#' * (len(cmd_path_parts) + 1)} {cmd_path}")
         if cmd.help:
             output.append("")
-            output.append(f"{cmd.help.strip()}")
+            output.append(f"{dedent(cmd.help)}")
 
         if not cmd.params:
             continue
@@ -109,7 +110,7 @@ def markdown(cfg: common.CLIConfig):
                 if param.default is not None:
                     default_value = f"`{param.default}`"
                     default_value = default_value.replace(f"{getcwd()}/", "")
-                help_text = param.help.strip() if param.help else ""
+                help_text = dedent(param.help) if param.help else ""
                 table_data.append([opts, f"`{param.type.name}`", default_value, help_text])
 
         if not table_data:
@@ -153,3 +154,10 @@ def markdown(cfg: common.CLIConfig):
     print("{{< /grid >}}")
     print()
     print("\n".join(output))
+
+
+def dedent(text: str) -> str:
+    """
+    Remove leading whitespace from a string.
+    """
+    return textwrap.dedent(text).strip("\n")

flyte/cli/_get.py

@@ -11,16 +11,23 @@ from . import _common as common
 @click.group(name="get")
 def get():
     """
-    The `get` subcommand allows you to retrieve various resources from a Flyte deployment.
+    Retrieve resources from a Flyte deployment.
+
+    You can get information about projects, runs, tasks, actions, secrets, logs and input/output values.
 
-    You can get information about projects, runs, tasks, actions, secrets, and more.
     Each command supports optional parameters to filter or specify the resource you want to retrieve.
 
-    Every `get` subcommand for example ``get project` without any arguments will list all projects.
-    `get project my_project` will return the details of the project named `my_project`.
+    Using a `get` subcommand without any arguments will retrieve a list of available resources to get.
+    For example:
+
+    * `get project` (without specifiying aproject), will list all projects.
+    * `get project my_project` will return the details of the project named `my_project`.
+
+    In some cases, a partially specified command will act as a filter and return available further parameters.
+    For example:
 
-    In some cases `get action my_run` will return all actions for the run named `my_run` and
-    `get action my_run my_action` will return the details of the action named `my_action` for the run `my_run`.
+    * `get action my_run` will return all actions for the run named `my_run`.
+    * `get action my_run my_action` will return the details of the action named `my_action` for the run `my_run`.
     """
 
 
@@ -29,7 +36,7 @@ def get():
 @click.pass_obj
 def project(cfg: common.CLIConfig, name: str | None = None):
     """
-    Retrieve a list of all projects or details of a specific project by name.
+    Get a list of all projects, or details of a specific project by name.
     """
     from flyte.remote import Project
 
@@ -48,7 +55,7 @@ def project(cfg: common.CLIConfig, name: str | None = None):
 @click.pass_obj
 def run(cfg: common.CLIConfig, name: str | None = None, project: str | None = None, domain: str | None = None):
     """
-    Get list of all runs or details of a specific run by name.
+    Get a list of all runs, or details of a specific run by name.
 
     The run details will include information about the run, its status, but only the root action will be shown.
 
@@ -78,9 +85,9 @@ def task(
     domain: str | None = None,
 ):
     """
-    Retrieve a list of all tasks or details of a specific task by name and version.
+    Retrieve a list of all tasks, or details of a specific task by name and version.
 
-    Currently name+version are required to get a specific task.
+    Currently, both `name` and `version` are required to get a specific task.
     """
     from flyte.remote import Task
 
@@ -156,23 +163,24 @@ def logs(
 ):
     """
     Stream logs for the provided run or action.
-    If only the run is provided, only the logs for the parent action will be streamed.
+    If only the run is provided, only the logs for the parent action will be streamed:
 
-    Example:
     ```bash
-    flyte get logs my_run
+    $ flyte get logs my_run
     ```
 
-    But, if you want to see the logs for a specific action, you can provide the action name as well:
+    If you want to see the logs for a specific action, you can provide the action name as well:
+
     ```bash
-    flyte get logs my_run my_action
+    $ flyte get logs my_run my_action
     ```
-    By default logs will be shown in the raw format, will scroll on the terminal. If automatic scrolling and only
-    tailing --lines lines is desired, use the `--pretty` flag:
+
+    By default, logs will be shown in the raw format and will scroll the terminal.
+    If automatic scrolling and only tailing `--lines` number of lines is desired, use the `--pretty` flag:
+
     ```bash
-    flyte get logs my_run my_action --pretty --lines 50
+    $ flyte get logs my_run my_action --pretty --lines 50
     ```
-
     """
     import flyte.remote as remote
 
@@ -206,7 +214,7 @@ def secret(
     domain: str | None = None,
 ):
     """
-    Retrieve a list of all secrets or details of a specific secret by name.
+    Get a list of all secrets, or details of a specific secret by name.
     """
     import flyte.remote as remote
 
@@ -236,18 +244,18 @@ def io(
 ):
     """
     Get the inputs and outputs of a run or action.
-    if only the run name is provided, it will show the inputs and outputs of the root action of that run.
+    If only the run name is provided, it will show the inputs and outputs of the root action of that run.
     If an action name is provided, it will show the inputs and outputs for that action.
-
     If `--inputs-only` or `--outputs-only` is specified, it will only show the inputs or outputs respectively.
 
-    Example:
+    Examples:
+
     ```bash
-    flyte get io my_run
+    $ flyte get io my_run
     ```
-    or
+
     ```bash
-    flyte get io my_run my_action
+    $ flyte get io my_run my_action
     ```
     """
     if inputs_only and outputs_only:
@@ -293,7 +301,7 @@ def io(
 @click.pass_obj
 def config(cfg: common.CLIConfig):
     """
-    Shows the automatically detected configuration to connect with remote Flyte services.
+    Shows the automatically detected configuration to connect with the remote backend.
 
     The configuration will include the endpoint, organization, and other settings that are used by the CLI.
     """

flyte/cli/main.py

@@ -13,7 +13,7 @@ from ._run import run
 click.rich_click.COMMAND_GROUPS = {
     "flyte": [
         {
-            "name": "Running Workflows",
+            "name": "Running workflows",
             "commands": ["run", "abort"],
         },
         {
@@ -21,7 +21,7 @@ click.rich_click.COMMAND_GROUPS = {
             "commands": ["create", "deploy", "get"],
         },
         {
-            "name": "Documentation Generation",
+            "name": "Documentation generation",
             "commands": ["gen"],
         },
     ]
@@ -58,13 +58,13 @@ def _verbosity_to_loglevel(verbosity: int) -> int | None:
     "--endpoint",
     type=str,
     required=False,
-    help="The endpoint to connect to, this will override any config and simply used pkce to connect.",
+    help="The endpoint to connect to. This will override any configuration file and simply use `pkce` to connect.",
 )
 @click.option(
-    "--insecure/--secure",
+    "--insecure",
     is_flag=True,
     required=False,
-    help="Use insecure connection to the endpoint. If secure is specified, the CLI will use TLS.",
+    help="Use an insecure connection to the endpoint. If not specified, the CLI will use TLS.",
     type=bool,
     default=None,
     show_default=True,
@@ -73,7 +73,7 @@ def _verbosity_to_loglevel(verbosity: int) -> int | None:
     "-v",
     "--verbose",
     required=False,
-    help="Show verbose messages and exception traces, multiple times increases verbosity (e.g., -vvv).",
+    help="Show verbose messages and exception traces. Repeating multiple times increases the verbosity (e.g., -vvv).",
     count=True,
     default=0,
     type=int,
@@ -82,7 +82,7 @@ def _verbosity_to_loglevel(verbosity: int) -> int | None:
     "--org",
     type=str,
     required=False,
-    help="Organization to use",
+    help="The organization to which the command applies.",
 )
 @click.option(
     "-c",
@@ -90,8 +90,7 @@ def _verbosity_to_loglevel(verbosity: int) -> int | None:
     "config_file",
     required=False,
     type=click.Path(exists=True),
-    help="Path to config file (YAML format) to use for the CLI. If not specified,"
-    " the default config file will be used.",
+    help="Path to the configuration file to use. If not specified, the default configuration file is used."
 )
 @click.rich_config(help_config=help_config)
 @click.pass_context
@@ -104,34 +103,38 @@ def main(
     config_file: str | None,
 ):
     """
-    ### Flyte entrypoint for the CLI
-    The Flyte CLI is a command line interface for interacting with Flyte.
+    The Flyte CLI is the the command line interface for working with the Flyte SDK and backend.
 
-    The flyte cli follows a simple verb based structure, where the top-level commands are verbs that describe the action
-    to be taken, and the subcommands are nouns that describe the object of the action.
+    It follows a simple verb/noun structure,
+    where the top-level commands are verbs that describe the action to be taken,
+    and the subcommands are nouns that describe the object of the action.
 
-    The root command can be used to configure the CLI for most commands, such as setting the endpoint,
-     organization, and verbosity level.
+    The root command can be used to configure the CLI for persistent settings,
+    such as the endpoint, organization, and verbosity level.
 
-     Example: Set endpoint and organization
-     ```bash
-      flyte --endpoint <endpoint> --org <org> get project <project_name>
-     ```
+    Set endpoint and organization:
 
-     Example: Increase verbosity level (This is useful for debugging, this will show more logs and exception traces)
-      ```bash
-      flyte -vvv get logs <run-name>
-      ```
+    ```bash
+    $ flyte --endpoint <endpoint> --org <org> get project <project_name>
+    ```
+
+    Increase verbosity level (This is useful for debugging,
+    this will show more logs and exception traces):
+
+    ```bash
+    $ flyte -vvv get logs <run-name>
+    ```
+
+    Override the default config file:
 
-      Example: Override the default config file
     ```bash
-    flyte --config /path/to/config.yaml run ...
+    $ flyte --config /path/to/config.yaml run ...
     ```
 
-    👉 [Documentation](https://www.union.ai/docs/flyte/user-guide/) \n
-    👉 [GitHub](https://github.com/flyteorg/flyte) - Please leave a ⭐. \n
-    👉 [Slack](https://slack.flyte.org) - Join the community and ask questions.
-    👉 [Issues](https://github.com/flyteorg/flyte/issues)
+    * [Documentation](https://www.union.ai/docs/flyte/user-guide/)
+    * [GitHub](https://github.com/flyteorg/flyte): Please leave a star if you like Flyte!
+    * [Slack](https://slack.flyte.org): Join the community and ask questions.
+    * [Issues](https://github.com/flyteorg/flyte/issues)
 
     """
     import flyte.config as config

flyte/models.py

@@ -5,7 +5,9 @@ import os
 import pathlib
 import tempfile
 from dataclasses import dataclass, field, replace
-from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Tuple, Type
+from typing import TYPE_CHECKING, Any, Callable, Dict, Literal, Optional, Tuple, Type
+
+import rich.repr
 
 from flyte._docstring import Docstring
 from flyte._interface import extract_return_annotation
@@ -27,6 +29,7 @@ def generate_random_name() -> str:
     return str(uuid4())  # Placeholder for actual random name generation logic
 
 
+@rich.repr.auto
 @dataclass(frozen=True, kw_only=True)
 class ActionID:
     """
@@ -68,6 +71,7 @@ class ActionID:
         return self.new_sub_action(new_name)
 
 
+@rich.repr.auto
 @dataclass(frozen=True, kw_only=True)
 class RawDataPath:
     """
@@ -133,11 +137,13 @@ class RawDataPath:
         return remote_path
 
 
+@rich.repr.auto
 @dataclass(frozen=True)
 class GroupData:
     name: str
 
 
+@rich.repr.auto
 @dataclass(frozen=True, kw_only=True)
 class TaskContext:
     """
@@ -160,6 +166,7 @@ class TaskContext:
     code_bundle: CodeBundle | None = None
     compiled_image_cache: ImageCache | None = None
     data: Dict[str, Any] = field(default_factory=dict)
+    mode: Literal["local", "remote", "hybrid"] = "remote"
 
     def replace(self, **kwargs) -> TaskContext:
         if "data" in kwargs:
@@ -177,6 +184,7 @@ class TaskContext:
         return self.data.get(key)
 
 
+@rich.repr.auto
 @dataclass(frozen=True, kw_only=True)
 class CodeBundle:
     """
@@ -211,6 +219,7 @@ class CodeBundle:
         return replace(self, downloaded_path=path)
 
 
+@rich.repr.auto
 @dataclass(frozen=True)
 class Checkpoints:
     """