python-openstackclient 7.1.3__py3-none-any.whl → 7.2.0__py3-none-any.whl

openstackclient/api/api.py

@@ -12,6 +12,7 @@
 #
 
 """Base API Library"""
+
 from keystoneauth1 import exceptions as ks_exceptions
 from keystoneauth1 import session as ks_session
 from osc_lib import exceptions
@@ -306,7 +307,7 @@ class BaseAPI(KeystoneSession):
         except ks_exceptions.NotFound:
             kwargs = {attr: value}
             try:
-                ret = self.find_one("/%s/detail" % (path), **kwargs)
+                ret = self.find_one(f"/{path}/detail", **kwargs)
             except ks_exceptions.NotFound:
                 msg = _("%s not found") % value
                 raise exceptions.NotFound(msg)

openstackclient/api/image_v2.py

@@ -33,7 +33,7 @@ class APIv2(image_v1.APIv1):
         private=False,
         community=False,
         shared=False,
-        **filter
+        **filter,
     ):
         """Get available images
 

openstackclient/api/object_store_v1.py

@@ -89,7 +89,7 @@ class APIv1(api.BaseAPI):
         marker=None,
         end_marker=None,
         prefix=None,
-        **params
+        **params,
     ):
         """Get containers in an account
 
@@ -116,7 +116,7 @@ class APIv1(api.BaseAPI):
                 marker=marker,
                 end_marker=end_marker,
                 prefix=prefix,
-                **params
+                **params,
             )
             while listing:
                 marker = listing[-1]['name']
@@ -125,7 +125,7 @@ class APIv1(api.BaseAPI):
                     marker=marker,
                     end_marker=end_marker,
                     prefix=prefix,
-                    **params
+                    **params,
                 )
                 if listing:
                     data.extend(listing)
@@ -256,10 +256,7 @@ class APIv1(api.BaseAPI):
         # object's name in the container.
         object_name_str = name if name else object
 
