Add --show-all flag to repo/package list

BartoszBlizniak · BartoszBlizniak · commit b1cbbcb7d684 · 2024-09-25T15:39:59.000+01:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -18,6 +18,7 @@ jobs:
               run: |
                   python -m pip install --upgrade pip
                   pip install shiv
+                  pip install cloudsmith-cli
             - name: Get version
               id: get_version
               run: echo "VERSION=$(cat cloudsmith_cli/data/VERSION)" >> $GITHUB_ENV
@@ -43,3 +44,10 @@ jobs:
                   asset_path: ./cloudsmith-${{ env.VERSION }}.pyz
                   asset_name: cloudsmith-${{ env.VERSION }}.pyz
                   asset_content_type: application/zip
+            - name: Rename asses to cloudsmith.pyz
+              run: mv ./cloudsmith-${{ env.VERSION }}.pyz cloudsmith.pyz
+            - name: Upload to Cloudsmith
+              run: cloudsmith push raw ${{ vars.CLOUDSMITH_NAMESPACE }}/${{ vars.CLOUDSMITH_REPO }} cloudsmith.pyz --name "cloudsmith-cli" --version ${{ env.VERSION }}
+              env:
+                  CLOUDSMITH_API_KEY: ${{ secrets.CLOUDSMITH_API_KEY }}
+                  VERSION: ${{ env.VERSION }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -22,6 +22,7 @@ For most purposes, you probably just want `pip install -r requirements.txt`.
 
 Our [direnv config](./.envrc) file codifies the development environment setup which we use internally.
 
+Run `pre-commit run -a black` to format the code.
 
 ## Coding Conventions
 
diff --git a/cloudsmith_cli/cli/commands/list_.py b/cloudsmith_cli/cli/commands/list_.py
@@ -128,7 +128,7 @@ def entitlements_(*args, **kwargs):  # pylint: disable=missing-docstring
     help=("A boolean-like search term for querying package attributes."),
 )
 @click.pass_context
-def packages(ctx, opts, owner_repo, page, page_size, query):
+def packages(ctx, opts, owner_repo, page, page_size, show_all, query):
     """
     List packages for a repository.
 
@@ -165,20 +165,48 @@ def packages(ctx, opts, owner_repo, page, page_size, query):
 
     --query 'name:^foo$ filename:.zip$ architecture:~x86'
 
+    Options:
+      -p, --page INTEGER     The page of results to show.
+      -l, --page-size INTEGER  The number of results to return per page.
+      --show-all             Show all results by automatically paginating through all pages.
+      -q, --query TEXT       A boolean-like search term for querying package attributes.
     """
     owner, repo = owner_repo
 
+    if show_all:
+        if page is not None or page_size is not None:
+            raise click.UsageError(
+                "--show-all cannot be used with --page or --page-size"
+            )
+    else:
+        if page is None and page_size is None:
+            show_all = True
+
     # Use stderr for messages if the output is something else (e.g.  # JSON)
     use_stderr = opts.output != "pretty"
 
-    click.echo("Getting list of packages ... ", nl=False, err=use_stderr)
+    if show_all:
+        click.echo(
+            f"Retrieving all packages for repository {owner}/{repo}. This may take a while...",
+            err=use_stderr,
+        )
+    else:
+        click.echo("Getting list of packages ... ", nl=False, err=use_stderr)
 
     context_msg = "Failed to get list of packages!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            packages_, page_info = list_packages(
-                owner=owner, repo=repo, page=page, page_size=page_size, query=query
-            )
+            if show_all:
+                packages_, page_info = utils.get_all_pages(
+                    list_packages,
+                    owner=owner,
+                    repo=repo,
+                    query=query,
+                )
+            else:
+                packages_, page_info = list_packages(
+                    owner=owner, repo=repo, page=page, page_size=page_size, query=query
+                )
 
     click.secho("OK", fg="green", err=use_stderr)
 
@@ -211,7 +239,10 @@ def packages(ctx, opts, owner_repo, page, page_size, query):
     num_results = len(packages_)
     list_suffix = "package%s visible" % ("s" if num_results != 1 else "")
     utils.pretty_print_list_info(
-        num_results=num_results, page_info=page_info, suffix=list_suffix
+        num_results=num_results,
+        page_info=page_info,
+        suffix=list_suffix,
+        show_all=show_all,
     )
 
 
