python-openstackclient 6.3.0__py3-none-any.whl → 6.5.0__py3-none-any.whl

openstackclient/common/availability_zone.py

@@ -16,7 +16,7 @@
 import copy
 import logging
 
-from novaclient import exceptions as nova_exceptions
+from openstack import exceptions as sdk_exceptions
 from osc_lib.command import command
 from osc_lib import utils
 
@@ -119,8 +119,8 @@ class ListAvailabilityZone(command.Lister):
     def _get_compute_availability_zones(self, parsed_args):
         compute_client = self.app.client_manager.sdk_connection.compute
         try:
-            data = compute_client.availability_zones(details=True)
-        except nova_exceptions.Forbidden:  # policy doesn't allow
+            data = list(compute_client.availability_zones(details=True))
+        except sdk_exceptions.ForbiddenException:  # policy doesn't allow
             try:
                 data = compute_client.availability_zones(details=False)
             except Exception:
@@ -135,7 +135,7 @@ class ListAvailabilityZone(command.Lister):
         volume_client = self.app.client_manager.sdk_connection.volume
         data = []
         try:
-            data = volume_client.availability_zones()
+            data = list(volume_client.availability_zones())
         except Exception as e:
             LOG.debug('Volume availability zone exception: %s', e)
             if parsed_args.volume:

openstackclient/common/pagination.py

@@ -0,0 +1,82 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from osc_lib.cli import parseractions
+
+from openstackclient.i18n import _
+
+
+# TODO(stephenfin): Consider moving these to osc-lib since they're broadly
+# useful
+
+
+def add_marker_pagination_option_to_parser(parser):
+    """Add marker-based pagination options to the parser.
+
+    APIs that use marker-based paging use the marker and limit query parameters
+    to paginate through items in a collection.
+
+    Marker-based pagination is often used in cases where the length of the
+    total set of items is either changing frequently, or where the total length
+    might not be known upfront.
+    """
+    parser.add_argument(
+        '--limit',
+        metavar='<limit>',
+        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.'
+        ),
+    )
+    parser.add_argument(
+        '--marker',
+        metavar='<marker>',
+        default=None,
+        help=_(
+            'The first position in the collection to return results from. '
+            'This should be a value that was returned in a previous request.'
+        ),
+    )
+
+
+def add_offset_pagination_option_to_parser(parser):
+    """Add offset-based pagination options to the parser.
+
+    APIs that use offset-based paging use the offset and limit query parameters
+    to paginate through items in a collection.
+
+    Offset-based pagination is often used where the list of items is of a fixed
+    and predetermined length.
+    """
+    parser.add_argument(
+        '--limit',
+        metavar='<limit>',
+        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.'
+        ),
+    )
+    parser.add_argument(
+        '--offset',
+        metavar='<offset>',
+        type=int,
+        action=parseractions.NonNegativeAction,
+        default=None,
+        help=_(
+            'The (zero-based) offset of the first item in the collection to '
+            'return.'
+        ),
+    )

openstackclient/compute/v2/flavor.py

@@ -25,6 +25,7 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -292,22 +293,7 @@ class ListFlavor(command.Lister):
             default=False,
             help=_("List additional fields in output"),
         )
-        parser.add_argument(
-            '--marker',
-            metavar="<flavor-id>",
-            help=_("The last flavor ID of the previous page"),
-        )
-        parser.add_argument(
-            '--limit',
-            type=int,
-            metavar='<num-flavors>',
-            help=_(
-                'Maximum number of flavors to display. This is also '
-                'configurable on the server. The actual limit used will be '
-                'the lower of the user-supplied value and the server '
-                'configuration-derived value'
-            ),
-        )
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(self, parsed_args):

openstackclient/compute/v2/hypervisor.py

@@ -25,6 +25,7 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 
 
@@ -80,27 +81,7 @@ class ListHypervisor(command.Lister):
                 "when using microversion 2.52 or lower"
             ),
         )
-        parser.add_argument(
-            '--marker',
-            metavar='<marker>',
-            help=_(
-                "The UUID of the last hypervisor of the previous page; "
-                "displays list of hypervisors after 'marker'. "
-                "(supported with --os-compute-api-version 2.33 or above)"
-            ),
-        )
-        parser.add_argument(
-            '--limit',
-            metavar='<limit>',
-            type=int,
-            help=_(
-                "Maximum number of hypervisors to display. Note that there "
-                "is a configurable max limit on the server, and the limit "
-                "that is used will be the minimum of what is requested "
-                "here and what is configured in the server. "
-                "(supported with --os-compute-api-version 2.33 or above)"
-            ),
-        )
+        pagination.add_marker_pagination_option_to_parser(parser)
         parser.add_argument(
             '--long',
             action='store_true',

openstackclient/compute/v2/keypair.py

@@ -27,6 +27,7 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -296,15 +297,7 @@ class ListKeypair(command.Lister):
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
-        parser.add_argument(
-            '--marker',
-            help=_('The last keypair ID of the previous page'),
-        )
-        parser.add_argument(
-            '--limit',
-            type=int,
-            help=_('Maximum number of keypairs to display'),
-        )
+        pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
     def take_action(self, parsed_args):