python-openstackclient 6.6.1__py3-none-any.whl → 7.1.0__py3-none-any.whl

openstackclient/api/image_v1.py

@@ -22,7 +22,7 @@ class APIv1(api.BaseAPI):
     _endpoint_suffix = '/v1'
 
     def __init__(self, endpoint=None, **kwargs):
-        super(APIv1, self).__init__(endpoint=endpoint, **kwargs)
+        super().__init__(endpoint=endpoint, **kwargs)
 
         self.endpoint = self.endpoint.rstrip('/')
         self._munge_url()

openstackclient/api/object_store_v1.py

@@ -13,7 +13,6 @@
 
 """Object Store v1 API Library"""
 
-import io
 import logging
 import os
 import sys
@@ -33,7 +32,7 @@ class APIv1(api.BaseAPI):
     """Object Store v1 API"""
 
     def __init__(self, **kwargs):
-        super(APIv1, self).__init__(**kwargs)
+        super().__init__(**kwargs)
 
     def container_create(
         self, container=None, public=False, storage_policy=None
@@ -257,11 +256,11 @@ class APIv1(api.BaseAPI):
         # object's name in the container.
         object_name_str = name if name else object
 
-        full_url = "%s/%s" % (
+        full_url = "{}/{}".format(
             urllib.parse.quote(container),
             urllib.parse.quote(object_name_str),
         )
-        with io.open(object, 'rb') as f:
+        with open(object, 'rb') as f:
             response = self.create(
                 full_url,
                 method='PUT',

openstackclient/common/availability_zone.py

@@ -47,7 +47,7 @@ def _xform_compute_availability_zone(az, include_extra):
             for svc, state in services.items():
                 info = copy.deepcopy(host_info)
                 info['service_name'] = svc
-                info['service_status'] = '%s %s %s' % (
+                info['service_status'] = '{} {} {}'.format(
                     'enabled' if state['active'] else 'disabled',
                     ':-)' if state['available'] else 'XXX',
                     state['updated_at'],

openstackclient/common/clientmanager.py

@@ -51,7 +51,7 @@ class ClientManager(clientmanager.ClientManager):
         api_version=None,
         pw_func=None,
     ):
-        super(ClientManager, self).__init__(
+        super().__init__(
             cli_options=cli_options,
             api_version=api_version,
             pw_func=pw_func,
@@ -94,7 +94,7 @@ class ClientManager(clientmanager.ClientManager):
             except TypeError as e:
                 self._fallback_load_auth_plugin(e)
 
-        return super(ClientManager, self).setup_auth()
+        return super().setup_auth()
 
     def _fallback_load_auth_plugin(self, e):
         # NOTES(RuiChen): Hack to avoid auth plugins choking on data they don't
@@ -116,7 +116,6 @@ class ClientManager(clientmanager.ClientManager):
 
     def is_network_endpoint_enabled(self):
         """Check if the network endpoint is enabled"""
-
         # NOTE(dtroyer): is_service_available() can also return None if
         #                there is no Service Catalog, callers here are
         #                not expecting that so fold None into True to
@@ -125,33 +124,37 @@ class ClientManager(clientmanager.ClientManager):
 
     def is_compute_endpoint_enabled(self):
         """Check if Compute endpoint is enabled"""
-
         return self.is_service_available('compute') is not False
 
-    def is_volume_endpoint_enabled(self, volume_client):
+    # TODO(stephenfin): Drop volume_client argument in OSC 8.0 or later.
+    def is_volume_endpoint_enabled(self, volume_client=None):
         """Check if volume endpoint is enabled"""
-        # NOTE(jcross): Cinder did some interesting things with their service
-        #               name so we need to figure out which version to look
-        #               for when calling is_service_available()
-        volume_version = volume_client.api_version.ver_major
-        if (
-            self.is_service_available("volumev%s" % volume_version)
-            is not False
-        ):
-            return True
-        elif self.is_service_available('volume') is not False:
-            return True
-        else:
-            return False
+        return (
+            self.is_service_available('volume') is not False
+            or self.is_service_available('volumev3') is not False
+            or self.is_service_available('volumev2') is not False
+        )
 
 
 # Plugin Support
 
 
+def _on_load_failure_callback(
+    manager: stevedore.ExtensionManager,
+    ep: importlib.metadata.EntryPoint,
+    err: Exception,
+) -> None:
+    sys.stderr.write(
+        f"WARNING: Failed to import plugin {ep.group}:{ep.name}: {err}.\n"
+    )
+
+
 def get_plugin_modules(group):
     """Find plugin entry points"""
     mod_list = []
-    mgr = stevedore.ExtensionManager(group)
+    mgr = stevedore.ExtensionManager(
+        group, on_load_failure_callback=_on_load_failure_callback
+    )
     for ep in mgr:
         LOG.debug('Found plugin %s', ep.name)
 
@@ -170,7 +173,8 @@ def get_plugin_modules(group):
             module = importlib.import_module(module_name)
         except Exception as err:
             sys.stderr.write(
-                "WARNING: Failed to import plugin %s: %s.\n" % (ep.name, err)
+                f"WARNING: Failed to import plugin {ep.group}:{ep.name}: "
+                f"{err}.\n"
             )
             continue
 

openstackclient/common/configuration.py

@@ -27,7 +27,7 @@ class ShowConfiguration(command.ShowOne):
     auth_required = False
 
     def get_parser(self, prog_name):
-        parser = super(ShowConfiguration, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         mask_group = parser.add_mutually_exclusive_group()
         mask_group.add_argument(
             "--mask",

openstackclient/common/extension.py

@@ -148,7 +148,7 @@ class ShowExtension(command.ShowOne):
     _description = _("Show API extension")
 
     def get_parser(self, prog_name):
-        parser = super(ShowExtension, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'extension',
             metavar='<extension>',

openstackclient/common/limits.py

@@ -24,11 +24,36 @@ from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
 
+def _format_absolute_limit(absolute_limits):
+    info = {}
+
+    for key in set(absolute_limits):
+        if key in ('id', 'name', 'location'):
+            continue
+
+        info[key] = absolute_limits[key]
+
+    return info
+
+
+def _format_rate_limit(rate_limits):
+    # flatten this:
+    #
+    #   {'uri': '<uri>', 'limit': [{'value': '<value>', ...], ...}
+    #
+    # to this:
+    #
+    #   {'uri': '<uri>', 'value': '<value>', ...}, ...}
+    return itertools.chain(
+        *[[{'uri': x['uri'], **y} for y in x['limit']] for x in rate_limits]
+    )
+
+
 class ShowLimits(command.Lister):
     _description = _("Show compute and block storage limits")
 
     def get_parser(self, prog_name):
-        parser = super(ShowLimits, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         type_group = parser.add_mutually_exclusive_group(required=True)
         type_group.add_argument(
             "--absolute",
@@ -42,37 +67,40 @@ class ShowLimits(command.Lister):
             dest="is_rate",
             action="store_true",
             default=False,
-            help=_("Show rate limits"),
+            help=_(
+                'Show rate limits. This is not supported by the compute '
+                'service since the 12.0.0 (Liberty) release and is only '
+                'supported by the block storage service when the '
+                'rate-limiting middleware is enabled. It is therefore a no-op '
+                'in most deployments.'
+            ),
         )
         parser.add_argument(
             "--reserved",
             dest="is_reserved",
             action="store_true",
             default=False,
-            help=_("Include reservations count [only valid with --absolute]"),
+            help=_("Include reservations count (only valid with --absolute)"),
         )
         parser.add_argument(
             '--project',
             metavar='<project>',
             help=_(
-                'Show limits for a specific project (name or ID)'
-                ' [only valid with --absolute]'
+                'Show limits for a specific project (name or ID) '
+                '(only valid with --absolute)'
             ),
         )
         parser.add_argument(
             '--domain',
             metavar='<domain>',
             help=_(
-                'Domain the project belongs to (name or ID)'
-                ' [only valid with --absolute]'
+                'Domain the project belongs to (name or ID) '
+                '(only valid with --absolute)'
             ),
         )
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
-        volume_client = self.app.client_manager.volume
-
         project_id = None
         if parsed_args.project is not None:
             identity_client = self.app.client_manager.identity
@@ -94,33 +122,32 @@ class ShowLimits(command.Lister):
         volume_limits = None
 
         if self.app.client_manager.is_compute_endpoint_enabled():
-            compute_limits = compute_client.limits.get(
-                parsed_args.is_reserved, tenant_id=project_id
+            compute_client = self.app.client_manager.sdk_connection.compute
+            compute_limits = compute_client.get_limits(
+                reserved=parsed_args.is_reserved, tenant_id=project_id
             )
 
-        if self.app.client_manager.is_volume_endpoint_enabled(volume_client):
-            volume_limits = volume_client.limits.get()
+        if self.app.client_manager.is_volume_endpoint_enabled():
+            volume_client = self.app.client_manager.sdk_connection.volume
+            volume_limits = volume_client.get_limits(
+                project_id=project_id,
+            )
 
-        data = []
         if parsed_args.is_absolute:
+            columns = ["Name", "Value"]
+            info = {}
             if compute_limits:
-                data.append(compute_limits.absolute)
+                info.update(_format_absolute_limit(compute_limits.absolute))
             if volume_limits:
-                data.append(volume_limits.absolute)
-            columns = ["Name", "Value"]
-            return (
-                columns,
-                (
-                    utils.get_item_properties(s, columns)
-                    for s in itertools.chain(*data)
-                ),
-            )
+                info.update(_format_absolute_limit(volume_limits.absolute))
 
-        elif parsed_args.is_rate:
+            return (columns, sorted(info.items(), key=lambda x: x[0]))
+        else:  # parsed_args.is_rate
+            data = []
             if compute_limits:
-                data.append(compute_limits.rate)
+                data.extend(_format_rate_limit(compute_limits.rate))
             if volume_limits:
-                data.append(volume_limits.rate)
+                data.extend(_format_rate_limit(volume_limits.rate))
             columns = [
                 "Verb",
                 "URI",
@@ -129,12 +156,18 @@ class ShowLimits(command.Lister):
                 "Unit",
                 "Next Available",
             ]
+
             return (
                 columns,
-                (
-                    utils.get_item_properties(s, columns)
-                    for s in itertools.chain(*data)
-                ),
+                [
+                    (
+                        s['verb'],
+                        s['uri'],
+                        s['value'],
+                        s['remaining'],
+                        s['unit'],
+                        s.get('next-available') or s['next_available'],
+                    )
+                    for s in data
+                ],
             )
-        else:
-            return {}, {}

openstackclient/common/module.py

@@ -29,7 +29,7 @@ class ListCommand(command.Lister):
     auth_required = False
 
     def get_parser(self, prog_name):
-        parser = super(ListCommand, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--group',
             metavar='<group-keyword>',
@@ -72,7 +72,7 @@ class ListModule(command.ShowOne):
     auth_required = False
 
     def get_parser(self, prog_name):
-        parser = super(ListModule, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--all',
             action='store_true',
@@ -113,6 +113,6 @@ class ListModule(command.ShowOne):
                             data[k] = mods[k].__version__
                     except Exception:
                         # Catch all exceptions, just skip it
-                        pass
+                        pass  # nosec: B110
 
         return zip(*sorted(data.items()))

openstackclient/common/progressbar.py

@@ -16,7 +16,7 @@
 import sys
 
 
-class _ProgressBarBase(object):
+class _ProgressBarBase:
     """A progress bar provider for a wrapped object.
 
     Base abstract class used by specific class wrapper to show
@@ -39,7 +39,7 @@ class _ProgressBarBase(object):
             self._percent += size_read / self._totalsize
             # Output something like this: [==========>             ] 49%
             sys.stdout.write(
-                '\r[{0:<30}] {1:.0%}'.format(
+                '\r[{:<30}] {:.0%}'.format(
                     '=' * int(round(self._percent * 29)) + '>', self._percent
                 )
             )

openstackclient/common/project_cleanup.py

@@ -46,7 +46,7 @@ class ProjectCleanup(command.Command):
     _description = _("Clean resources associated with a project")
 
     def get_parser(self, prog_name):
-        parser = super(ProjectCleanup, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         action_group = parser.add_mutually_exclusive_group()
         action_group.add_argument(
             '--dry-run',
@@ -150,5 +150,8 @@ class ProjectCleanup(command.Command):
             self.log.warning(_('Deleting resources'))
 
             project_connect.project_cleanup(
-                dry_run=False, status_queue=status_queue, filters=filters
+                dry_run=False,
+                status_queue=status_queue,
+                filters=filters,
+                skip_resources=parsed_args.skip_resource,
             )