Add support for --max-items

openstacksdk commit d649aada8 added support for a max_items parameter to
allow users to distinguish between the page size and the total amount of
resources to return. Wire this option through to OSC by adding a new
--max-items parameter. This is implemented for all services that
currently use SDK as their client and support pagination.

Change-Id: I98a61daf097418ad59e2c47c39440476d5a0b7c7
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Author: stephenfin

openstackclient/common/pagination.py

@@ -21,8 +21,11 @@
 # useful
 
 
+# TODO(stephenfin): include_max_items should not be necessary once we need to
+# migrate remaining users to openstacksdk
 def add_marker_pagination_option_to_parser(
     parser: argparse.ArgumentParser,
+    include_max_items: bool = True,
 ) -> None:
     """Add marker-based pagination options to the parser.
 
@@ -39,8 +42,11 @@ def add_marker_pagination_option_to_parser(
         type=int,
         action=parseractions.NonNegativeAction,
         help=_(
-            'The maximum number of entries to return. If the value exceeds '
-            'the server-defined maximum, then the maximum value will be used.'
+            'The maximum number of entries to return per page. If the value '
+            'exceeds the server-defined maximum, then the server-defined '
+            'value will be used. Note that this controls the page size, not '
+            'the total number of entries returned. Use --max-items to limit '
+            'the total number of entries returned.'
         ),
     )
     parser.add_argument(
@@ -52,10 +58,26 @@ def add_marker_pagination_option_to_parser(
             'This should be a value that was returned in a previous request.'
         ),
     )
+    if include_max_items:
+        parser.add_argument(
+            '--max-items',
+            metavar='<max-items>',
+            type=int,
+            action=parseractions.NonNegativeAction,
+            default=None,
+            help=_(
+                'The maximum number of entries to return in total, paging '
+                'through multiple requests if needed. Use --limit to control '
+                'the page size.'
+            ),
+        )
 
 
+# TODO(stephenfin): include_max_items should not be necessary once we need to
+# migrate remaining users to openstacksdk
 def add_offset_pagination_option_to_parser(
     parser: argparse.ArgumentParser,
+    include_max_items: bool = True,
 ) -> None:
     """Add offset-based pagination options to the parser.
 
@@ -71,8 +93,11 @@ def add_offset_pagination_option_to_parser(
         type=int,
         action=parseractions.NonNegativeAction,
         help=_(
-            'The maximum number of entries to return. If the value exceeds '
-            'the server-defined maximum, then the maximum value will be used.'
+            'The maximum number of entries to return per page. If the value '
+            'exceeds the server-defined maximum, then the maximum value will '
+            'be used. Note that this controls the page size, not the total '
+            'number of entries returned. Use --max-items to limit the total '
+            'number of entries returned.'
         ),
     )
     parser.add_argument(
@@ -86,3 +111,16 @@ def add_offset_pagination_option_to_parser(
             'return.'
         ),
     )
+    if include_max_items:
+        parser.add_argument(
+            '--max-items',
+            metavar='<max-items>',
+            type=int,
+            action=parseractions.NonNegativeAction,
+            default=None,
+            help=_(
+                'The maximum number of entries to return in total, paging '
+                'through multiple requests if needed. Use --limit to control '
+                'the page size.'
+            ),
+        )

openstackclient/compute/v2/flavor.py

@@ -339,6 +339,8 @@ def take_action(
 
         if parsed_args.limit:
             query_attrs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            query_attrs['max_items'] = parsed_args.max_items
 
         if parsed_args.limit or parsed_args.marker:
             # User passed explicit pagination request, switch off SDK

openstackclient/compute/v2/hypervisor.py

@@ -122,6 +122,8 @@ def take_action(
                 )
                 raise exceptions.CommandError(msg)
             list_opts['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            list_opts['max_items'] = parsed_args.max_items
 
         if parsed_args.matching:
             list_opts['hypervisor_hostname_pattern'] = parsed_args.matching

openstackclient/compute/v2/keypair.py

@@ -336,6 +336,8 @@ def take_action(
                 raise exceptions.CommandError(msg)
 
             kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            kwargs['max_items'] = parsed_args.max_items
 
         if parsed_args.project:
             if not sdk_utils.supports_microversion(compute_client, '2.10'):

openstackclient/compute/v2/server.py

@@ -2854,6 +2854,9 @@ def take_action(
             search_opts['limit'] = parsed_args.limit
             search_opts['paginated'] = False
 
+        if parsed_args.max_items is not None:
+            search_opts['max_items'] = parsed_args.max_items
+
         LOG.debug('search options: %s', search_opts)
 
         if search_opts['changes-before']:

openstackclient/compute/v2/server_event.py

@@ -171,6 +171,9 @@ def take_action(
             kwargs['limit'] = parsed_args.limit
             kwargs['paginated'] = False
 
+        if parsed_args.max_items is not None:
+            kwargs['max_items'] = parsed_args.max_items
+
         if parsed_args.changes_since:
             if not sdk_utils.supports_microversion(compute_client, '2.58'):
                 msg = _(

openstackclient/compute/v2/server_group.py

@@ -219,6 +219,8 @@ def take_action(
 
         if parsed_args.limit:
             kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            kwargs['max_items'] = parsed_args.max_items
 
         data = compute_client.server_groups(**kwargs)
 

openstackclient/compute/v2/server_migration.py

@@ -207,6 +207,9 @@ def take_action(
             search_opts['limit'] = parsed_args.limit
             search_opts['paginated'] = False
 
+        if parsed_args.max_items is not None:
+            search_opts['max_items'] = parsed_args.max_items
+
         if parsed_args.changes_since:
             if not sdk_utils.supports_microversion(compute_client, "2.59"):
                 msg = _(

openstackclient/identity/v3/project.py

@@ -352,6 +352,8 @@ def take_action(
 
         if parsed_args.limit is not None:
             kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            kwargs['max_items'] = parsed_args.max_items
         if parsed_args.marker is not None:
             kwargs['marker'] = parsed_args.marker
 

openstackclient/identity/v3/user.py

@@ -486,6 +486,8 @@ def take_action(
         pagination_kwargs: dict[str, Any] = {}
         if parsed_args.limit is not None:
             pagination_kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            pagination_kwargs['max_items'] = parsed_args.max_items
         if parsed_args.marker is not None:
             pagination_kwargs['marker'] = parsed_args.marker