Better CLI error messages (#4035)

* Better error messages in stack CLI

* Apply to more exceptions

* Fix logic

* Linting

Author: schustmi

src/zenml/cli/artifact.py

@@ -105,7 +105,7 @@ def update_artifact(
             remove_tags=remove_tag,
         )
     except (KeyError, ValueError) as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Artifact '{artifact.id}' updated.")
 
@@ -192,7 +192,7 @@ def update_artifact_version(
             remove_tags=remove_tag,
         )
     except (KeyError, ValueError) as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Artifact version '{artifact_version.id}' updated.")
 

src/zenml/cli/authorized_device.py

@@ -47,7 +47,7 @@ def describe_authorized_device(id_or_prefix: str) -> None:
             id_or_prefix=id_or_prefix,
         )
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
 
     cli_utils.print_pydantic_model(
         title=f"Authorized device `{device.id}`",
@@ -93,7 +93,7 @@ def lock_authorized_device(id: str) -> None:
             locked=True,
         )
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Locked authorized device `{id}`.")
 
@@ -112,7 +112,7 @@ def unlock_authorized_device(id: str) -> None:
             locked=False,
         )
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Locked authorized device `{id}`.")
 
@@ -143,6 +143,6 @@ def delete_authorized_device(id: str, yes: bool = False) -> None:
     try:
         Client().delete_authorized_device(id_or_prefix=id)
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Deleted authorized device `{id}`.")

src/zenml/cli/code_repository.py

@@ -180,7 +180,7 @@ def describe_code_repository(name_id_or_prefix: str) -> None:
             name_id_or_prefix=name_id_or_prefix,
         )
     except KeyError as err:
