python-openstackclient 7.4.0__py3-none-any.whl → 8.1.0__py3-none-any.whl

openstackclient/tests/unit/volume/v3/test_volume_transfer_request.py

@@ -284,7 +284,7 @@ class TestTransferDelete(TestTransfer):
                 self.fail('CommandError should be raised.')
             except exceptions.CommandError as e:
                 self.assertEqual(
-                    '1 of 2 volume transfer requests failed ' 'to delete',
+                    '1 of 2 volume transfer requests failed to delete',
                     str(e),
                 )
 

openstackclient/volume/client.py

@@ -105,9 +105,7 @@ def build_option_parser(parser):
         '--os-volume-api-version',
         metavar='<volume-api-version>',
         default=utils.env('OS_VOLUME_API_VERSION'),
-        help=_(
-            'Volume API version, default=%s ' '(Env: OS_VOLUME_API_VERSION)'
-        )
+        help=_('Volume API version, default=%s (Env: OS_VOLUME_API_VERSION)')
         % DEFAULT_API_VERSION,
     )
     return parser

openstackclient/volume/v2/consistency_group.py

@@ -38,10 +38,7 @@ def _find_volumes(parsed_args_volumes, volume_client):
         except Exception as e:
             result += 1
             LOG.error(
-                _(
-                    "Failed to find volume with "
-                    "name or ID '%(volume)s':%(e)s"
-                )
+                _("Failed to find volume with name or ID '%(volume)s':%(e)s")
                 % {'volume': volume, 'e': e}
             )
 
@@ -76,7 +73,7 @@ class AddVolumeToConsistencyGroup(command.Command):
         if result > 0:
             total = len(parsed_args.volumes)
             LOG.error(
-                _("%(result)s of %(total)s volumes failed " "to add.")
+                _("%(result)s of %(total)s volumes failed to add.")
                 % {'result': result, 'total': total}
             )
 