-        full_url = "{}/{}".format(
-            urllib.parse.quote(container),
-            urllib.parse.quote(object_name_str),
-        )
+        full_url = f"{urllib.parse.quote(container)}/{urllib.parse.quote(object_name_str)}"
         with open(object, 'rb') as f:
             response = self.create(
                 full_url,
@@ -293,8 +290,7 @@ class APIv1(api.BaseAPI):
             return
 
         self.delete(
-            "%s/%s"
-            % (urllib.parse.quote(container), urllib.parse.quote(object))
+            f"{urllib.parse.quote(container)}/{urllib.parse.quote(object)}"
         )
 
     def object_list(
@@ -306,7 +302,7 @@ class APIv1(api.BaseAPI):
         end_marker=None,
         delimiter=None,
         prefix=None,
-        **params
+        **params,
     ):
         """List objects in a container
 
@@ -341,7 +337,7 @@ class APIv1(api.BaseAPI):
                 end_marker=end_marker,
                 prefix=prefix,
                 delimiter=delimiter,
-                **params
+                **params,
             )
             while listing:
                 if delimiter:
@@ -355,7 +351,7 @@ class APIv1(api.BaseAPI):
                     end_marker=end_marker,
                     prefix=prefix,
                     delimiter=delimiter,
-                    **params
+                    **params,
                 )
                 if listing:
                     data.extend(listing)
@@ -395,8 +391,7 @@ class APIv1(api.BaseAPI):
 
         response = self._request(
             'GET',
-            "%s/%s"
-            % (urllib.parse.quote(container), urllib.parse.quote(object)),
+            f"{urllib.parse.quote(container)}/{urllib.parse.quote(object)}",
             stream=True,
         )
         if response.status_code == 200:
@@ -431,8 +426,7 @@ class APIv1(api.BaseAPI):
         headers = self._set_properties(properties, 'X-Object-Meta-%s')
         if headers:
             self.create(
-                "%s/%s"
-                % (urllib.parse.quote(container), urllib.parse.quote(object)),
+                f"{urllib.parse.quote(container)}/{urllib.parse.quote(object)}",
                 headers=headers,
             )
 
@@ -455,8 +449,7 @@ class APIv1(api.BaseAPI):
         headers = self._unset_properties(properties, 'X-Remove-Object-Meta-%s')
         if headers:
             self.create(
-                "%s/%s"
-                % (urllib.parse.quote(container), urllib.parse.quote(object)),
+                f"{urllib.parse.quote(container)}/{urllib.parse.quote(object)}",
                 headers=headers,
             )
 
@@ -480,8 +473,7 @@ class APIv1(api.BaseAPI):
 
         response = self._request(
             'HEAD',
-            "%s/%s"
-            % (urllib.parse.quote(container), urllib.parse.quote(object)),
+            f"{urllib.parse.quote(container)}/{urllib.parse.quote(object)}",
         )
 
         data = {

openstackclient/common/clientmanager.py

@@ -101,7 +101,7 @@ class ClientManager(clientmanager.ClientManager):
         #                 expect, delete fake token and endpoint, then try to
         #                 load auth plugin again with user specified options.
         #                 We know it looks ugly, but it's necessary.
-        if self._cli_options.config['auth']['token'] == 'x':
+        if self._cli_options.config['auth']['token'] == 'x':  # noqa: S105
             # restore original auth_type
             self._cli_options.config['auth_type'] = self._original_auth_type
             del self._cli_options.config['auth']['token']

openstackclient/common/module.py

@@ -111,8 +111,8 @@ class ListModule(command.ShowOne):
                             data[k] = mods[k].version.__version__
                         else:
                             data[k] = mods[k].__version__
-                    except Exception:
+                    except Exception:  # noqa: S110
                         # Catch all exceptions, just skip it
-                        pass  # nosec: B110
+                        pass
 
         return zip(*sorted(data.items()))

openstackclient/common/quota.py

@@ -176,7 +176,7 @@ def get_network_quotas(
     default=False,
 ):
     def _network_quota_to_dict(network_quota, detail=False):
-        if type(network_quota) is not dict:
+        if not isinstance(network_quota, dict):
             dict_quota = network_quota.to_dict()
         else:
             dict_quota = network_quota
@@ -507,8 +507,8 @@ class SetQuota(common.NetDetectionMixin, command.Command):
         )
         for k, v, h in self._build_options_list():
             parser.add_argument(
-                '--%s' % v,
-                metavar='<%s>' % v,
+                f'--{v}',
+                metavar=f'<{v}>',
                 dest=k,
                 type=int,
                 help=h,
@@ -590,7 +590,7 @@ class SetQuota(common.NetDetectionMixin, command.Command):
                         parsed_args.volume_type
                         and k in IMPACT_VOLUME_TYPE_QUOTAS
                     ):
-                        k = k + '_%s' % parsed_args.volume_type
+                        k = k + f'_{parsed_args.volume_type}'
                     volume_kwargs[k] = value
 
         if self.app.client_manager.is_network_endpoint_enabled():

openstackclient/compute/v2/flavor.py

@@ -577,7 +577,7 @@ class UnsetFlavor(command.Command):
                 parsed_args.flavor, get_extra_specs=True, ignore_missing=False
             )
         except sdk_exceptions.ResourceNotFound as e:
-            raise exceptions.CommandError(_(e.message))
+            raise exceptions.CommandError(e.message)
 
         result = 0
         if parsed_args.properties:

openstackclient/compute/v2/server.py

@@ -670,7 +670,7 @@ class AddNetwork(command.Command):
 
 
 class AddServerSecurityGroup(command.Command):
-    _description = _("Add security group to server")
+    _description = _("Add security group(s) to server")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -680,9 +680,13 @@ class AddServerSecurityGroup(command.Command):
             help=_('Server (name or ID)'),
         )
         parser.add_argument(
-            'group',
-            metavar='<group>',
-            help=_('Security group to add (name or ID)'),
+            'security_groups',
+            metavar='<security-group>',
+            nargs='+',
+            help=_(
+                'Security group(s) to add to the server (name or ID) '
+                '(repeat option to add multiple groups)'
+            ),
         )
         return parser
 
@@ -694,14 +698,43 @@ class AddServerSecurityGroup(command.Command):
         )
         if self.app.client_manager.is_network_endpoint_enabled():
             # the server handles both names and IDs for neutron SGs, so just
-            # pass things through
-            security_group = parsed_args.group
+            # pass things through if using neutron
+            security_groups = parsed_args.security_groups
         else:
-            # however, if using nova-network then it needs a name, not an ID
-            security_group = compute_v2.find_security_group(
-                compute_client, parsed_args.group
-            )['name']
-        compute_client.add_security_group_to_server(server, security_group)
+            # however, if using nova-network then it needs names, not IDs
+            security_groups = []
+            for security_group in parsed_args.security_groups:
+                security_groups.append(
+                    compute_v2.find_security_group(
+                        compute_client, security_group
+                    )['name']
+                )
+
+        errors = 0
+        for security_group in security_groups:
+            try:
+                compute_client.add_security_group_to_server(
+                    server, security_group
+                )
+            except sdk_exceptions.HttpException as e:
+                errors += 1
+                LOG.error(
+                    _(
+                        "Failed to add security group with name or ID "
+                        "'%(security_group)s' to server '%(server)s': %(e)s"
+                    ),
+                    {
+                        'security_group': security_group,
+                        'server': server.id,
+                        'e': e,
+                    },
+                )
+
+        if errors > 0:
+            msg = _(
+                "%(errors)d of %(total)d security groups were not added."
+            ) % {'errors': errors, 'total': len(security_groups)}
+            raise exceptions.CommandError(msg)
 
 
 class AddServerVolume(command.ShowOne):
@@ -1328,6 +1361,7 @@ class CreateServer(command.ShowOne):
             metavar='<security-group>',
             action='append',
             default=[],
+            dest='security_groups',
             help=_(
                 'Security group to assign to this server (name or ID) '
                 '(repeat option to set multiple groups)'
@@ -1504,7 +1538,7 @@ class CreateServer(command.ShowOne):
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute
@@ -1520,17 +1554,6 @@ class CreateServer(command.ShowOne):
 
         if not image and parsed_args.image_properties:
 
-            def emit_duplicated_warning(img):
-                img_uuid_list = [str(image.id) for image in img]
-                LOG.warning(
-                    'Multiple matching images: %(img_uuid_list)s\n'
-                    'Using image: %(chosen_one)s',
-                    {
-                        'img_uuid_list': img_uuid_list,
-                        'chosen_one': img_uuid_list[0],
-                    },
-                )
-
             def _match_image(image_api, wanted_properties):
                 image_list = image_api.images()
                 images_matched = []
@@ -1568,7 +1591,15 @@ class CreateServer(command.ShowOne):
 
             images = _match_image(image_client, parsed_args.image_properties)
             if len(images) > 1:
-                emit_duplicated_warning(images, parsed_args.image_properties)
+                img_uuid_list = [str(image.id) for image in images]
+                LOG.warning(
+                    'Multiple matching images: %(img_uuid_list)s\n'
+                    'Using image: %(chosen_one)s',
+                    {
+                        'img_uuid_list': img_uuid_list,
+                        'chosen_one': img_uuid_list[0],
+                    },
+                )
             if images:
                 image = images[0]
             else:
@@ -1948,21 +1979,22 @@ class CreateServer(command.ShowOne):
             # 'auto' to maintain legacy behavior if a nic wasn't specified.
             networks = 'auto'
 
-        # Check security group exist and convert ID to name
+        # Check security group(s) exist and convert ID to name
         security_groups = []
         if self.app.client_manager.is_network_endpoint_enabled():
             network_client = self.app.client_manager.network
-            for each_sg in parsed_args.security_group:
+            for security_group in parsed_args.security_groups:
                 sg = network_client.find_security_group(
-                    each_sg, ignore_missing=False
+                    security_group, ignore_missing=False
                 )
                 # Use security group ID to avoid multiple security group have
                 # same name in neutron networking backend
                 security_groups.append({'name': sg.id})
-        else:
-            # Handle nova-network case
-            for each_sg in parsed_args.security_group:
-                sg = compute_v2.find_security_group(compute_client, each_sg)
+        else:  # nova-network
+            for security_group in parsed_args.security_groups:
+                sg = compute_v2.find_security_group(
+                    compute_client, security_group
+                )
                 security_groups.append({'name': sg['name']})
 
         hints = {}
@@ -2189,7 +2221,7 @@ class DeleteServer(command.Command):
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute
@@ -2915,10 +2947,10 @@ class ListServer(command.Lister):
                 for image_id in image_ids:
                     try:
                         images[image_id] = image_client.get_image(image_id)
-                    except Exception:
+                    except Exception:  # noqa: S110
                         # retrieving image names is not crucial, so we swallow
                         # any exceptions
-                        pass  # nosec: B110
+                        pass
             else:
                 try:
                     # some deployments can have *loads* of images so we only
@@ -2936,10 +2968,10 @@ class ListServer(command.Lister):
                     )
                     for i in images_list:
                         images[i.id] = i
-                except Exception:
+                except Exception:  # noqa: S110
                     # retrieving image names is not crucial, so we swallow any
                     # exceptions
-                    pass  # nosec: B110
+                    pass
 
             # create a dict that maps flavor_id to flavor object, which is used
             # to display the "Flavor Name" column. Note that 'flavor.id' is not
@@ -2955,19 +2987,19 @@ class ListServer(command.Lister):
                         flavors[f_id] = compute_client.find_flavor(
                             f_id, ignore_missing=False
                         )
-                    except Exception:
+                    except Exception:  # noqa: S110
                         # retrieving flavor names is not crucial, so we swallow
                         # any exceptions
-                        pass  # nosec: B110
+                        pass
             else:
                 try:
                     flavors_list = compute_client.flavors(is_public=None)
                     for i in flavors_list:
                         flavors[i.id] = i
-                except Exception:
+                except Exception:  # noqa: S110
                     # retrieving flavor names is not crucial, so we swallow any
                     # exceptions
-                    pass  # nosec: B110
+                    pass
 
         # Populate image_name, image_id, flavor_name and flavor_id attributes
         # of server objects so that we can display those columns.
@@ -3198,7 +3230,7 @@ revert to release the new server and restart the old one."""
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute
@@ -3350,7 +3382,7 @@ class RebootServer(command.Command):
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute
@@ -3555,7 +3587,7 @@ class RebuildServer(command.ShowOne):
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute
@@ -3816,7 +3848,7 @@ host."""
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute
@@ -4017,9 +4049,13 @@ class RemoveServerSecurityGroup(command.Command):
             help=_('Server (name or ID)'),
         )
         parser.add_argument(
-            'group',
-            metavar='<group>',
-            help=_('Security group to remove (name or ID)'),
+            'security_groups',
+            metavar='<security-group>',
+            nargs='+',
+            help=_(
+                'Security group(s) to remove from server (name or ID) '
+                '(repeat option to remove multiple groups)'
+            ),
         )
         return parser
 
@@ -4032,15 +4068,42 @@ class RemoveServerSecurityGroup(command.Command):
         if self.app.client_manager.is_network_endpoint_enabled():
             # the server handles both names and IDs for neutron SGs, so just
             # pass things through
-            security_group = parsed_args.group
+            security_groups = parsed_args.security_groups
         else:
-            # however, if using nova-network then it needs a name, not an ID
-            security_group = compute_v2.find_security_group(
-                compute_client, parsed_args.group
-            )['name']
-        compute_client.remove_security_group_from_server(
-            server, security_group
-        )
+            # however, if using nova-network then it needs names, not IDs
+            security_groups = []
+            for security_group in parsed_args.security_groups:
+                security_groups.append(
+                    compute_v2.find_security_group(
+                        compute_client, security_group
+                    )['name']
+                )
+
+        errors = 0
+        for security_group in security_groups:
+            try:
+                compute_client.remove_security_group_from_server(
+                    server, security_group
+                )
+            except sdk_exceptions.HttpException as e:
+                errors += 1
+                LOG.error(
+                    _(
+                        "Failed to remove security group with name or ID "
+                        "'%(security_group)s' from server '%(server)s': %(e)s"
+                    ),
+                    {
+                        'security_group': security_group,
+                        'server': server.id,
+                        'e': e,
+                    },
+                )
+
+        if errors > 0:
+            msg = _(
+                "%(errors)d of %(total)d security groups were not removed."
+            ) % {'errors': errors, 'total': len(security_groups)}
+            raise exceptions.CommandError(msg)
 
 
 class RemoveServerVolume(command.Command):
@@ -4188,7 +4251,7 @@ release the new server and restart the old one."""
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute
@@ -4584,7 +4647,7 @@ class ShelveServer(command.Command):
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute
@@ -4872,7 +4935,7 @@ class SshServer(command.Command):
         LOG.debug(f"ssh command: {cmd}")
         # we intentionally pass through user-provided arguments and run this in
         # the user's shell
-        os.system(cmd)  # nosec: B605
+        os.system(cmd)  # noqa: S605
 
 
 class StartServer(command.Command):
@@ -5181,7 +5244,7 @@ class UnshelveServer(command.Command):
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute

openstackclient/compute/v2/server_backup.py

@@ -68,7 +68,7 @@ class CreateServerBackup(command.ShowOne):
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stderr.write('\rProgress: %s' % progress)
+                self.app.stderr.write(f'\rProgress: {progress}')
                 self.app.stderr.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute

openstackclient/compute/v2/server_image.py

@@ -69,7 +69,7 @@ class CreateServerImage(command.ShowOne):
     def take_action(self, parsed_args):
         def _show_progress(progress):
             if progress:
-                self.app.stdout.write('\rProgress: %s' % progress)
+                self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.sdk_connection.compute

openstackclient/compute/v2/server_migration.py

@@ -253,8 +253,17 @@ def _get_migration_by_uuid(compute_client, server_id, migration_uuid):
         if migration.uuid == migration_uuid:
             return migration
     else:
-        msg = _('In-progress live migration %s is not found for server %s.')
-        raise exceptions.CommandError(msg % (migration_uuid, server_id))
+        msg = _(
+            'In-progress live migration %(migration)s is not found for '
+            'server %(server)s'
+        )
+        raise exceptions.CommandError(
+            msg
+            % {
+                'migration': migration_uuid,
+                'server': server_id,
+            }
+        )
 
 
 class ShowMigration(command.ShowOne):

openstackclient/compute/v2/usage.py

@@ -60,7 +60,7 @@ class CountColumn(cliff_columns.FormattableColumn):
 
 class FloatColumn(cliff_columns.FormattableColumn):
     def human_readable(self):
-        return float("%.2f" % self._value)
+        return float(f"{self._value:.2f}")
 
 
 def _formatters(project_cache):
@@ -180,9 +180,9 @@ class ListUsage(command.Lister):
         try:
             for p in self.app.client_manager.identity.projects.list():
                 project_cache[p.id] = p
-        except Exception:
+        except Exception:  # noqa: S110
             # Just forget it if there's any trouble
-            pass  # nosec: B110
+            pass
 
         if parsed_args.formatter == 'table' and len(usage_list) > 0:
             self.app.stdout.write(

openstackclient/identity/common.py

@@ -34,7 +34,7 @@ def find_service_in_list(service_list, service_id):
         if service.id == service_id:
             return service
     raise exceptions.CommandError(
-        "No service with a type, name or ID of '%s' exists." % service_id
+        f"No service with a type, name or ID of '{service_id}' exists."
     )
 
 

openstackclient/identity/v2_0/project.py

@@ -87,7 +87,7 @@ class CreateProject(command.ShowOne):
                 parsed_args.name,
                 description=parsed_args.description,
                 enabled=enabled,
-                **kwargs
+                **kwargs,
             )
         except ks_exc.Conflict:
             if parsed_args.or_show:

openstackclient/identity/v2_0/role_assignment.py

@@ -11,7 +11,7 @@
 #   under the License.
 #
 
-"""Identity v2 Assignment action implementations """
+"""Identity v2 Assignment action implementations"""
 
 from osc_lib.command import command
 from osc_lib import exceptions

openstackclient/identity/v2_0/user.py

@@ -250,9 +250,9 @@ class ListUser(command.Lister):
             try:
                 for p in identity_client.tenants.list():
                     project_cache[p.id] = p
-            except Exception:
+            except Exception:  # noqa: S110
                 # Just forget it if there's any trouble
-                pass  # nosec: B110
+                pass
             formatters['tenantId'] = functools.partial(
                 ProjectColumn, project_cache=project_cache
             )