cloudsmith-cli 1.10.2__py2.py3-none-any.whl → 1.10.4__py2.py3-none-any.whl

cloudsmith_cli/cli/commands/status.py

@@ -3,7 +3,7 @@
 import click
 
 from ...core.api.packages import get_package_status
-from .. import decorators, validators
+from .. import decorators, utils, validators
 from ..exceptions import handle_api_exceptions
 from ..utils import maybe_spinner
 from .main import main
@@ -32,6 +32,8 @@ def status(ctx, opts, owner_repo_package):
     """
     owner, repo, slug = owner_repo_package
 
+    use_stderr = utils.should_use_stderr(opts)
+
     click.echo(
         "Getting status of %(package)s in %(owner)s/%(repo)s ... "
         % {
@@ -40,6 +42,7 @@ def status(ctx, opts, owner_repo_package):
             "package": click.style(slug, bold=True),
         },
         nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to get status of package!"
@@ -48,7 +51,7 @@ def status(ctx, opts, owner_repo_package):
             res = get_package_status(owner, repo, slug)
             ok, failed, _, status_str, stage_str, reason = res
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
     if not stage_str:
         package_status = status_str
@@ -62,13 +65,28 @@ def status(ctx, opts, owner_repo_package):
     else:
         status_colour = "magenta"
 
+    if utils.maybe_print_as_json(
+        opts,
+        {
+            "ok": ok,
+            "failed": failed,
+            "status": status_str,
+            "stage": stage_str,
+            "reason": reason,
+            "slug": slug,
+        },
+    ):
+        return
+
     click.secho(
         "The package status is: %(status)s"
-        % {"status": click.style(package_status, fg=status_colour)}
+        % {"status": click.style(package_status, fg=status_colour)},
+        err=use_stderr,
     )
 
     if reason:
         click.secho(
             f"Reason given: {click.style(reason, fg='yellow')}",
             fg=status_colour,
+            err=use_stderr,
         )

cloudsmith_cli/cli/commands/tags.py

@@ -95,10 +95,13 @@ def list_tags(ctx, opts, owner_repo_package):
     """
     owner, repo, package = owner_repo_package
 
+    use_stderr = utils.should_use_stderr(opts)
+
     click.echo(
         "Listing tags for the '%(package)s' package ... "
         % {"package": click.style(package, bold=True)},
         nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to list tags for the package!"
@@ -108,7 +111,7 @@ def list_tags(ctx, opts, owner_repo_package):
                 owner=owner, repo=repo, identifier=package
             )
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
     _print_tags(opts, package_tags, package_tags_immutable)
 
@@ -158,6 +161,8 @@ def add_tags(ctx, opts, owner_repo_package, tags, immutable):
     owner, repo, package = owner_repo_package
     tags = _parse_tags(tags)
 
+    use_stderr = utils.should_use_stderr(opts)
+
     click.echo(
         "Adding '%(tags)s' tag%(s)s to the '%(package)s' package ... "
         % {
@@ -166,6 +171,7 @@ def add_tags(ctx, opts, owner_repo_package, tags, immutable):
             "s": "s" if len(tags) != 1 else "",
         },
         nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to add tags to package!"
@@ -178,7 +184,7 @@ def add_tags(ctx, opts, owner_repo_package, tags, immutable):
                 data={"action": "add", "tags": tags, "is_immutable": immutable},
             )
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
     _print_tags(opts, package_tags, package_tags_immutable)
 