@@ -236,8 +233,7 @@ class DeleteConsistencyGroup(command.Command):
         if result > 0:
             total = len(parsed_args.consistency_groups)
             msg = _(
-                "%(result)s of %(total)s consistency groups failed "
-                "to delete."
+                "%(result)s of %(total)s consistency groups failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -321,7 +317,7 @@ class RemoveVolumeFromConsistencyGroup(command.Command):
         if result > 0:
             total = len(parsed_args.volumes)
             LOG.error(
-                _("%(result)s of %(total)s volumes failed " "to remove.")
+                _("%(result)s of %(total)s volumes failed to remove.")
                 % {'result': result, 'total': total}
             )
 

openstackclient/volume/v2/consistency_group_snapshot.py

@@ -123,8 +123,7 @@ class ListConsistencyGroupSnapshot(command.Lister):
             '--all-projects',
             action="store_true",
             help=_(
-                'Show detail for all projects (admin only) '
-                '(defaults to False)'
+                'Show detail for all projects (admin only) (defaults to False)'
             ),
         )
         parser.add_argument(

openstackclient/volume/v2/qos_specs.py

@@ -153,8 +153,7 @@ class DeleteQos(command.Command):
         if result > 0:
             total = len(parsed_args.qos_specs)
             msg = _(
-                "%(result)s of %(total)s QoS specifications failed"
-                " to delete."
+                "%(result)s of %(total)s QoS specifications failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 

openstackclient/volume/v2/service.py

@@ -45,33 +45,34 @@ class ListService(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        service_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
+
+        columns: tuple[str, ...] = (
+            "binary",
+            "host",
+            "availability_zone",
+            "status",
+            "state",
+            "updated_at",
+        )
+        column_names: tuple[str, ...] = (
+            "Binary",
+            "Host",
+            "Zone",
+            "Status",
+            "State",
+            "Updated At",
+        )
 
         if parsed_args.long:
-            columns = [
-                "Binary",
-                "Host",
-                "Zone",
-                "Status",
-                "State",
-                "Updated At",
-                "Disabled Reason",
-            ]
-        else:
-            columns = [
-                "Binary",
-                "Host",
-                "Zone",
-                "Status",
-                "State",
-                "Updated At",
-            ]
-
-        data = service_client.services.list(
-            parsed_args.host, parsed_args.service
+            columns += ("disabled_reason",)
+            column_names += ("Disabled Reason",)
+
+        data = volume_client.services(
+            host=parsed_args.host, binary=parsed_args.service
         )
         return (
-            columns,
+            column_names,
             (
                 utils.get_item_properties(
                     s,
@@ -87,7 +88,11 @@ class SetService(command.Command):
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
-        parser.add_argument("host", metavar="<host>", help=_("Name of host"))
+        parser.add_argument(
+            "host",
+            metavar="<host>",
+            help=_("Name of host"),
+        )
         parser.add_argument(
             "service",
             metavar="<service>",
@@ -118,19 +123,17 @@ class SetService(command.Command):
             )
             raise exceptions.CommandError(msg)
 
-        service_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
+
+        service = volume_client.find_service(
+            host=parsed_args.host, service=parsed_args.service
+        )
+
         if parsed_args.enable:
-            service_client.services.enable(
-                parsed_args.host, parsed_args.service
-            )
+            service.enable(volume_client)
+
         if parsed_args.disable:
-            if parsed_args.disable_reason:
-                service_client.services.disable_log_reason(
-                    parsed_args.host,
-                    parsed_args.service,
-                    parsed_args.disable_reason,
-                )
-            else:
-                service_client.services.disable(
-                    parsed_args.host, parsed_args.service
-                )
+            service.disable(
+                volume_client,
+                reason=parsed_args.disable_reason,
+            )

openstackclient/volume/v2/volume.py

@@ -107,7 +107,7 @@ class CreateVolume(command.ShowOne):
             )
             raise exceptions.CommandError(msg)
 
-    def _get_parser(self, prog_name):
+    def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "name",
@@ -169,6 +169,7 @@ class CreateVolume(command.ShowOne):
             "--property",
             metavar="<key=value>",
             action=parseractions.KeyValueAction,
+            dest="properties",
             help=_(
                 "Set a property to this volume "
                 "(repeat option to set multiple properties)"
@@ -189,32 +190,36 @@ class CreateVolume(command.ShowOne):
         bootable_group.add_argument(
             "--bootable",
             action="store_true",
+            dest="bootable",
+            default=None,
             help=_("Mark volume as bootable"),
         )
         bootable_group.add_argument(
             "--non-bootable",
-            action="store_true",
+            action="store_false",
+            dest="bootable",
+            default=None,
             help=_("Mark volume as non-bootable (default)"),
         )
         readonly_group = parser.add_mutually_exclusive_group()
         readonly_group.add_argument(
             "--read-only",
             action="store_true",
+            dest="read_only",
+            default=None,
             help=_("Set volume to read-only access mode"),
         )
         readonly_group.add_argument(
             "--read-write",
-            action="store_true",
+            action="store_false",
+            dest="read_only",
+            default=None,
             help=_("Set volume to read-write access mode (default)"),
         )
-        return parser, source_group
-
-    def get_parser(self, prog_name):
-        parser, _ = self._get_parser(prog_name)
         return parser
 
     def take_action(self, parsed_args):
-        CreateVolume._check_size_arg(parsed_args)
+        self._check_size_arg(parsed_args)
         # size is validated in the above call to
         # _check_size_arg where we check that size
         # should be passed if we are not creating a
@@ -265,14 +270,14 @@ class CreateVolume(command.ShowOne):
             description=parsed_args.description,
             volume_type=parsed_args.type,
             availability_zone=parsed_args.availability_zone,
-            metadata=parsed_args.property,
+            metadata=parsed_args.properties,
             imageRef=image,
             source_volid=source_volume,
             consistencygroup_id=consistency_group,
             scheduler_hints=parsed_args.hint,
         )
 
-        if parsed_args.bootable or parsed_args.non_bootable:
+        if parsed_args.bootable is not None:
             try:
                 if utils.wait_for_status(
                     volume_client.volumes.get,
@@ -286,13 +291,13 @@ class CreateVolume(command.ShowOne):
                     )
                 else:
                     msg = _(
-                        "Volume status is not available for setting boot "
-                        "state"
+                        "Volume status is not available for setting boot state"
                     )
                     raise exceptions.CommandError(msg)
             except Exception as e:
                 LOG.error(_("Failed to set volume bootable property: %s"), e)
-        if parsed_args.read_only or parsed_args.read_write:
+
+        if parsed_args.read_only is not None:
             try:
                 if utils.wait_for_status(
                     volume_client.volumes.get,
@@ -312,10 +317,7 @@ class CreateVolume(command.ShowOne):
                     raise exceptions.CommandError(msg)
             except Exception as e:
                 LOG.error(
-                    _(
-                        "Failed to set volume read-only access "
-                        "mode flag: %s"
-                    ),
+                    _("Failed to set volume read-only access mode flag: %s"),
                     e,
                 )
 
@@ -356,25 +358,25 @@ class DeleteVolume(command.Command):
             "--purge",
             action="store_true",
             help=_(
-                "Remove any snapshots along with volume(s) "
-                "(defaults to False)"
+                "Remove any snapshots along with volume(s) (defaults to False)"
             ),
         )
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
         result = 0
 
-        for i in parsed_args.volumes:
+        for volume in parsed_args.volumes:
             try:
-                volume_obj = utils.find_resource(volume_client.volumes, i)
-                if parsed_args.force:
-                    volume_client.volumes.force_delete(volume_obj.id)
-                else:
-                    volume_client.volumes.delete(
-                        volume_obj.id, cascade=parsed_args.purge
-                    )
+                volume_obj = volume_client.find_volume(
+                    volume, ignore_missing=False
+                )
+                volume_client.delete_volume(
+                    volume_obj.id,
+                    force=parsed_args.force,
+                    cascade=parsed_args.purge,
+                )
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -382,12 +384,12 @@ class DeleteVolume(command.Command):
                         "Failed to delete volume with "
                         "name or ID '%(volume)s': %(e)s"
                     ),
-                    {'volume': i, 'e': e},
+                    {'volume': volume, 'e': e},
                 )
 
         if result > 0:
             total = len(parsed_args.volumes)
-            msg = _("%(result)s of %(total)s volumes failed " "to delete.") % {
+            msg = _("%(result)s of %(total)s volumes failed to delete.") % {
                 'result': result,
                 'total': total,
             }
@@ -508,7 +510,7 @@ class ListVolume(command.Lister):
         server_cache = {}
         if do_server_list:
             try:
-                compute_client = self.app.client_manager.sdk_connection.compute
+                compute_client = self.app.client_manager.compute
                 for s in compute_client.servers():
                     server_cache[s.id] = s
             except sdk_exceptions.SDKException:  # noqa: S110
@@ -627,6 +629,7 @@ class SetVolume(command.Command):
             '--property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest="properties",
             help=_(
                 'Set a property on this volume '
                 '(repeat option to set multiple properties)'
@@ -636,6 +639,7 @@ class SetVolume(command.Command):
             '--image-property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest="image_properties",
             help=_(
                 'Set an image property on this volume '
                 '(repeat option to set multiple image properties)'
@@ -712,22 +716,30 @@ class SetVolume(command.Command):
         bootable_group.add_argument(
             "--bootable",
             action="store_true",
+            dest="bootable",
+            default=None,
             help=_("Mark volume as bootable"),
         )
         bootable_group.add_argument(
             "--non-bootable",
-            action="store_true",
+            action="store_false",
+            dest="bootable",
+            default=None,
             help=_("Mark volume as non-bootable"),
         )
         readonly_group = parser.add_mutually_exclusive_group()
         readonly_group.add_argument(
             "--read-only",
             action="store_true",
+            dest="read_only",
+            default=None,
             help=_("Set volume to read-only access mode"),
         )
         readonly_group.add_argument(
             "--read-write",
-            action="store_true",
+            action="store_false",
+            dest="read_only",
+            default=None,
             help=_("Set volume to read-write access mode"),
         )
         return parser
@@ -776,28 +788,31 @@ class SetVolume(command.Command):
                 LOG.error(_("Failed to clean volume properties: %s"), e)
                 result += 1
 
-        if parsed_args.property:
+        if parsed_args.properties:
             try:
                 volume_client.volumes.set_metadata(
-                    volume.id, parsed_args.property
+                    volume.id, parsed_args.properties
                 )
             except Exception as e:
-                LOG.error(_("Failed to set volume property: %s"), e)
+                LOG.error(_("Failed to set volume properties: %s"), e)
                 result += 1
-        if parsed_args.image_property:
+
+        if parsed_args.image_properties:
             try:
                 volume_client.volumes.set_image_metadata(
-                    volume.id, parsed_args.image_property
+                    volume.id, parsed_args.image_properties
                 )
             except Exception as e:
-                LOG.error(_("Failed to set image property: %s"), e)
+                LOG.error(_("Failed to set image properties: %s"), e)
                 result += 1
+
         if parsed_args.state:
             try:
                 volume_client.volumes.reset_state(volume.id, parsed_args.state)
             except Exception as e:
                 LOG.error(_("Failed to set volume state: %s"), e)
                 result += 1
+
         if parsed_args.attached:
             try:
                 volume_client.volumes.reset_state(
@@ -806,6 +821,7 @@ class SetVolume(command.Command):
             except Exception as e:
                 LOG.error(_("Failed to set volume attach-status: %s"), e)
                 result += 1
+
         if parsed_args.detached:
             try:
                 volume_client.volumes.reset_state(
@@ -814,7 +830,8 @@ class SetVolume(command.Command):
             except Exception as e:
                 LOG.error(_("Failed to set volume attach-status: %s"), e)
                 result += 1
-        if parsed_args.bootable or parsed_args.non_bootable:
+
+        if parsed_args.bootable is not None:
             try:
                 volume_client.volumes.set_bootable(
                     volume.id, parsed_args.bootable
@@ -822,20 +839,19 @@ class SetVolume(command.Command):
             except Exception as e:
                 LOG.error(_("Failed to set volume bootable property: %s"), e)
                 result += 1
-        if parsed_args.read_only or parsed_args.read_write:
+
+        if parsed_args.read_only is not None:
             try:
                 volume_client.volumes.update_readonly_flag(
                     volume.id, parsed_args.read_only
                 )
             except Exception as e:
                 LOG.error(
-                    _(
-                        "Failed to set volume read-only access "
-                        "mode flag: %s"
-                    ),
+                    _("Failed to set volume read-only access mode flag: %s"),
                     e,
                 )
                 result += 1
+
         policy = parsed_args.migration_policy or parsed_args.retype_policy
         if parsed_args.type:
             # get the migration policy
@@ -885,7 +901,7 @@ class SetVolume(command.Command):
 
         if result > 0:
             raise exceptions.CommandError(
-                _("One or more of the " "set operations failed")
+                _("One or more of the set operations failed")
             )
 
 
@@ -936,6 +952,7 @@ class UnsetVolume(command.Command):
             '--property',
             metavar='<key>',
             action='append',
+            dest='properties',
             help=_(
                 'Remove a property from volume '
                 '(repeat option to remove multiple properties)'
@@ -945,6 +962,7 @@ class UnsetVolume(command.Command):
             '--image-property',
             metavar='<key>',
             action='append',
+            dest='image_properties',
             help=_(
                 'Remove an image property from volume '
                 '(repeat option to remove multiple image properties)'
@@ -957,25 +975,25 @@ class UnsetVolume(command.Command):
         volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
 
         result = 0
-        if parsed_args.property:
+        if parsed_args.properties:
             try:
                 volume_client.volumes.delete_metadata(
-                    volume.id, parsed_args.property
+                    volume.id, parsed_args.properties
                 )
             except Exception as e:
-                LOG.error(_("Failed to unset volume property: %s"), e)
+                LOG.error(_("Failed to unset volume properties: %s"), e)
                 result += 1
 
-        if parsed_args.image_property:
+        if parsed_args.image_properties:
             try:
                 volume_client.volumes.delete_image_metadata(
-                    volume.id, parsed_args.image_property
+                    volume.id, parsed_args.image_properties
                 )
             except Exception as e:
-                LOG.error(_("Failed to unset image property: %s"), e)
+                LOG.error(_("Failed to unset image properties: %s"), e)
                 result += 1
 
         if result > 0:
             raise exceptions.CommandError(
-                _("One or more of the " "unset operations failed")
+                _("One or more of the unset operations failed")
             )

openstackclient/volume/v2/volume_backup.py

@@ -118,7 +118,7 @@ class CreateVolumeBackup(command.ShowOne):
                 ignore_missing=False,
             ).id
 
-        columns = (
+        columns: tuple[str, ...] = (
             "id",
             "name",
             "volume_id",
@@ -240,7 +240,7 @@ class ListVolumeBackup(command.Lister):
     def take_action(self, parsed_args):
         volume_client = self.app.client_manager.sdk_connection.volume
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'name',
             'description',
@@ -249,7 +249,7 @@ class ListVolumeBackup(command.Lister):
             'is_incremental',
             'created_at',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'ID',
             'Name',
             'Description',
@@ -345,8 +345,7 @@ class RestoreVolumeBackup(command.ShowOne):
             "--force",
             action="store_true",
             help=_(
-                "Restore the backup to an existing volume "
-                "(default to False)"
+                "Restore the backup to an existing volume (default to False)"
             ),
         )
         return parser
@@ -359,7 +358,7 @@ class RestoreVolumeBackup(command.ShowOne):
             ignore_missing=False,
         )
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'volume_id',
             'volume_name',
@@ -418,13 +417,19 @@ class SetVolumeBackup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        backup = utils.find_resource(volume_client.backups, parsed_args.backup)
+        volume_client = self.app.client_manager.sdk_connection.volume
+
+        backup = volume_client.find_backup(
+            parsed_args.backup,
+            ignore_missing=False,
+        )
 
         result = 0
         if parsed_args.state:
             try:
-                volume_client.backups.reset_state(backup.id, parsed_args.state)
+                volume_client.reset_backup_status(
+                    backup, status=parsed_args.state
+                )
             except Exception as e:
                 LOG.error(_("Failed to set backup state: %s"), e)
                 result += 1
@@ -449,7 +454,7 @@ class ShowVolumeBackup(command.ShowOne):
     def take_action(self, parsed_args):
         volume_client = self.app.client_manager.sdk_connection.volume
         backup = volume_client.find_backup(parsed_args.backup)
-        columns = (
+        columns: tuple[str, ...] = (
             "availability_zone",
             "container",
             "created_at",