flyte 2.0.0b22__py3-none-any.whl → 2.0.0b23__py3-none-any.whl

flyte/cli/_create.py

@@ -3,6 +3,7 @@ from typing import Any, Dict, get_args
 
 import rich_click as click
 
+import flyte
 import flyte.cli._common as common
 from flyte.cli._option import MutuallyExclusiveOption
 from flyte.remote import SecretTypes
@@ -194,3 +195,76 @@ def config(
         yaml.dump(d, f)
 
     click.echo(f"Config file written to {output_path}")
+
+
+@create.command(cls=common.CommandBase)
+@click.argument("task_name", type=str, required=True)
+@click.argument("name", type=str, required=True)
+@click.option(
+    "--schedule",
+    type=str,
+    required=True,
+    help="Cron schedule for the trigger. Defaults to every minute.",
+    show_default=True,
+)
+@click.option(
+    "--description",
+    type=str,
+    default="",
+    help="Description of the trigger.",
+    show_default=True,
+)
+@click.option(
+    "--auto-activate",
+    is_flag=True,
+    default=True,
+    help="Whether the trigger should not be automatically activated. Defaults to True.",
+    show_default=True,
+)
+@click.option(
+    "--trigger-time-var",
+    type=str,
+    default="trigger_time",
+    help="Variable name for the trigger time in the task inputs. Defaults to 'trigger_time'.",
+    show_default=True,
+)
+@click.pass_obj
+def trigger(
+    cfg: common.CLIConfig,
+    task_name: str,
+    name: str,
+    schedule: str,
+    trigger_time_var: str = "trigger_time",
+    auto_activate: bool = True,
+    description: str = "",
+    project: str | None = None,
+    domain: str | None = None,
+):
+    """
+    Create a new trigger for a task. The task name and trigger name are required.
+
+    Example:
+
+    ```bash
+    $ flyte create trigger my_task my_trigger --schedule "0 0 * * *"
+    ```
+
+    This will create a trigger that runs every day at midnight.
+    """
+    from flyte.remote import Trigger
+
+    cfg.init(project, domain)
+    console = common.get_console()
+
+    trigger = flyte.Trigger(
+        name=name,
+        automation=flyte.Cron(schedule),
+        description=description,
+        auto_activate=auto_activate,
+        inputs={trigger_time_var: flyte.TriggerTime},  # Use the trigger time variable in inputs
+        env_vars=None,
+        interruptible=None,
+    )
+    with console.status("Creating trigger..."):
+        v = Trigger.create(trigger, task_name=task_name)
+    console.print(f"[bold green]Trigger {v.name} created successfully![/bold green]")

flyte/cli/_delete.py

@@ -20,4 +20,26 @@ def secret(cfg: common.CLIConfig, name: str, project: str | None = None, domain:
     from flyte.remote import Secret
 
     cfg.init(project, domain)
-    Secret.delete(name=name)
+    console = common.get_console()
+    with console.status(f"Deleting secret {name}..."):
+        Secret.delete(name=name)
+    console.print(f"Successfully deleted secret {name}.")
+
+
+@delete.command(cls=common.CommandBase)
+@click.argument("name", type=str, required=True)
+@click.argument("task-name", type=str, required=True)
+@click.pass_obj
+def trigger(cfg: common.CLIConfig, name: str, task_name: str, project: str | None = None, domain: str | None = None):
+    """
+    Delete a trigger. The name of the trigger is required.
+    """
+    from flyte.remote import Trigger
+
+    cfg.init(project, domain)
+    console = common.get_console()
+
+    with console.status(f"Deleting trigger {name}..."):
+        Trigger.delete(name=name, task_name=task_name)
+
+    console.log(f"[green]Successfully deleted trigger {name}[/green]")

flyte/cli/_deploy.py

@@ -7,8 +7,8 @@ from typing import Any, Dict, List, cast, get_args
 import rich_click as click
 
 import flyte
+from flyte._code_bundle._utils import CopyFiles
 
-from .._code_bundle._utils import CopyFiles
 from . import _common as common
 from ._common import CLIConfig
 
@@ -104,9 +104,7 @@ class DeployEnvCommand(click.RichCommand):
         super().__init__(*args, **kwargs)
 
     def invoke(self, ctx: click.Context):
-        from rich.console import Console
-
-        console = Console()
+        console = common.get_console()
         console.print(f"Deploying root - environment: {self.env_name}")
         obj: CLIConfig = ctx.obj
         obj.init(self.deploy_args.project, self.deploy_args.domain, root_dir=self.deploy_args.root_dir)
@@ -119,7 +117,7 @@ class DeployEnvCommand(click.RichCommand):
             )
 
         console.print(common.format("Environments", deployment[0].env_repr(), obj.output_format))
-        console.print(common.format("Tasks", deployment[0].task_repr(), obj.output_format))
+        console.print(common.format("Tasks", deployment[0].table_repr(), obj.output_format))
 
 
 class DeployEnvRecursiveCommand(click.Command):
@@ -135,13 +133,11 @@ class DeployEnvRecursiveCommand(click.Command):
         super().__init__(*args, **kwargs)
 
     def invoke(self, ctx: click.Context):
-        from rich.console import Console
-
         from flyte._environment import list_loaded_environments
         from flyte._utils import load_python_modules
 
-        console = Console()
         obj: CLIConfig = ctx.obj
+        console = common.get_console()
 
         # Load all python modules
         loaded_modules, failed_paths = load_python_modules(self.path, self.deploy_args.recursive)
@@ -177,7 +173,7 @@ class DeployEnvRecursiveCommand(click.Command):
         console.print(
             common.format("Environments", [env for d in deployments for env in d.env_repr()], obj.output_format)
         )
-        console.print(common.format("Tasks", [task for d in deployments for task in d.task_repr()], obj.output_format))
+        console.print(common.format("Tasks", [task for d in deployments for task in d.table_repr()], obj.output_format))
 
 
 class EnvPerFileGroup(common.ObjectsPerFileGroup):

flyte/cli/_get.py

@@ -1,10 +1,11 @@
 import asyncio
-from typing import Tuple, Union
+from typing import Tuple, Union, get_args
 
 import rich_click as click
-from rich.console import Console
 from rich.pretty import pretty_repr
 
+import flyte.remote as remote
+
 from . import _common as common
 
 
@@ -38,20 +39,24 @@ def project(cfg: common.CLIConfig, name: str | None = None):
     """
     Get a list of all projects, or details of a specific project by name.
     """
-    from flyte.remote import Project
-
     cfg.init()
 
-    console = Console()
+    console = common.get_console()
     if name:
-        console.print(pretty_repr(Project.get(name)))
+        console.print(pretty_repr(remote.Project.get(name)))
     else:
-        console.print(common.format("Projects", Project.listall(), cfg.output_format))
+        console.print(common.format("Projects", remote.Project.listall(), cfg.output_format))
 
 
 @get.command(cls=common.CommandBase)
 @click.argument("name", type=str, required=False)
 @click.option("--limit", type=int, default=100, help="Limit the number of runs to fetch when listing.")
+@click.option(
+    "--in-phase",  # multiple=True, TODO support multiple phases once values in works
+    type=click.Choice(get_args(remote.Phase), case_sensitive=False),
+    help="Filter runs by their status.",
+)
+@click.option("--only-mine", is_flag=True, default=False, help="Show only runs created by the current user (you).")
 @click.pass_obj
 def run(
     cfg: common.CLIConfig,
@@ -59,6 +64,8 @@ def run(
     project: str | None = None,
     domain: str | None = None,
     limit: int = 100,
+    in_phase: str | Tuple[str, ...] | None = None,
+    only_mine: bool = False,
 ):
     """
     Get a list of all runs, or details of a specific run by name.
@@ -67,16 +74,29 @@ def run(
 
     If you want to see the actions for a run, use `get action <run_name>`.
     """
-    from flyte.remote import Run, RunDetails
 
     cfg.init(project=project, domain=domain)
 
-    console = Console()
+    console = common.get_console()
     if name:
-        details = RunDetails.get(name=name)
+        details = remote.RunDetails.get(name=name)
         console.print(common.format(f"Run {name}", [details], "json"))
     else:
-        console.print(common.format("Runs", Run.listall(limit=limit), cfg.output_format))
+        if in_phase and isinstance(in_phase, str):
+            in_phase = (in_phase,)
+
+        subject = None
+        if only_mine:
+            usr = remote.User.get()
+            subject = usr.subject()
+
+        console.print(
+            common.format(
+                "Runs",
+                remote.Run.listall(limit=limit, in_phase=in_phase, created_by_subject=subject),
+                cfg.output_format,
+            )
+        )
 
 
 @get.command(cls=common.CommandBase)
@@ -97,22 +117,22 @@ def task(
 
     Currently, both `name` and `version` are required to get a specific task.
     """
-    from flyte.remote import Task
-
     cfg.init(project=project, domain=domain)
 
-    console = Console()
+    console = common.get_console()
     if name:
         if version:
-            v = Task.get(name=name, version=version)
+            v = remote.Task.get(name=name, version=version)
             if v is None:
                 raise click.BadParameter(f"Task {name} not found.")
             t = v.fetch()
             console.print(common.format(f"Task {name}", [t], "json"))
         else:
-            console.print(common.format("Tasks", Task.listall(by_task_name=name, limit=limit), cfg.output_format))
+            console.print(
+                common.format("Tasks", remote.Task.listall(by_task_name=name, limit=limit), cfg.output_format)
+            )
     else:
-        console.print(common.format("Tasks", Task.listall(limit=limit), cfg.output_format))
+        console.print(common.format("Tasks", remote.Task.listall(limit=limit), cfg.output_format))
 
 
 @get.command(cls=common.CommandBase)
@@ -129,11 +149,9 @@ def action(
     """
     Get all actions for a run or details for a specific action.
     """
-    import flyte.remote as remote
-
     cfg.init(project=project, domain=domain)
 
-    console = Console()
+    console = common.get_console()
     if action_name:
         console.print(
             common.format(
@@ -196,8 +214,6 @@ def logs(
     $ flyte get logs my_run my_action --pretty --lines 50
     ```
     """
-    import flyte.remote as remote
-
     cfg.init(project=project, domain=domain)
 
     async def _run_log_view(_obj):
@@ -230,11 +246,9 @@ def secret(
     """
     Get a list of all secrets, or details of a specific secret by name.
     """
-    import flyte.remote as remote
-
     cfg.init(project=project, domain=domain)
 
-    console = Console()
+    console = common.get_console()
     if name:
         console.print(common.format("Secret", [remote.Secret.get(name)], "json"))
     else:
@@ -275,26 +289,23 @@ def io(
     if inputs_only and outputs_only:
         raise click.BadParameter("Cannot use both --inputs-only and --outputs-only")
 
-    import flyte.remote as remote
-    from flyte.remote import ActionDetails, ActionInputs, ActionOutputs
-
     cfg.init(project=project, domain=domain)
-    console = Console()
+    console = common.get_console()
     if action_name:
-        obj = ActionDetails.get(run_name=run_name, name=action_name)
+        obj = remote.ActionDetails.get(run_name=run_name, name=action_name)
     else:
         obj = remote.RunDetails.get(run_name)
 
     async def _get_io(
-        details: Union[remote.RunDetails, ActionDetails],
-    ) -> Tuple[ActionInputs | None, ActionOutputs | None | str]:
+        details: Union[remote.RunDetails, remote.ActionDetails],
+    ) -> Tuple[remote.ActionInputs | None, remote.ActionOutputs | None | str]:
         if inputs_only or outputs_only:
             if inputs_only:
                 return await details.inputs(), None
             elif outputs_only:
                 return None, await details.outputs()
         inputs = await details.inputs()
-        outputs: ActionOutputs | None | str = None
+        outputs: remote.ActionOutputs | None | str = None
         try:
             outputs = await details.outputs()
         except Exception:
@@ -321,5 +332,35 @@ def config(cfg: common.CLIConfig):
 
     The configuration will include the endpoint, organization, and other settings that are used by the CLI.
     """
-    console = Console()
+    console = common.get_console()
     console.print(cfg)
+
+
+@get.command(cls=common.CommandBase)
+@click.argument("task_name", type=str, required=False)
+@click.argument("name", type=str, required=False)
+@click.option("--limit", type=int, default=100, help="Limit the number of triggers to fetch.")
+@click.pass_obj
+def trigger(
+    cfg: common.CLIConfig,
+    task_name: str | None = None,
+    name: str | None = None,
+    limit: int = 100,
+    project: str | None = None,
+    domain: str | None = None,
+):
+    """
+    Get a list of all triggers, or details of a specific trigger by name.
+    """
+    if name and not task_name:
+        raise click.BadParameter("If you provide a trigger name, you must also provide the task name.")
+
+    from flyte.remote import Trigger
+
+    cfg.init(project=project, domain=domain)
+
+    console = common.get_console()
+    if name:
+        console.print(pretty_repr(Trigger.get(name=name, task_name=task_name)))
+    else:
+        console.print(common.format("Triggers", Trigger.listall(task_name=task_name, limit=limit), cfg.output_format))

flyte/cli/_params.py

@@ -531,17 +531,19 @@ def to_click_option(
         if literal_var.type.metadata:
             description_extra = f": {MessageToDict(literal_var.type.metadata)}"
 
-    # If a query has been specified, the input is never strictly required at this layer
     required = False if default_val is not None else True
     is_flag: typing.Optional[bool] = None
+    param_decls = [f"--{input_name}"]
     if literal_converter.is_bool():
         required = False
         is_flag = True
+        if default_val is True:
+            param_decls = [f"--{input_name}/--no-{input_name}"]
     if literal_converter.is_optional():
         required = False
 
     return click.Option(
-        param_decls=[f"--{input_name}"],
+        param_decls=param_decls,
         type=literal_converter.click_type,
         is_flag=is_flag,
         default=default_val,

flyte/cli/_run.py

@@ -9,7 +9,6 @@ from types import ModuleType
 from typing import Any, Dict, List, cast
 
 import rich_click as click
-from rich.console import Console
 from typing_extensions import get_args
 
 from .._code_bundle._utils import CopyFiles
@@ -136,13 +135,23 @@ class RunTaskCommand(click.RichCommand):
         async def _run():
             import flyte
 
+            console = common.get_console()
             r = await flyte.with_runcontext(
                 copy_style=self.run_args.copy_style,
                 mode="local" if self.run_args.local else "remote",
                 name=self.run_args.name,
             ).run.aio(self.obj, **ctx.params)
+            if self.run_args.local:
+                console.print(
+                    common.get_panel(
+                        "Local Run",
+                        f"[green]Completed Local Run, data stored in path: {r.url} [/green] \n"
+                        f"➡️  Outputs: {r.outputs()}",
+                        obj.output_format,
+                    )
+                )
+                return
             if isinstance(r, Run) and r.action is not None:
-                console = Console()
                 console.print(
                     common.get_panel(
                         "Run",
@@ -222,6 +231,7 @@ class RunReferenceTaskCommand(click.RichCommand):
             import flyte.remote
 
             task = flyte.remote.Task.get(self.task_name, version=self.version, auto_version="latest")
+            console = common.get_console()
 
             r = await flyte.with_runcontext(
                 copy_style=self.run_args.copy_style,
@@ -229,7 +239,6 @@ class RunReferenceTaskCommand(click.RichCommand):
                 name=self.run_args.name,
             ).run.aio(task, **ctx.params)
             if isinstance(r, Run) and r.action is not None:
-                console = Console()
                 console.print(
                     common.get_panel(
                         "Run",

flyte/cli/_update.py

@@ -0,0 +1,36 @@
+import rich_click as click
+
+import flyte.remote as remote
+
+from . import _common as common
+
+
+@click.group(name="update")
+def update():
+    """
+    Update various flyte entities.
+    """
+
+
+@update.command("trigger", cls=common.CommandBase)
+@click.argument("name", type=str)
+@click.argument("task_name", type=str)
+@click.option("--activate/--deactivate", default=None, required=True, help="Activate or deactivate the trigger.")
+@click.pass_obj
+def trigger(cfg: common.CLIConfig, name: str, task_name: str, activate: bool, project: str | None, domain: str | None):
+    """
+    Update a trigger.
+
+    \b
+    Example usage:
+
+    ```bash
+    flyte update trigger <trigger_name> <task_name> --activate | --deactivate
+    [--project <project_name> --domain <domain_name>]
+    ```
+    """
+    cfg.init(project, domain)
+    console = common.get_console()
+    with console.status(f"Updating trigger {name} for task {task_name} to {'active' if activate else 'deactive'}..."):
+        remote.Trigger.update(name, task_name, activate)
+    console.print("Trigger updated.")

flyte/cli/_user.py

@@ -0,0 +1,17 @@
+import rich_click as click
+
+import flyte.remote as remote
+
+from . import _common as common
+
+
+@click.command()
+@click.pass_obj
+def whoami(
+    cfg: common.CLIConfig,
+):
+    """Display the current user information."""
+    cfg.init()
+    console = common.get_console()
+    user_info = remote.User.get()
+    console.print(user_info.to_json())

flyte/cli/main.py

@@ -13,6 +13,8 @@ from ._deploy import deploy
 from ._gen import gen
 from ._get import get
 from ._run import run
+from ._update import update
+from ._user import whoami
 
 help_config = click.RichHelpConfiguration(
     use_markdown=True,
@@ -25,7 +27,7 @@ help_config = click.RichHelpConfiguration(
             },
             {
                 "name": "Management of various objects.",
-                "commands": ["create", "get", "delete"],
+                "commands": ["create", "get", "delete", "update"],
             },
             {
                 "name": "Build and deploy environments, tasks and images.",
@@ -35,6 +37,10 @@ help_config = click.RichHelpConfiguration(
                 "name": "Documentation generation",
                 "commands": ["gen"],
             },
+            {
+                "name": "User information",
+                "commands": ["whoami"],
+            },
         ]
     },
 )
@@ -193,3 +199,5 @@ main.add_command(abort)  # type: ignore
 main.add_command(gen)  # type: ignore
 main.add_command(delete)  # type: ignore
 main.add_command(build)
+main.add_command(whoami)  # type: ignore
+main.add_command(update)  # type: ignore

flyte/errors.py

@@ -232,3 +232,12 @@ class SlowDownError(RuntimeUserError):
 
     def __init__(self, message: str):
         super().__init__("SlowDownError", message, "user")
+
+
+class OnlyAsyncIOSupportedError(RuntimeUserError):
+    """
+    This error is raised when the user tries to use sync IO in an async task.
+    """
+
+    def __init__(self, message: str):
+        super().__init__("OnlyAsyncIOSupportedError", message, "user")