-        cli_utils.error(str(err))
+        cli_utils.exception(err)
     else:
         cli_utils.print_pydantic_model(
             title=f"Code repository '{code_repository.name}'",
@@ -303,6 +303,6 @@ def delete_code_repository(name_or_id: str, yes: bool = False) -> None:
     try:
         Client().delete_code_repository(name_id_or_prefix=name_or_id)
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Deleted code repository `{name_or_id}`.")

src/zenml/cli/deployment.py

@@ -83,7 +83,7 @@ def list_deployments(**kwargs: Any) -> None:
         with console.status("Listing deployments...\n"):
             deployments = client.list_deployments(**kwargs)
     except KeyError as err:
-        cli_utils.error(str(err))
+        cli_utils.exception(err)
     else:
         if not deployments.items:
             cli_utils.declare("No deployments found for this filter.")
@@ -140,7 +140,7 @@ def describe_deployment(
             name_id_or_prefix=deployment_name_or_id,
         )
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.pretty_print_deployment(
             deployment,
@@ -245,7 +245,7 @@ def provision_deployment(
                 timeout=timeout,
             )
         except KeyError as e:
-            cli_utils.error(str(e))
+            cli_utils.exception(e)
         else:
             cli_utils.declare(
                 f"Provisioned deployment '{deployment_name_or_id}'."
@@ -580,7 +580,7 @@ def refresh_deployment(
         )
 
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.pretty_print_deployment(deployment, show_secret=True)
 
@@ -694,7 +694,7 @@ def log_deployment(
             tail=tail,
         )
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         for log in logs:
             print(log)

src/zenml/cli/integration.py

@@ -26,6 +26,7 @@
     confirmation,
     declare,
     error,
+    exception,
     format_integration_list,
     install_packages,
     print_table,
@@ -89,7 +90,7 @@ def get_requirements(integration_name: Optional[str] = None) -> None:
             integration_name
         )
     except KeyError as e:
-        error(str(e))
+        exception(e)
     else:
         if requirements:
             title(

src/zenml/cli/model.py

@@ -212,7 +212,7 @@ def register_model(
             )
         )
     except (EntityExistsError, ValueError) as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
 
     cli_utils.print_table([_model_to_print(model)])
 
@@ -380,7 +380,7 @@ def delete_model(
             model_name_or_id=model_name_or_id,
         )
     except (KeyError, ValueError) as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Model '{model_name_or_id}' deleted.")
 
@@ -558,7 +558,7 @@ def delete_model_version(
             model_version_id=model_version.id,
         )
     except (KeyError, ValueError) as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(
             f"Model version '{model_version_name_or_number_or_id}' deleted from model '{model_name_or_id}'."

src/zenml/cli/pipeline.py

@@ -621,7 +621,7 @@ def delete_pipeline(
             name_id_or_prefix=pipeline_name_or_id,
         )
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Deleted pipeline `{pipeline_name_or_id}`.")
 
@@ -681,7 +681,7 @@ def update_schedule(
             cron_expression=cron_expression,
         )
     except Exception as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Updated schedule '{schedule_name_or_id}'.")
 
@@ -713,7 +713,7 @@ def delete_schedule(schedule_name_or_id: str, yes: bool = False) -> None:
     try:
         Client().delete_schedule(name_id_or_prefix=schedule_name_or_id)
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Deleted schedule '{schedule_name_or_id}'.")
 
@@ -736,7 +736,7 @@ def list_pipeline_runs(**kwargs: Any) -> None:
         with console.status("Listing pipeline runs...\n"):
             pipeline_runs = client.list_pipeline_runs(**kwargs)
     except KeyError as err:
-        cli_utils.error(str(err))
+        cli_utils.exception(err)
     else:
         if not pipeline_runs.items:
             cli_utils.declare("No pipeline runs found for this filter.")
@@ -832,7 +832,7 @@ def delete_pipeline_run(
             name_id_or_prefix=run_name_or_id,
         )
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Deleted pipeline run '{run_name_or_id}'.")
 
@@ -862,7 +862,7 @@ def refresh_pipeline_run(
         )
 
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(
             f"Refreshed the status of pipeline run '{run.name}'."
@@ -887,7 +887,7 @@ def list_pipeline_builds(**kwargs: Any) -> None:
         with console.status("Listing pipeline builds...\n"):
             pipeline_builds = client.list_builds(hydrate=True, **kwargs)
     except KeyError as err:
-        cli_utils.error(str(err))
+        cli_utils.exception(err)
     else:
         if not pipeline_builds.items:
             cli_utils.declare("No pipeline builds found for this filter.")
@@ -935,7 +935,7 @@ def delete_pipeline_build(
     try:
         Client().delete_build(build_id)
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Deleted pipeline build '{build_id}'.")
 
@@ -1224,7 +1224,7 @@ def deploy_snapshot(
                 timeout=timeout,
             )
         except KeyError as e:
-            cli_utils.error(str(e))
+            cli_utils.exception(e)
         else:
             cli_utils.declare(
                 f"Provisioned deployment '{deployment_name_or_id}'."
@@ -1245,7 +1245,7 @@ def list_pipeline_snapshots(**kwargs: Any) -> None:
         with console.status("Listing pipeline snapshots...\n"):
             pipeline_snapshots = client.list_snapshots(hydrate=True, **kwargs)
     except KeyError as err:
-        cli_utils.error(str(err))
+        cli_utils.exception(err)
     else:
         if not pipeline_snapshots.items:
             cli_utils.declare("No pipeline snapshots found for this filter.")

src/zenml/cli/project.py

@@ -111,7 +111,7 @@ def register_project(
             )
             cli_utils.success("✔ Project created successfully.")
         except Exception as e:
-            cli_utils.error(str(e))
+            cli_utils.exception(e)
 
     if set_project:
         client.set_active_project(project_name)
@@ -153,7 +153,7 @@ def set_project(project_name_or_id: str, default: bool = False) -> None:
                 f"✔ The active project has been set to {project_name_or_id}"
             )
         except Exception as e:
-            cli_utils.error(str(e))
+            cli_utils.exception(e)
 
     if default:
         client.update_user(
@@ -184,7 +184,7 @@ def describe_project(project_name_or_id: Optional[str] = None) -> None:
         try:
             project_ = client.get_project(project_name_or_id)
         except KeyError as err:
-            cli_utils.error(str(err))
+            cli_utils.exception(err)
         else:
             cli_utils.print_pydantic_models(
                 [project_], exclude_columns=["created", "updated"]
@@ -208,4 +208,4 @@ def delete_project(project_name_or_id: str) -> None:
                 f"Project '{project_name_or_id}' deleted successfully."
             )
         except Exception as e:
-            cli_utils.error(str(e))
+            cli_utils.exception(e)

src/zenml/cli/server.py

@@ -780,4 +780,4 @@ def show(local: bool = False, ngrok_token: Optional[str] = None) -> None:
     try:
         zenml.show(ngrok_token=ngrok_token)
     except RuntimeError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)

src/zenml/cli/service_accounts.py

@@ -58,7 +58,7 @@ def _create_api_key(
                 description=description or "",
             )
         except (KeyError, EntityExistsError) as e:
-            cli_utils.error(str(e))
+            cli_utils.exception(e)
 
         cli_utils.declare(f"Successfully created API key `{name}`.")
 
@@ -150,7 +150,7 @@ def create_service_account(
 
         cli_utils.declare(f"Created service account '{service_account.name}'.")
     except EntityExistsError as err:
-        cli_utils.error(str(err))
+        cli_utils.exception(err)
 
     if create_api_key:
         _create_api_key(
@@ -176,7 +176,7 @@ def describe_service_account(service_account_name_or_id: str) -> None:
             service_account_name_or_id
         )
     except KeyError as err:
-        cli_utils.error(str(err))
+        cli_utils.exception(err)
     else:
         cli_utils.print_pydantic_model(
             title=f"Service account '{service_account.name}'",
@@ -261,7 +261,7 @@ def update_service_account(
             active=active,
         )
     except (KeyError, EntityExistsError) as err:
-        cli_utils.error(str(err))
+        cli_utils.exception(err)
 
 
 @service_account.command("delete")
@@ -276,7 +276,7 @@ def delete_service_account(service_account_name_or_id: str) -> None:
     try:
         client.delete_service_account(service_account_name_or_id)
     except (KeyError, IllegalOperationError) as err:
-        cli_utils.error(str(err))
+        cli_utils.exception(err)
 
     cli_utils.declare(
         f"Deleted service account '{service_account_name_or_id}'."
@@ -370,7 +370,7 @@ def describe_api_key(service_account_name_or_id: str, name_or_id: str) -> None:
                 name_id_or_prefix=name_or_id,
             )
         except KeyError as e:
-            cli_utils.error(str(e))
+            cli_utils.exception(e)
 
         cli_utils.print_pydantic_model(
             title=f"API key '{api_key.name}'",
@@ -399,7 +399,7 @@ def list_api_keys(service_account_name_or_id: str, /, **kwargs: Any) -> None:
                 **kwargs,
             )
         except KeyError as e:
-            cli_utils.error(str(e))
+            cli_utils.exception(e)
 
         if not api_keys.items:
             cli_utils.declare("No API keys found for this filter.")
@@ -455,7 +455,7 @@ def update_api_key(
             active=active,
         )
     except (KeyError, EntityExistsError) as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
 
     cli_utils.declare(f"Successfully updated API key `{name_or_id}`.")
 
@@ -510,7 +510,7 @@ def rotate_api_key(
             retain_period_minutes=retain,
         )
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
 
     cli_utils.declare(f"Successfully rotated API key `{name_or_id}`.")
     if retain:
@@ -581,6 +581,6 @@ def delete_api_key(
             name_id_or_prefix=name_or_id,
         )
     except KeyError as e:
-        cli_utils.error(str(e))
+        cli_utils.exception(e)
     else:
         cli_utils.declare(f"Deleted API key `{name_or_id}`.")