@@ -229,7 +260,7 @@ def packages(ctx, opts, owner_repo, page, page_size, query):
     required=False,
 )
 @click.pass_context
-def repos(ctx, opts, owner_repo, page, page_size):
+def repos(ctx, opts, owner_repo, page, page_size, show_all):
     """
     List repositories for a namespace (owner).
 
diff --git a/cloudsmith_cli/cli/commands/repos.py b/cloudsmith_cli/cli/commands/repos.py
@@ -12,7 +12,7 @@
 from .main import main
 
 
-def print_repositories(opts, data, page_info=None, show_list_info=True):
+def print_repositories(opts, data, page_info=None, show_list_info=True, show_all=False):
     """Print repositories as a table or output in another format."""
     headers = [
         "Name",
@@ -51,7 +51,10 @@ def print_repositories(opts, data, page_info=None, show_list_info=True):
     num_results = len(data)
     list_suffix = "repositor%s visible" % ("ies" if num_results != 1 else "y")
     utils.pretty_print_list_info(
-        num_results=num_results, page_info=page_info, suffix=list_suffix
+        num_results=num_results,
+        page_info=page_info,
+        suffix=list_suffix,
+        show_all=show_all,
     )
 
 
@@ -83,7 +86,7 @@ def repositories(ctx, opts):  # pylink: disable=unused-argument
     required=False,
 )
 @click.pass_context
-def get(ctx, opts, owner_repo, page, page_size):
+def get(ctx, opts, owner_repo, page, page_size, show_all):
     """
     List repositories for a namespace (owner).
 
@@ -95,12 +98,23 @@ def get(ctx, opts, owner_repo, page, page_size):
 
     If OWNER isn't specified it'll default to the currently authenticated user
     (if any). If you're unauthenticated, no results will be returned.
