feat: add options to output registered entity summary

flytekit/clis/sdk_in_container/pyflyte.py

@@ -21,10 +21,12 @@
 from flytekit.clis.sdk_in_container.serve import serve
 from flytekit.clis.sdk_in_container.utils import ErrorHandlingCommand, validate_package
 from flytekit.clis.version import info
-from flytekit.configuration.file import FLYTECTL_CONFIG_ENV_VAR, FLYTECTL_CONFIG_ENV_VAR_OVERRIDE
+from flytekit.configuration.file import FLYTECTL_CONFIG_ENV_VAR_OVERRIDE
 from flytekit.configuration.internal import LocalSDK
 from flytekit.configuration.plugin import get_plugin
-from flytekit.loggers import logger
+
+# from flytekit.configuration.file import  FLYTECTL_CONFIG_ENV_VAR, FLYTECTL_CONFIG_ENV_VAR_OVERRIDE
+# from flytekit.loggers import logger
 
 
 @click.group("pyflyte", invoke_without_command=True, cls=ErrorHandlingCommand)
@@ -66,11 +68,12 @@ def main(ctx, pkgs: typing.List[str], config: str, verbose: int):
     if config:
         ctx.obj[CTX_CONFIG_FILE] = config
         cfg = configuration.ConfigFile(config)
+        # Temporarily commented out to ensure proper output format when using --quiet flag in pyflyte register
         # Set here so that if someone has Config.auto() in their user code, the config here will get used.
-        if FLYTECTL_CONFIG_ENV_VAR in os.environ:
-            logger.info(
-                f"Config file arg {config} will override env var {FLYTECTL_CONFIG_ENV_VAR}: {os.environ[FLYTECTL_CONFIG_ENV_VAR]}"
-            )
+        # if FLYTECTL_CONFIG_ENV_VAR in os.environ:
+        #     logger.info(
+        #         f"Config file arg {config} will override env var {FLYTECTL_CONFIG_ENV_VAR}: {os.environ[FLYTECTL_CONFIG_ENV_VAR]}"
+        #     )
         os.environ[FLYTECTL_CONFIG_ENV_VAR_OVERRIDE] = config
         if not pkgs:
             pkgs = LocalSDK.WORKFLOW_PACKAGES.read(cfg)

flytekit/clis/sdk_in_container/register.py

@@ -33,6 +33,9 @@
 the root of your project, it finds the first folder that does not have a ``__init__.py`` file.
 """
 
+_original_secho = click.secho
+_original_log_level = logger.level
+
 
 @click.command("register", help=_register_help)
 @project_option_dec
@@ -142,6 +145,20 @@
     help="Skip errors during registration. This is useful when registering multiple packages and you want to skip "
     "errors for some packages.",
 )
+@click.option(
+    "--summary-format",
+    "-f",
+    required=False,
+    type=click.Choice(["json", "yaml"], case_sensitive=False),
+    default=None,
+    help="Output format for registration summary. Lists registered workflows, tasks, and launch plans. 'json' and 'yaml' supported.",
+)
+@click.option(
+    "--quiet",
+    is_flag=True,
+    default=False,
+    help="Suppress output messages, only displaying errors.",
+)
 @click.argument("package-or-module", type=click.Path(exists=True, readable=True, resolve_path=True), nargs=-1)
 @click.pass_context
 def register(
@@ -162,12 +179,25 @@ def register(
     activate_launchplans: bool,
     env: typing.Optional[typing.Dict[str, str]],
     skip_errors: bool,
+    summary_format: typing.Optional[str],
+    quiet: bool,
 ):
     """
     see help
     """
+
+    if summary_format is not None:
+        quiet = True
+
+    if quiet:
+        # Mute all secho output through monkey patching
+        click.secho = lambda *args, **kw: None
+        # Output only log at ERROR or CRITICAL level
+        logger.setLevel("ERROR")
+
     # Set the relevant copy option if non_fast is set, this enables the individual file listing behavior
     # that the copy flag uses.
+
     if non_fast:
         click.secho("The --non-fast flag is deprecated, please use --copy none instead", fg="yellow")
         if "--copy" in sys.argv:
@@ -195,39 +225,46 @@ def register(
             "Missing argument 'PACKAGE_OR_MODULE...', at least one PACKAGE_OR_MODULE is required but multiple can be passed",
         )
 
-    # Use extra images in the config file if that file exists
-    config_file = ctx.obj.get(constants.CTX_CONFIG_FILE)
-    if config_file:
-        image_config = patch_image_config(config_file, image_config)
-
-    click.secho(
-        f"Running pyflyte register from {os.getcwd()} "
-        f"with images {image_config} "
-        f"and image destination folder {destination_dir} "
-        f"on {len(package_or_module)} package(s) {package_or_module}",
-        dim=True,
-    )
-
-    # Create and save FlyteRemote,
-    remote = get_and_save_remote_with_click_context(ctx, project, domain, data_upload_location="flyte://data")
-    click.secho(f"Registering against {remote.config.platform.endpoint}")
-    repo.register(
-        project,
-        domain,
-        image_config,
-        output,
-        destination_dir,
-        service_account,
-        raw_data_prefix,
-        version,
-        deref_symlinks,
-        copy_style=copy,
-        package_or_module=package_or_module,
-        remote=remote,
-        env=env,
-        dry_run=dry_run,
-        activate_launchplans=activate_launchplans,
-        skip_errors=skip_errors,
-        show_files=show_files,
-        verbosity=ctx.obj[constants.CTX_VERBOSE],
-    )
+    try:
+        # Use extra images in the config file if that file exists
+        config_file = ctx.obj.get(constants.CTX_CONFIG_FILE)
+        if config_file:
+            image_config = patch_image_config(config_file, image_config)
+
+        click.secho(
+            f"Running pyflyte register from {os.getcwd()} "
+            f"with images {image_config} "
+            f"and image destination folder {destination_dir} "
+            f"on {len(package_or_module)} package(s) {package_or_module}",
+            dim=True,
+        )
+
+        # Create and save FlyteRemote,
+        remote = get_and_save_remote_with_click_context(ctx, project, domain, data_upload_location="flyte://data")
+        click.secho(f"Registering against {remote.config.platform.endpoint}")
+        repo.register(
+            project,
+            domain,
+            image_config,
+            output,
+            destination_dir,
+            service_account,
+            raw_data_prefix,
+            version,
+            deref_symlinks,
+            copy_style=copy,
+            package_or_module=package_or_module,
+            remote=remote,
+            env=env,
+            summary_format=summary_format,
+            quiet=quiet,
+            dry_run=dry_run,
+            activate_launchplans=activate_launchplans,
+            skip_errors=skip_errors,
+            show_files=show_files,
+            verbosity=ctx.obj[constants.CTX_VERBOSE],
+        )
+    finally:
+        # Restore original secho
+        click.secho = _original_secho
+        logger.setLevel(_original_log_level)

flytekit/clis/sdk_in_container/utils.py

@@ -71,7 +71,8 @@ def validate_package(ctx, param, values):
             pkgs.extend(val.split(","))
         else:
             pkgs.append(val)
-    logger.debug(f"Using packages: {pkgs}")
+    # Temporarily commented out to ensure proper output format when using --quiet flag in pyflyte register
+    # logger.debug(f"Using packages: {pkgs}")
     return pkgs