@@ -212,10 +218,13 @@ def clear_tags(ctx, opts, owner_repo_package):
     """
     owner, repo, package = owner_repo_package
 
+    use_stderr = utils.should_use_stderr(opts)
+
     click.echo(
         "Clearing tags on the '%(package)s' package ... "
         % {"package": click.style(package, bold=True)},
         nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to clear tags on package!"
@@ -225,7 +234,7 @@ def clear_tags(ctx, opts, owner_repo_package):
                 owner=owner, repo=repo, identifier=package, data={"action": "clear"}
             )
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
     _print_tags(opts, package_tags, package_tags_immutable)
 
@@ -265,6 +274,8 @@ def remove_tags(ctx, opts, owner_repo_package, tags):
     owner, repo, package = owner_repo_package
     tags = _parse_tags(tags)
 
+    use_stderr = utils.should_use_stderr(opts)
+
     click.echo(
         "Removing '%(tags)s' tag%(s)s from the '%(package)s' package ... "
         % {
@@ -273,6 +284,7 @@ def remove_tags(ctx, opts, owner_repo_package, tags):
             "s": "s" if len(tags) != 1 else "",
         },
         nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to remove tags from package!"
@@ -285,7 +297,7 @@ def remove_tags(ctx, opts, owner_repo_package, tags):
                 data={"action": "remove", "tags": tags},
             )
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
     _print_tags(opts, package_tags, package_tags_immutable)
 
@@ -335,6 +347,8 @@ def replace_tags(ctx, opts, owner_repo_package, tags, immutable):
     owner, repo, package = owner_repo_package
     tags = _parse_tags(tags)
 
+    use_stderr = utils.should_use_stderr(opts)
+
     click.echo(
         "Replacing existing with '%(tags)s' tag%(s)s on the '%(package)s' package ... "
         % {
@@ -343,6 +357,7 @@ def replace_tags(ctx, opts, owner_repo_package, tags, immutable):
             "s": "s" if len(tags) != 1 else "",
         },
         nl=False,
+        err=use_stderr,
     )
 
     context_msg = "Failed to replace tags on package!"
@@ -355,6 +370,6 @@ def replace_tags(ctx, opts, owner_repo_package, tags, immutable):
                 data={"action": "replace", "tags": tags, "is_immutable": immutable},
             )
 
-    click.secho("OK", fg="green")
+    click.secho("OK", fg="green", err=use_stderr)
 
     _print_tags(opts, package_tags, package_tags_immutable)

cloudsmith_cli/cli/commands/tokens.py

@@ -2,9 +2,8 @@ import click
 
 from ...core.api import exceptions, user as api
 from ...core.config import create_config_files, new_config_messaging
-from .. import command, decorators
+from .. import command, decorators, utils
 from ..exceptions import handle_api_exceptions
-from ..utils import maybe_print_as_json, maybe_spinner
 from .main import main
 
 
@@ -23,6 +22,7 @@ def handle_duplicate_token_error(exc, ctx, opts, save_config, force, json):
             if not click.confirm(
                 "User already has a token. Would you like to recreate it?",
                 abort=False,
+                err=json,
             ):
                 return None
         return refresh_existing_token_interactive(
@@ -47,17 +47,17 @@ def tokens(ctx, opts):
 @click.pass_context
 def list_tokens(ctx, opts):
     """List all user API tokens."""
-    use_stderr = opts.output in ("json", "pretty_json")
+    use_stderr = utils.should_use_stderr(opts)
 
     click.echo("Retrieving API tokens... ", nl=False, err=use_stderr)
 
     context_msg = "Failed to retrieve API tokens!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
-        with maybe_spinner(opts):
+        with utils.maybe_spinner(opts):
             tokens = api.list_user_tokens()
     click.secho("OK", fg="green", err=use_stderr)
 
-    if maybe_print_as_json(opts, tokens):
+    if utils.maybe_print_as_json(opts, tokens):
         return
 
     print_tokens(tokens)
@@ -123,7 +123,7 @@ def refresh(ctx, opts, token_slug, force, save_config):
     )
 
     if new_token:
-        if maybe_print_as_json(opts, new_token):
+        if utils.maybe_print_as_json(opts, new_token):
             return new_token
 
 
@@ -140,6 +140,8 @@ def refresh_existing_token_interactive(
     ctx, opts, token_slug=None, save_config=False, force=False, json=False
 ):
     """Refresh an existing API token with interactive token selection, or create new if none exist."""
+    json = json or utils.should_use_stderr(opts)
+    use_stderr = json
     context_msg = "Failed to refresh the token!"
 
     if not token_slug:
@@ -151,13 +153,17 @@ def refresh_existing_token_interactive(
             if opts.debug:
                 click.echo(f"Debug: Failed to list tokens with error: {exc}", err=True)
             click.echo(
-                "Unable to list existing tokens. Creating a new token instead..."
+                "Unable to list existing tokens. Creating a new token instead...",
+                err=use_stderr,
             )
-            return _create(ctx, opts, save_config=save_config, force=force)
+            return _create(ctx, opts, save_config=save_config, force=force, json=json)
 
         if not api_tokens:
-            click.echo("No existing tokens found. Creating a new token instead...")
-            return _create(ctx, opts, save_config=save_config, force=force)
+            click.echo(
+                "No existing tokens found. Creating a new token instead...",
+                err=use_stderr,
+            )
+            return _create(ctx, opts, save_config=save_config, force=force, json=json)
 
         if not json:
             click.echo("Current tokens:")
@@ -165,7 +171,8 @@ def refresh_existing_token_interactive(
 
         if not force:
             token_slug = click.prompt(
-                "Please enter the slug_perm of the token you would like to refresh"
+                "Please enter the slug_perm of the token you would like to refresh",
+                err=use_stderr,
             )
         else:
             # Use the first available slug_perm when force is enabled
@@ -175,9 +182,13 @@ def refresh_existing_token_interactive(
 
     if not json:
         click.echo(f"Refreshing token {token_slug}... ", nl=False)
+    else:
+        # In JSON mode, print info to stderr
+        click.echo(f"Refreshing token {token_slug}... ", nl=False, err=json)
+
     try:
         with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
-            with maybe_spinner(opts):
+            with utils.maybe_spinner(opts):
                 new_token = api.refresh_user_token(token_slug)
 
         if save_config:
@@ -186,7 +197,7 @@ def refresh_existing_token_interactive(
             )
             new_config_messaging(has_errors, opts, create, api_key=new_token.key)
 
-        if maybe_print_as_json(opts, new_token):
+        if utils.maybe_print_as_json(opts, new_token):
             return
 
         if not json:
@@ -198,35 +209,36 @@ def refresh_existing_token_interactive(
         # If refresh fails due to API error, offer to create a new token instead
         if opts.debug:
             click.echo(f"\nDebug: Refresh failed with error: {exc}", err=True)
-        click.echo("\nRefresh failed. Creating a new token instead...")
-        return _create(ctx, opts, save_config=save_config, force=force)
+        click.echo("\nRefresh failed. Creating a new token instead...", err=use_stderr)
+        return _create(ctx, opts, save_config=save_config, force=force, json=json)
 
 
 def _create(ctx, opts, save_config=False, force=False, json=False):
     """Create a new API token."""
+    json = json or utils.should_use_stderr(opts)
+
     try:
         new_token = api.create_user_token_saml()
 
         if new_token:
-            if json:
+            # NOTE: This mutation is necessary during the deprecation period of the --json flag.
+            if json and opts.output not in ("json", "pretty_json"):
                 opts.output = "json"
-                if maybe_print_as_json(opts, new_token):
-                    return
-            if maybe_print_as_json(opts, new_token):
+
+            if utils.maybe_print_as_json(opts, new_token):
                 return
-            if not json:
-                click.echo(
-                    f"New token value: {click.style(new_token.key, fg='magenta')}"
-                )
+
+            click.echo(f"New token value: {click.style(new_token.key, fg='magenta')}")
             return new_token
 
         return new_token
 
     except exceptions.ApiException as exc:
         if exc.status == 401:
-            click.echo(f"{exc.detail}")
+            click.echo(f"{exc.detail}", err=True)
             return
-        if json:
+        # NOTE: This mutation is necessary during the deprecation period of the --json flag.
+        if json and opts.output not in ("json", "pretty_json"):
             opts.output = "json"
         if exc.status == 400:
             new_token = handle_duplicate_token_error(

cloudsmith_cli/cli/commands/upstream.py

@@ -173,8 +173,7 @@ def build_upstream_list_command(upstream_fmt):
     def func(ctx, opts, owner_repo, page, page_size, page_all):
         owner, repo = owner_repo
 
-        # Use stderr for messages if the output is something else (e.g.  # JSON)
-        use_stderr = opts.output != "pretty"
+        use_stderr = utils.should_use_stderr(opts)
 
         if not use_stderr:
             click.echo("Getting upstreams... ", nl=False, err=use_stderr)
@@ -418,7 +417,7 @@ def build_upstream_delete_command(upstream_fmt):
             "delete the %(slug_perm)s upstream from the %(owner)s/%(repo)s repository"
             % delete_args
         )
-        if not utils.confirm_operation(prompt, assume_yes=yes):
+        if not utils.confirm_operation(prompt, assume_yes=yes, err=use_stderr):
             return
 
         if not use_stderr:

cloudsmith_cli/cli/commands/whoami.py

@@ -3,9 +3,8 @@
 import click
 
 from ...core.api.user import get_user_brief
-from .. import decorators
+from .. import decorators, utils
 from ..exceptions import handle_api_exceptions
-from ..utils import maybe_print_as_json, maybe_spinner
 from .main import main
 
 
@@ -17,7 +16,7 @@ from .main import main
 @click.pass_context
 def whoami(ctx, opts):
     """Retrieve your current authentication status."""
-    use_stderr = opts.output in ("json", "pretty_json")
+    use_stderr = utils.should_use_stderr(opts)
 
     click.echo(
         "Retrieving your authentication status from the API ... ",
@@ -27,7 +26,7 @@ def whoami(ctx, opts):
 
     context_msg = "Failed to retrieve your authentication status!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
-        with maybe_spinner(opts):
+        with utils.maybe_spinner(opts):
             is_auth, username, email, name = get_user_brief()
     click.secho("OK", fg="green", err=use_stderr)
 
@@ -38,7 +37,7 @@ def whoami(ctx, opts):
         "name": name,
     }
 
-    if maybe_print_as_json(opts, data):
+    if utils.maybe_print_as_json(opts, data):
         return
 
     click.echo("You are authenticated as:")

cloudsmith_cli/cli/exceptions.py

@@ -16,67 +16,103 @@ def handle_api_exceptions(
 ):
     """Context manager that handles API exceptions."""
     # flake8: ignore=C901
+
     # Use stderr for messages if the output is something else (e.g.  # JSON)
-    use_stderr = opts.output != "pretty"
+    is_json_output = getattr(opts, "output", None) in ("json", "pretty_json")
+    use_stderr = is_json_output
 
     try:
         yield
     except ApiException as exc:
-        if nl:
-            click.echo(err=use_stderr)
-            click.secho("ERROR: ", fg="red", nl=False, err=use_stderr)
-        else:
-            click.secho("ERROR", fg="red", err=use_stderr)
-
         context_msg = context_msg or "Failed to perform operation!"
-        click.secho(
-            "%(context)s (status: %(code)s - %(code_text)s)"
-            % {
-                "context": context_msg,
-                "code": exc.status,
-                "code_text": exc.status_description,
-            },
-            fg="red",
-            err=use_stderr,
-        )
-
         detail, fields = get_details(exc)
-        if detail or fields:
-            click.echo(err=use_stderr)
-
-            if detail:
-                click.secho(
-                    "Detail: %(detail)s"
-                    % {"detail": click.style(detail, fg="red", bold=False)},
-                    bold=True,
-                    err=use_stderr,
-                )
+        hint = get_error_hint(ctx, opts, exc)
+
+        if is_json_output:
+            # Construct JSON error object
+            error_data = {
+                "detail": detail or exc.status_description,
+                "help": {
+                    "context": context_msg,
+                    "hint": hint,
+                },
+                "meta": {
+                    "code": exc.status,
+                    "description": exc.status_description,
+                },
+            }
 
             if fields:
-                for k, v in fields.items():
-                    field = "%s Field" % k.capitalize()
-                    click.secho(
-                        "%(field)s: %(message)s"
-                        % {
-                            "field": click.style(field, bold=True),
-                            "message": click.style(v, fg="red"),
-                        },
-                        err=use_stderr,
-                    )
+                error_data["fields"] = fields
+
+            # Print to stdout
+            import json
 
-        hint = get_error_hint(ctx, opts, exc)
-        if hint:
             click.echo(
-                f"Hint: {click.style(hint, fg='yellow')}",
+                json.dumps(
+                    error_data, indent=4 if opts.output == "pretty_json" else None
+                )
+            )
+
+        else:
+            # Standard CLI output to stderr (or interleaved if output != pretty, but we force use_stderr now)
+            if nl:
+                click.echo(err=use_stderr)
+                click.secho("ERROR: ", fg="red", nl=False, err=use_stderr)
+            else:
+                click.secho("ERROR", fg="red", err=use_stderr)
+
+            click.secho(
+                "%(context)s (status: %(code)s - %(code_text)s)"
+                % {
+                    "context": context_msg,
+                    "code": exc.status,
+                    "code_text": exc.status_description,
+                },
+                fg="red",
                 err=use_stderr,
             )
 
-        if opts.verbose and not opts.debug:
-            if exc.headers:
+            if detail or fields:
                 click.echo(err=use_stderr)
-                click.echo("Headers in Reply:", err=use_stderr)
-                for k, v in exc.headers.items():
-                    click.echo(f"{k} = {v}", err=use_stderr)
+
+                if detail:
+                    click.secho(
+                        "Detail: %(detail)s"
+                        % {"detail": click.style(detail, fg="red", bold=False)},
+                        bold=True,
+                        err=use_stderr,
+                    )
+
+                if fields:
+                    for k, v in fields.items():
+                        field = "%s Field" % k.capitalize()
+
+                        # Flatten list/tuple error messages for text output
+                        if isinstance(v, (list, tuple)):
+                            v = " ".join(v)
+
+                        click.secho(
+                            "%(field)s: %(message)s"
+                            % {
+                                "field": click.style(field, bold=True),
+                                "message": click.style(v, fg="red"),
+                            },
+                            err=use_stderr,
+                        )
+
+            if hint:
+                click.echo(
+                    f"Hint: {click.style(hint, fg='yellow')}",
+                    err=use_stderr,
+                )
+
+            if opts.verbose and not opts.debug:
+                if exc.headers:
+                    click.echo(err=use_stderr)
+                    click.echo("Headers in Reply:", err=use_stderr)
+                    for k, v in exc.headers.items():
+                        click.echo(f"{k} = {v}", err=use_stderr)
 
         if reraise_on_error:
             raise
@@ -100,10 +136,11 @@ def get_details(exc):
             except (TypeError, KeyError):
                 field_detail = v
 
-            if isinstance(field_detail, (list, tuple)):
-                field_detail = " ".join(field_detail)
-
             if k == "non_field_errors":
+                # Ensure we handle list/tuple for non_field_errors details joining
+                if isinstance(field_detail, (list, tuple)):
+                    field_detail = " ".join(field_detail)
+
                 if detail:
                     detail += " " + field_detail
                 else:

cloudsmith_cli/cli/utils.py

@@ -191,10 +191,25 @@ def confirm_operation(prompt, prefix=None, assume_yes=False, err=False):
 
 @contextmanager
 def maybe_spinner(opts):
-    """Only activate the spinner if not in debug mode."""
-    if opts.debug:
+    """Only activate the spinner if not in debug mode or using json output."""
+    if should_use_stderr(opts) or get_output_format(opts) in ("json", "pretty_json"):
         # No spinner
         yield
     else:
         with spinner() as spin:
             yield spin
+
+
+def get_output_format(opts):
+    """Get the output format from opts."""
+    return getattr(opts, "output", None)
+
+
+def should_use_stderr(opts):
+    """Check if stdout should be avoided for informational messages."""
+    return get_output_format(opts) in ("json", "pretty_json")
+
+
+def maybe_print_status_json(opts, status_dict):
+    """Maybe print a status dict as JSON."""
+    return maybe_print_as_json(opts, status_dict)

cloudsmith_cli/cli/webserver.py

@@ -214,7 +214,7 @@ class AuthenticationWebRequestHandler(BaseHTTPRequestHandler):
 
             if two_factor_token:
                 totp_token = click.prompt(
-                    "Please enter your 2FA token", hide_input=True, type=str
+                    "Please enter your 2FA token", hide_input=True, type=str, err=True
                 )
 
                 access_token, refresh_token = exchange_2fa_token(

cloudsmith_cli/data/VERSION

@@ -1 +1 @@
-1.10.2
+1.10.4

{cloudsmith_cli-1.10.2.dist-info → cloudsmith_cli-1.10.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudsmith-cli
-Version: 1.10.2
+Version: 1.10.4
 Summary: Cloudsmith Command-Line Interface (CLI)
 Home-page: https://github.com/cloudsmith-io/cloudsmith-cli
 Author: Cloudsmith Ltd