+
+    Options:
+      -p, --page INTEGER     The page of results to show.
+      -l, --page-size INTEGER  The number of results to return per page.
+      --show-all             Show all results by automatically paginating through all pages.
     """
+    if show_all:
+        if page is not None or page_size is not None:
+            raise click.UsageError(
+                "--show-all cannot be used with --page or --page-size"
+            )
+    elif page is None and page_size is None:
+        show_all = True
+
     # Use stderr for messages if the output is something else (e.g.  # JSON)
     use_stderr = opts.output != "pretty"
 
-    click.echo("Getting list of repositories ... ", nl=False, err=use_stderr)
-
     if isinstance(owner_repo, list):
         if len(owner_repo) == 1:
             owner = owner_repo[0]
@@ -109,26 +123,49 @@ def get(ctx, opts, owner_repo, page, page_size):
             owner, repo = owner_repo
     if isinstance(owner_repo, str):
         repo = None
-
         if owner_repo:
             owner = owner_repo
         else:
             owner = None
 
+    if show_all:
+        if owner:
+            click.echo(
+                f"Retrieving all repositories for {owner}. This may take a while...",
+                err=use_stderr,
+            )
+        else:
+            click.echo(
+                "Retrieving all repositories. This may take a while...", err=use_stderr
+            )
+    else:
+        click.echo("Getting list of repositories ... ", nl=False, err=use_stderr)
+
     context_msg = "Failed to get list of repositories!"
     with handle_api_exceptions(ctx, opts=opts, context_msg=context_msg):
         with maybe_spinner(opts):
-            repos_, page_info = api.list_repos(
-                owner=owner, repo=repo, page=page, page_size=page_size
-            )
+            if show_all:
+                repos_, page_info = utils.get_all_pages(
+                    api.list_repos,
+                    owner=owner,
+                    repo=repo,
+                )
+            else:
+                repos_, page_info = api.list_repos(
+                    owner=owner, repo=repo, page=page, page_size=page_size
+                )
 
     click.secho("OK", fg="green", err=use_stderr)
 
     if utils.maybe_print_as_json(opts, repos_, page_info):
         return
 
     print_repositories(
-        opts=opts, data=repos_, show_list_info=False, page_info=page_info
+        opts=opts,
+        data=repos_,
+        show_list_info=False,
+        page_info=page_info,
+        show_all=show_all,
     )
 
 
diff --git a/cloudsmith_cli/cli/decorators.py b/cloudsmith_cli/cli/decorators.py
@@ -142,31 +142,33 @@ def wrapper(ctx, *args, **kwargs):
 
 
 def common_cli_list_options(f):
-    """Add common list options to commands."""
+    """Add common options for list commands."""
 
     @click.option(
         "-p",
         "--page",
         default=1,
-        type=int,
-        help="The page to view for lists, where 1 is the first page",
+        help="The page of results to show.",
+        type=click.INT,
         callback=validators.validate_page,
     )
     @click.option(
         "-l",
         "--page-size",
-        default=30,
-        type=int,
-        help="The amount of items to view per page for lists.",
+        default=None,
+        help="The number of results to return per page.",
+        type=click.INT,
         callback=validators.validate_page_size,
     )
-    @click.pass_context
+    @click.option(
+        "--show-all",
+        is_flag=True,
+        default=False,
+        help="Show all results by automatically paginating through all pages.",
+    )
     @functools.wraps(f)
-    def wrapper(ctx, *args, **kwargs):
-        # pylint: disable=missing-docstring
-        opts = config.get_or_create_options(ctx)
-        kwargs["opts"] = opts
-        return ctx.invoke(f, *args, **kwargs)
+    def wrapper(*args, **kwargs):
+        return f(*args, **kwargs)
 
     return wrapper
 
diff --git a/cloudsmith_cli/cli/utils.py b/cloudsmith_cli/cli/utils.py
@@ -19,20 +19,24 @@ def make_user_agent(prefix=None):
     return f"cloudsmith-cli/{prefix} cli:{get_cli_version()} api:{get_api_version()}"
 
 
-def pretty_print_list_info(num_results, page_info=None, suffix=None):
+def pretty_print_list_info(num_results, page_info=None, suffix=None, show_all=False):
     """Pretty print list info, with pagination, for user display."""
     num_results_fg = "green" if num_results else "red"
     num_results_text = click.style(str(num_results), fg=num_results_fg)
 
     if page_info and page_info.is_valid:
-        page_range = page_info.calculate_range(num_results)
-        page_info_text = f"page: {click.style(str(page_info.page), bold=True)}/{click.style(str(page_info.page_total), bold=True)}, page size: {click.style(str(page_info.page_size), bold=True)}"
-        range_results_text = "%(from)s-%(to)s (%(num_results)s) of %(total)s" % {
-            "num_results": num_results_text,
-            "from": click.style(str(page_range[0]), fg=num_results_fg),
-            "to": click.style(str(page_range[1]), fg=num_results_fg),
-            "total": click.style(str(page_info.count), fg=num_results_fg),
-        }
+        if show_all:
+            range_results_text = f"{num_results_text} of {click.style(str(page_info.count), fg=num_results_fg)}"
+            page_info_text = "all pages"
+        else:
+            page_range = page_info.calculate_range(num_results)
+            page_info_text = f"page: {click.style(str(page_info.page), bold=True)}/{click.style(str(page_info.page_total), bold=True)}, page size: {click.style(str(page_info.page_size), bold=True)}"
+            range_results_text = "%(from)s-%(to)s (%(num_results)s) of %(total)s" % {
+                "num_results": num_results_text,
+                "from": click.style(str(page_range[0]), fg=num_results_fg),
+                "to": click.style(str(page_range[1]), fg=num_results_fg),
+                "total": click.style(str(page_info.count), fg=num_results_fg),
+            }
     else:
         page_info_text = ""
         range_results_text = num_results_text
@@ -192,3 +196,16 @@ def maybe_spinner(opts):
     else:
         with spinner() as spin:
             yield spin
+
+
+def get_all_pages(func, **kwargs):
+    """Retrieve all pages for a paginated API call."""
+    all_items = []
+    page = 1
+    while True:
+        items, page_info = func(page=page, **kwargs)
+        all_items.extend(items)
+        if page >= page_info.page_total:
+            break
+        page += 1
+    return all_items, page_info

Original file line number	Diff line number	Diff line change
@@ -22,6 +22,7 @@ For most purposes, you probably just want `pip install -r requirements.txt`.
`22`	`22`
`23`	`23`	`Our [direnv config](./.envrc) file codifies the development environment setup which we use internally.`
`24`	`24`
	`25`	+Run `pre-commit run -a black` to format the code.
`25`	`26`
`26`	`27`	`## Coding Conventions`
`27`	`28`