flyte 2.0.0b32__py3-none-any.whl

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

@@ -0,0 +1,221 @@
+import rich_click as click
+from typing_extensions import get_args
+
+from flyte._logging import LogFormat, initialize_logger, logger
+
+from . import _common as common
+from ._abort import abort
+from ._build import build
+from ._common import CLIConfig
+from ._create import create
+from ._delete import delete
+from ._deploy import deploy
+from ._gen import gen
+from ._get import get
+from ._plugins import discover_and_register_plugins
+from ._run import run
+from ._serve import serve
+from ._update import update
+from ._user import whoami
+
+help_config = click.RichHelpConfiguration(
+    use_markdown=True,
+    use_markdown_emoji=True,
+    command_groups={
+        "flyte": [
+            {
+                "name": "Run and stop tasks",
+                "commands": ["run", "abort"],
+            },
+            {
+                "name": "Management of various objects.",
+                "commands": ["create", "get", "delete", "update"],
+            },
+            {
+                "name": "Build and deploy environments, tasks and images.",
+                "commands": ["build", "deploy"],
+            },
+            {
+                "name": "Documentation generation",
+                "commands": ["gen"],
+            },
+            {
+                "name": "User information",
+                "commands": ["whoami"],
+            },
+        ]
+    },
+)
+
+
+def _verbosity_to_loglevel(verbosity: int) -> int | None:
+    """
+    Converts a verbosity level from the CLI to a logging level.
+
+    :param verbosity: verbosity level from the CLI
+    :return: logging level
+    """
+    import logging
+
+    match verbosity:
+        case 0:
+            return None
+        case 1:
+            return logging.WARNING
+        case 2:
+            return logging.INFO
+        case _:
+            return logging.DEBUG
+
+
+@click.group(cls=click.RichGroup)
+@click.option(
+    "--endpoint",
+    type=str,
+    required=False,
+    help="The endpoint to connect to. This will override any configuration file and simply use `pkce` to connect.",
+)
+@click.option(
+    "--insecure",
+    is_flag=True,
+    required=False,
+    help="Use an insecure connection to the endpoint. If not specified, the CLI will use TLS.",
+    type=bool,
+    default=None,
+    show_default=True,
+)
+@click.option(
+    "--auth-type",
+    type=click.Choice(common.ALL_AUTH_OPTIONS, case_sensitive=False),
+    default=None,
+    help="Authentication type to use for the Flyte backend. Defaults to 'pkce'.",
+    show_default=True,
+    required=False,
+)
+@click.option(
+    "-v",
+    "--verbose",
+    required=False,
+    help="Show verbose messages and exception traces. Repeating multiple times increases the verbosity (e.g., -vvv).",
+    count=True,
+    default=0,
+    type=int,
+)
+@click.option(
+    "--org",
+    type=str,
+    required=False,
+    help="The organization to which the command applies.",
+)
+@click.option(
+    "-c",
+    "--config",
+    "config_file",
+    required=False,
+    type=click.Path(exists=True),
+    help="Path to the configuration file to use. If not specified, the default configuration file is used.",
+)
+@click.option(
+    "--output-format",
+    "-of",
+    type=click.Choice(get_args(common.OutputFormat), case_sensitive=False),
+    default="table",
+    help="Output format for commands that support it. Defaults to 'table'.",
+    show_default=True,
+    required=False,
+)
+@click.option(
+    "--log-format",
+    type=click.Choice(get_args(LogFormat), case_sensitive=False),
+    envvar="LOG_FORMAT",
+    default="console",
+    help="Formatting for logs, defaults to 'console' which is meant to be human readable."
+    " 'json' is meant for machine parsing.",
+    show_default=True,
+    required=False,
+)
+@click.rich_config(help_config=help_config)
+@click.pass_context
+def main(
+    ctx: click.Context,
+    endpoint: str | None,
+    insecure: bool,
+    verbose: int,
+    log_format: LogFormat,
+    org: str | None,
+    config_file: str | None,
+    auth_type: str | None = None,
+    output_format: common.OutputFormat = "table",
+):
+    """
+    The Flyte CLI is the command line interface for working with the Flyte SDK and backend.
+
+    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 persistent settings,
+    such as the endpoint, organization, and verbosity level.
+
+    Set endpoint and organization:
+
+    ```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:
+
+    ```bash
+    $ flyte --config /path/to/config.yaml run ...
+    ```
+
+    * [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
+
+    log_level = _verbosity_to_loglevel(verbose)
+    if log_level is not None or log_format != "console":
+        initialize_logger(log_level=log_level, log_format=log_format)
+
+    cfg = config.auto(config_file=config_file)
+    if cfg.source:
+        logger.debug(f"Using config file discovered at location `{cfg.source.absolute()}`")
+
+    ctx.obj = CLIConfig(
+        log_level=log_level,
+        log_format=log_format,
+        endpoint=endpoint,
+        insecure=insecure,
+        org=org,
+        config=cfg,
+        ctx=ctx,
+        auth_type=auth_type,
+        output_format=output_format,
+    )
+
+
+main.add_command(run)
+main.add_command(deploy)
+main.add_command(get)  # type: ignore
+main.add_command(create)  # type: ignore
+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
+main.add_command(serve)  # type: ignore
+
+# Discover and register CLI plugins from installed packages
+discover_and_register_plugins(main)

flyte/config/__init__.py

@@ -0,0 +1,3 @@
+from flyte.config._config import Config, auto, get_config_file, set_if_exists
+
+__all__ = ["Config", "auto", "get_config_file", "set_if_exists"]

flyte/config/_config.py

@@ -0,0 +1,248 @@
+from __future__ import annotations
+
+import dataclasses
+import os
+import pathlib
+import typing
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING
+
+import rich.repr
+
+from flyte._logging import logger
+from flyte.config import _internal
+from flyte.config._reader import ConfigFile, get_config_file, read_file_if_exists
+
+_all__ = ["ConfigFile", "PlatformConfig", "TaskConfig", "ImageConfig"]
+
+if TYPE_CHECKING:
+    from flyte.remote._client.auth import AuthType
+
+
+@rich.repr.auto
+@dataclass(init=True, repr=True, eq=True, frozen=True)
+class PlatformConfig(object):
+    """
+    This object contains the settings to talk to a Flyte backend (the DNS location of your Admin server basically).
+
+    :param endpoint: DNS for Flyte backend
+    :param insecure: Whether or not to use SSL
+    :param insecure_skip_verify: Whether to skip SSL certificate verification
+    :param console_endpoint: endpoint for console if different from Flyte backend
+    :param command: This command is executed to return a token using an external process
+    :param proxy_command: This command is executed to return a token for proxy authorization using an external process
+    :param client_id: This is the public identifier for the app which handles authorization for a Flyte deployment.
+      More details here: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/.
+    :param client_credentials_secret: Used for service auth, which is automatically called during pyflyte. This will
+      allow the Flyte engine to read the password directly from the environment variable. Note that this is
+      less secure! Please only use this if mounting the secret as a file is impossible
+    :param scopes: List of scopes to request. This is only applicable to the client credentials flow
+    :param auth_mode: The OAuth mode to use. Defaults to pkce flow
+    :param ca_cert_file_path: [optional] str Root Cert to be loaded and used to verify admin
+    :param http_proxy_url: [optional] HTTP Proxy to be used for OAuth requests
+    """
+
+    endpoint: str | None = None
+    insecure: bool = False
+    insecure_skip_verify: bool = False
+    ca_cert_file_path: typing.Optional[str] = None
+    console_endpoint: typing.Optional[str] = None
+    command: typing.Optional[typing.List[str]] = None
+    proxy_command: typing.Optional[typing.List[str]] = None
+    client_id: typing.Optional[str] = None
+    client_credentials_secret: typing.Optional[str] = None
+    scopes: typing.List[str] = field(default_factory=list)
+    auth_mode: "AuthType" = "Pkce"
+    audience: typing.Optional[str] = None
+    rpc_retries: int = 3
+    http_proxy_url: typing.Optional[str] = None
+
+    @classmethod
+    def auto(cls, config_file: typing.Optional[typing.Union[str, ConfigFile]] = None) -> "PlatformConfig":
+        """
+        Reads from a config file, and overrides from Environment variables. Refer to ConfigEntry for details
+        :param config_file:
+        :return:
+        """
+
+        config_file = get_config_file(config_file)
+        kwargs: typing.Dict[str, typing.Any] = {}
+        kwargs = set_if_exists(kwargs, "insecure", _internal.Platform.INSECURE.read(config_file))
+        kwargs = set_if_exists(
+            kwargs, "insecure_skip_verify", _internal.Platform.INSECURE_SKIP_VERIFY.read(config_file)
+        )
+        kwargs = set_if_exists(kwargs, "ca_cert_file_path", _internal.Platform.CA_CERT_FILE_PATH.read(config_file))
+        kwargs = set_if_exists(kwargs, "command", _internal.Credentials.COMMAND.read(config_file))
+        kwargs = set_if_exists(kwargs, "proxy_command", _internal.Credentials.PROXY_COMMAND.read(config_file))
+        kwargs = set_if_exists(kwargs, "client_id", _internal.Credentials.CLIENT_ID.read(config_file))
+
+        is_client_secret = False
+        client_credentials_secret = read_file_if_exists(
+            _internal.Credentials.CLIENT_CREDENTIALS_SECRET_LOCATION.read(config_file)
+        )
+        if client_credentials_secret:
+            is_client_secret = True
+            if client_credentials_secret.endswith("\n"):
+                logger.info("Newline stripped from client secret")
+                client_credentials_secret = client_credentials_secret.strip()
+        kwargs = set_if_exists(
+            kwargs,
+            "client_credentials_secret",
+            client_credentials_secret,
+        )
+
+        client_credentials_secret_env_var = _internal.Credentials.CLIENT_CREDENTIALS_SECRET_ENV_VAR.read(config_file)
+        if client_credentials_secret_env_var:
+            client_credentials_secret = os.getenv(client_credentials_secret_env_var)
+            if client_credentials_secret:
+                is_client_secret = True
+        kwargs = set_if_exists(kwargs, "client_credentials_secret", client_credentials_secret)
+        kwargs = set_if_exists(kwargs, "scopes", _internal.Credentials.SCOPES.read(config_file))
+        kwargs = set_if_exists(kwargs, "auth_mode", _internal.Credentials.AUTH_MODE.read(config_file))
+        if is_client_secret:
+            kwargs = set_if_exists(kwargs, "auth_mode", "ClientSecret")
+        kwargs = set_if_exists(kwargs, "endpoint", _internal.Platform.URL.read(config_file))
+        kwargs = set_if_exists(kwargs, "console_endpoint", _internal.Platform.CONSOLE_ENDPOINT.read(config_file))
+
+        kwargs = set_if_exists(kwargs, "http_proxy_url", _internal.Platform.HTTP_PROXY_URL.read(config_file))
+        return PlatformConfig(**kwargs)
+
+    def replace(self, **kwargs: typing.Any) -> "PlatformConfig":
+        """
+        Returns a new PlatformConfig instance with the values from the kwargs overriding the current instance.
+        """
+        return dataclasses.replace(self, **kwargs)
+
+    @classmethod
+    def for_endpoint(cls, endpoint: str, insecure: bool = False) -> "PlatformConfig":
+        return PlatformConfig(endpoint=endpoint, insecure=insecure)
+
+
+@rich.repr.auto
+@dataclass(init=True, repr=True, eq=True, frozen=True)
+class TaskConfig(object):
+    org: str | None = None
+    project: str | None = None
+    domain: str | None = None
+
+    @classmethod
+    def auto(cls, config_file: typing.Optional[typing.Union[str, ConfigFile]] = None) -> "TaskConfig":
+        """
+        Reads from a config file, and overrides from Environment variables. Refer to ConfigEntry for details
+        :param config_file:
+        :return:
+        """
+        config_file = get_config_file(config_file)
+        kwargs: typing.Dict[str, typing.Any] = {}
+        kwargs = set_if_exists(kwargs, "org", _internal.Task.ORG.read(config_file))
+        kwargs = set_if_exists(kwargs, "project", _internal.Task.PROJECT.read(config_file))
+        kwargs = set_if_exists(kwargs, "domain", _internal.Task.DOMAIN.read(config_file))
+        return TaskConfig(**kwargs)
+
+
+@rich.repr.auto
+@dataclass(init=True, repr=True, eq=True, frozen=True)
+class ImageConfig(object):
+    """
+    Configuration for Docker image settings.
+    """
+
+    builder: str | None = None
+    image_refs: typing.Dict[str, str] = field(default_factory=dict)
+
+    @classmethod
+    def auto(cls, config_file: typing.Optional[typing.Union[str, ConfigFile]] = None) -> "ImageConfig":
+        """
+        Reads from a config file, and overrides from Environment variables. Refer to ConfigEntry for details
+        :param config_file:
+        :return:
+        """
+        config_file = get_config_file(config_file)
+        kwargs: typing.Dict[str, typing.Any] = {}
+        kwargs = set_if_exists(kwargs, "builder", _internal.Image.BUILDER.read(config_file))
+        kwargs = set_if_exists(kwargs, "image_refs", _internal.Image.IMAGE_REFS.read(config_file))
+        return ImageConfig(**kwargs)
+
+
+@rich.repr.auto
+@dataclass(init=True, repr=True, eq=True, frozen=True)
+class Config(object):
+    """
+    This the parent configuration object and holds all the underlying configuration object types. An instance of
+    this object holds all the config necessary to
+
+    1. Interactive session with Flyte backend
+    2. Some parts are required for Serialization, for example Platform Config is not required
+    3. Runtime of a task
+    """
+
+    platform: PlatformConfig = field(default=PlatformConfig())
+    task: TaskConfig = field(default=TaskConfig())
+    image: ImageConfig = field(default=ImageConfig())
+    source: pathlib.Path | None = None
+
+    def with_params(
+        self,
+        platform: PlatformConfig | None = None,
+        task: TaskConfig | None = None,
+        image: ImageConfig | None = None,
+    ) -> "Config":
+        return Config(
+            platform=platform or self.platform,
+            task=task or self.task,
+            image=image or self.image,
+        )
+
+    @classmethod
+    def auto(cls, config_file: typing.Union[str, pathlib.Path, ConfigFile, None] = None) -> "Config":
+        """
+        Automatically constructs the Config Object. The order of precedence is as follows
+          1. first try to find any env vars that match the config vars specified in the FLYTE_CONFIG format.
+          2. If not found in environment then values ar read from the config file
+          3. If not found in the file, then the default values are used.
+
+        :param config_file: file path to read the config from, if not specified default locations are searched
+        :return: Config
+        """
+        config_file = get_config_file(config_file)
+        if config_file is None:
+            logger.debug("No config file found, using default values")
+            return Config()
+        return Config(
+            platform=PlatformConfig.auto(config_file),
+            task=TaskConfig.auto(config_file),
+            image=ImageConfig.auto(config_file),
+            source=config_file.path,
+        )
+
+
+def set_if_exists(d: dict, k: str, val: typing.Any) -> dict:
+    """
+    Given a dict ``d`` sets the key ``k`` with value of config ``v``, if the config value ``v`` is set
+    and return the updated dictionary.
+    """
+    exists = isinstance(val, bool) or bool(val is not None and val)
+    if exists:
+        d[k] = val
+    return d
+
+
+def auto(config_file: typing.Union[str, pathlib.Path, ConfigFile, None] = None) -> Config:
+    """
+    Automatically constructs the Config Object. The order of precedence is as follows
+      1. If specified, read the config from the provided file path.
+      2. If not specified, the config file is searched in the default locations.
+            a. ./config.yaml if it exists  (current working directory)
+            b. ./.flyte/config.yaml if it exists (current working directory)
+            c. <git_root>/.flyte/config.yaml if it exists
+            d. `UCTL_CONFIG` environment variable
+            e. `FLYTECTL_CONFIG` environment variable
+            f. ~/.union/config.yaml if it exists
+            g. ~/.flyte/config.yaml if it exists
+    3. If any value is not found in the config file, the default value is used.
+    4. For any value there are environment variables that match the config variable names, those will override
+
+    :param config_file: file path to read the config from, if not specified default locations are searched
+    :return: Config
+    """
+    return Config.auto(config_file)

flyte/config/_internal.py

@@ -0,0 +1,73 @@
+from flyte.config._reader import ConfigEntry, YamlConfigEntry
+
+
+class Platform(object):
+    URL = ConfigEntry(YamlConfigEntry("admin.endpoint"))
+    INSECURE = ConfigEntry(YamlConfigEntry("admin.insecure", bool))
+    INSECURE_SKIP_VERIFY = ConfigEntry(YamlConfigEntry("admin.insecureSkipVerify", bool))
+    CONSOLE_ENDPOINT = ConfigEntry(YamlConfigEntry("console.endpoint"))
+    CA_CERT_FILE_PATH = ConfigEntry(YamlConfigEntry("admin.caCertFilePath"))
+    HTTP_PROXY_URL = ConfigEntry(YamlConfigEntry("admin.httpProxyURL"))
+
+
+class Credentials(object):
+    SECTION = "credentials"
+    COMMAND = ConfigEntry(YamlConfigEntry("admin.command", list))
+    """
+    This command is executed to return a token using an external process.
+    """
+
+    PROXY_COMMAND = ConfigEntry(YamlConfigEntry("admin.proxyCommand", list))
+    """
+    This command is executed to return a token for authorization with a proxy
+     in front of Flyte using an external process.
+    """
+
+    CLIENT_ID = ConfigEntry(YamlConfigEntry("admin.clientId"))
+    """
+    This is the public identifier for the app which handles authorization for a Flyte deployment.
+    More details here: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/.
+    """
+
+    CLIENT_CREDENTIALS_SECRET_LOCATION = ConfigEntry(YamlConfigEntry("admin.clientSecretLocation"))
+    """
+    Used for basic auth, which is automatically called during pyflyte. This will allow the Flyte engine to read the
+    password from a mounted file.
+    """
+
+    CLIENT_CREDENTIALS_SECRET_ENV_VAR = ConfigEntry(YamlConfigEntry("admin.clientSecretEnvVar"))
+    """
+    Used for basic auth, which is automatically called during pyflyte. This will allow the Flyte engine to read the
+    password from a mounted environment variable.
+    """
+
+    SCOPES = ConfigEntry(YamlConfigEntry("admin.scopes", list))
+    """
+    This setting can be used to manually pass in scopes into authenticator flows - eg.) for Auth0 compatibility
+    """
+
+    AUTH_MODE = ConfigEntry(YamlConfigEntry("admin.authType"))
+    """
+    The auth mode defines the behavior used to request and refresh credentials. The currently supported modes include:
+    - 'standard' or 'Pkce': This uses the pkce-enhanced authorization code flow by opening a browser window to initiate
+            credentials access.
+    - "DeviceFlow": This uses the Device Authorization Flow
+    - 'basic', 'client_credentials' or 'clientSecret': This uses symmetric key auth in which the end user enters a
+            client id and a client secret and public key encryption is used to facilitate authentication.
+    - None: No auth will be attempted.
+    """
+
+
+class Task(object):
+    ORG = ConfigEntry(YamlConfigEntry("task.org"))
+    PROJECT = ConfigEntry(YamlConfigEntry("task.project"))
+    DOMAIN = ConfigEntry(YamlConfigEntry("task.domain"))
+
+
+class Image(object):
+    """
+    Defines the configuration for the image builder.
+    """
+
+    BUILDER = ConfigEntry(YamlConfigEntry("image.builder"))
+    IMAGE_REFS = ConfigEntry(YamlConfigEntry("image.image_refs"))