python-openstackclient 8.3.0__py3-none-any.whl → 10.0.0__py3-none-any.whl

openstackclient/volume/v2/consistency_group_snapshot.py

@@ -14,7 +14,10 @@
 
 """Volume v2 consistency group snapshot action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -29,7 +32,7 @@ LOG = logging.getLogger(__name__)
 class CreateConsistencyGroupSnapshot(command.ShowOne):
     _description = _("Create new consistency group snapshot.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "snapshot_name",
@@ -52,7 +55,9 @@ class CreateConsistencyGroupSnapshot(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         volume_client = self.app.client_manager.volume
         consistency_group = parsed_args.consistency_group
         if not parsed_args.consistency_group:
@@ -68,13 +73,16 @@ class CreateConsistencyGroupSnapshot(command.ShowOne):
             description=parsed_args.description,
         )
 
-        return zip(*sorted(consistency_group_snapshot._info.items()))
+        col_headers, col_data = zip(
+            *sorted(consistency_group_snapshot._info.items())
+        )
+        return col_headers, col_data
 
 
 class DeleteConsistencyGroupSnapshot(command.Command):
     _description = _("Delete consistency group snapshot(s).")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "consistency_group_snapshot",
@@ -84,7 +92,7 @@ class DeleteConsistencyGroupSnapshot(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         result = 0
 
@@ -101,8 +109,8 @@ class DeleteConsistencyGroupSnapshot(command.Command):
                     _(
                         "Failed to delete consistency group snapshot "
                         "with name or ID '%(snapshot)s': %(e)s"
-                    )
-                    % {'snapshot': snapshot, 'e': e}
+                    ),
+                    {'snapshot': snapshot, 'e': e},
                 )
 
         if result > 0:
@@ -117,7 +125,7 @@ class DeleteConsistencyGroupSnapshot(command.Command):
 class ListConsistencyGroupSnapshot(command.Lister):
     _description = _("List consistency group snapshots.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--all-projects',
@@ -153,7 +161,9 @@ class ListConsistencyGroupSnapshot(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         if parsed_args.long:
             columns = [
                 'ID',
@@ -194,7 +204,7 @@ class ListConsistencyGroupSnapshot(command.Lister):
 class ShowConsistencyGroupSnapshot(command.ShowOne):
     _description = _("Display consistency group snapshot details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "consistency_group_snapshot",
@@ -203,9 +213,14 @@ class ShowConsistencyGroupSnapshot(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         volume_client = self.app.client_manager.volume
         consistency_group_snapshot = utils.find_resource(
             volume_client.cgsnapshots, parsed_args.consistency_group_snapshot
         )
-        return zip(*sorted(consistency_group_snapshot._info.items()))
+        col_headers, col_data = zip(
+            *sorted(consistency_group_snapshot._info.items())
+        )
+        return col_headers, col_data

openstackclient/volume/v2/qos_specs.py

@@ -15,7 +15,10 @@
 
 """Volume v2 QoS action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -32,7 +35,7 @@ LOG = logging.getLogger(__name__)
 class AssociateQos(command.Command):
     _description = _("Associate a QoS specification to a volume type")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'qos_spec',
@@ -46,7 +49,7 @@ class AssociateQos(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         qos_spec = utils.find_resource(
             volume_client.qos_specs, parsed_args.qos_spec
@@ -61,7 +64,7 @@ class AssociateQos(command.Command):
 class CreateQos(command.ShowOne):
     _description = _("Create new QoS specification")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'name',
@@ -93,7 +96,9 @@ class CreateQos(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         volume_client = self.app.client_manager.volume
         specs = {}
         specs.update({'consumer': parsed_args.consumer})
@@ -110,13 +115,14 @@ class CreateQos(command.ShowOne):
                 )
             }
         )
-        return zip(*sorted(qos_spec._info.items()))
+        col_headers, col_data = zip(*sorted(qos_spec._info.items()))
+        return col_headers, col_data
 
 
 class DeleteQos(command.Command):
     _description = _("Delete QoS specification")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'qos_specs',
@@ -132,7 +138,7 @@ class DeleteQos(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         result = 0
 
@@ -146,8 +152,8 @@ class DeleteQos(command.Command):
                     _(
                         "Failed to delete QoS specification with "
                         "name or ID '%(qos)s': %(e)s"
-                    )
-                    % {'qos': i, 'e': e}
+                    ),
+                    {'qos': i, 'e': e},
                 )
 
         if result > 0:
@@ -161,7 +167,7 @@ class DeleteQos(command.Command):
 class DisassociateQos(command.Command):
     _description = _("Disassociate a QoS specification from a volume type")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'qos_spec',
@@ -183,7 +189,7 @@ class DisassociateQos(command.Command):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         qos_spec = utils.find_resource(
             volume_client.qos_specs, parsed_args.qos_spec
@@ -201,7 +207,9 @@ class DisassociateQos(command.Command):
 class ListQos(command.Lister):
     _description = _("List QoS specifications")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         volume_client = self.app.client_manager.volume
         qos_specs_list = volume_client.qos_specs.list()
 
@@ -249,7 +257,7 @@ class ListQos(command.Lister):
 class SetQos(command.Command):
     _description = _("Set QoS specification properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'qos_spec',
@@ -277,7 +285,7 @@ class SetQos(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         qos_spec = utils.find_resource(
             volume_client.qos_specs, parsed_args.qos_spec
@@ -311,7 +319,7 @@ class SetQos(command.Command):
 class ShowQos(command.ShowOne):
     _description = _("Display QoS specification details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'qos_spec',
@@ -320,7 +328,9 @@ class ShowQos(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         volume_client = self.app.client_manager.volume
         qos_spec = utils.find_resource(
             volume_client.qos_specs, parsed_args.qos_spec
@@ -342,13 +352,14 @@ class ShowQos(command.ShowOne):
             }
         )
 
-        return zip(*sorted(qos_spec._info.items()))
+        col_headers, col_data = zip(*sorted(qos_spec._info.items()))
+        return col_headers, col_data
 
 
 class UnsetQos(command.Command):
     _description = _("Unset QoS specification properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'qos_spec',
@@ -367,7 +378,7 @@ class UnsetQos(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         qos_spec = utils.find_resource(
             volume_client.qos_specs, parsed_args.qos_spec

openstackclient/volume/v2/service.py

@@ -14,6 +14,11 @@
 
 """Service action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -24,7 +29,7 @@ from openstackclient.i18n import _
 class ListService(command.Lister):
     _description = _("List service command")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--host",
@@ -44,8 +49,12 @@ class ListService(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '2'
+        )
 
         columns: tuple[str, ...] = (
             "binary",
@@ -86,7 +95,7 @@ class ListService(command.Lister):
 class SetService(command.Command):
     _description = _("Set volume service properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "host",
@@ -115,7 +124,7 @@ class SetService(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         if parsed_args.disable_reason and not parsed_args.disable:
             msg = _(
                 "Cannot specify option --disable-reason without "
@@ -123,7 +132,9 @@ class SetService(command.Command):
             )
             raise exceptions.CommandError(msg)
 
-        volume_client = self.app.client_manager.sdk_connection.volume
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '2'
+        )
 
         service = volume_client.find_service(
             parsed_args.service, ignore_missing=False, host=parsed_args.host

openstackclient/volume/v2/volume.py

@@ -18,11 +18,13 @@ import argparse
 import copy
 import functools
 import logging
-import typing as ty
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from cliff import columns as cliff_columns
 from openstack.block_storage.v2 import volume as _volume
 from openstack import exceptions as sdk_exceptions
+from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib import exceptions
@@ -43,14 +45,20 @@ class KeyValueHintAction(argparse.Action):
 
     APPEND_KEYS = ('same_host', 'different_host')
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
         self._key_value_action = parseractions.KeyValueAction(*args, **kwargs)
         self._key_value_append_action = parseractions.KeyValueAppendAction(
             *args, **kwargs
         )
         super().__init__(*args, **kwargs)
 
-    def __call__(self, parser, namespace, values, option_string=None):
+    def __call__(
+        self,
+        parser: argparse.ArgumentParser,
+        namespace: argparse.Namespace,
+        values: Any,
+        option_string: str | None = None,
+    ) -> None:
         if values.startswith(self.APPEND_KEYS):
             self._key_value_append_action(
                 parser, namespace, values, option_string=option_string
@@ -61,7 +69,7 @@ class KeyValueHintAction(argparse.Action):
             )
 
 
-class AttachmentsColumn(cliff_columns.FormattableColumn[list[ty.Any]]):
+class AttachmentsColumn(cliff_columns.FormattableColumn[list[Any]]):
     """Formattable column for attachments column.
 
     Unlike the parent FormattableColumn class, the initializer of the
@@ -72,11 +80,13 @@ class AttachmentsColumn(cliff_columns.FormattableColumn[list[ty.Any]]):
     ``functools.partial(AttachmentsColumn, server_cache)``.
     """
 
-    def __init__(self, value, server_cache=None):
+    def __init__(
+        self, value: list[Any], server_cache: dict[str, Any] | None = None
+    ) -> None:
         super().__init__(value)
         self._server_cache = server_cache or {}
 
-    def human_readable(self):
+    def human_readable(self) -> str:
         """Return a formatted string of a volume's attached instances
 
         :rtype: a string of formatted instances
@@ -92,7 +102,7 @@ class AttachmentsColumn(cliff_columns.FormattableColumn[list[ty.Any]]):
         return msg
 
 
-def _format_volume(volume: _volume.Volume) -> dict[str, ty.Any]:
+def _format_volume(volume: _volume.Volume) -> dict[str, Any]:
     # Some columns returned by openstacksdk should not be shown because they're
     # either irrelevant or duplicates
     ignored_columns = {
@@ -137,7 +147,7 @@ class CreateVolume(command.ShowOne):
     _description = _("Create new volume")
 
     @staticmethod
-    def _check_size_arg(args):
+    def _check_size_arg(args: argparse.Namespace) -> None:
         """Check whether --size option is required or not.
 
         Require size parameter only in case when snapshot or source
@@ -151,7 +161,7 @@ class CreateVolume(command.ShowOne):
             )
             raise exceptions.CommandError(msg)
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "name",
@@ -262,7 +272,9 @@ class CreateVolume(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         self._check_size_arg(parsed_args)
         # size is validated in the above call to
         # _check_size_arg where we check that size
@@ -270,7 +282,9 @@ class CreateVolume(command.ShowOne):
         # volume from snapshot or source volume
         size = parsed_args.size
 
-        volume_client = self.app.client_manager.sdk_connection.volume
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '2'
+        )
         image_client = self.app.client_manager.image
 
         source_volume = None
@@ -366,13 +380,14 @@ class CreateVolume(command.ShowOne):
                 )
 
         data = _format_volume(volume)
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class DeleteVolume(command.Command):
     _description = _("Delete volume(s)")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "volumes",
@@ -390,16 +405,25 @@ class DeleteVolume(command.Command):
             ),
         )
         group.add_argument(
-            "--purge",
+            "--cascade",
             action="store_true",
             help=_(
                 "Remove any snapshots along with volume(s) (defaults to False)"
             ),
         )
+        group.add_argument(
+            # now called "cascade", accept old arg for compatibility
+            "--purge",
+            action="store_true",
+            help=argparse.SUPPRESS,
+            dest='cascade',
+        )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '2'
+        )
         result = 0
 
         for volume in parsed_args.volumes:
@@ -410,7 +434,7 @@ class DeleteVolume(command.Command):
                 volume_client.delete_volume(
                     volume_obj.id,
                     force=parsed_args.force,
-                    cascade=parsed_args.purge,
+                    cascade=parsed_args.cascade,
                 )
             except Exception as e:
                 result += 1
@@ -434,7 +458,7 @@ class DeleteVolume(command.Command):
 class ListVolume(command.Lister):
     _description = _("List volumes")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--project',
@@ -473,7 +497,9 @@ class ListVolume(command.Lister):
         pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         volume_client = self.app.client_manager.volume
         identity_client = self.app.client_manager.identity
 
@@ -548,7 +574,7 @@ class ListVolume(command.Lister):
                 compute_client = self.app.client_manager.compute
                 for s in compute_client.servers():
                     server_cache[s.id] = s
-            except sdk_exceptions.SDKException:  # noqa: S110
+            except sdk_exceptions.SDKException:
                 # Just forget it if there's any trouble
                 pass
         AttachmentsColumnWithCache = functools.partial(
@@ -578,7 +604,7 @@ class ListVolume(command.Lister):
 class MigrateVolume(command.Command):
     _description = _("Migrate volume to a new host")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
@@ -612,8 +638,11 @@ class MigrateVolume(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '2'
+        )
+
         volume = volume_client.find_volume(
             parsed_args.volume, ignore_missing=False
         )
@@ -628,7 +657,7 @@ class MigrateVolume(command.Command):
 class SetVolume(command.Command):
     _description = _("Set volume properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
@@ -781,7 +810,7 @@ class SetVolume(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
 
@@ -910,12 +939,12 @@ class SetVolume(command.Command):
         elif policy:
             # If the "--migration-policy" is specified without "--type"
             LOG.warning(
-                _("'%s' option will not work without '--type' option")
-                % (
+                _("'%s' option will not work without '--type' option"),
+                (
                     '--migration-policy'
                     if parsed_args.migration_policy
                     else '--retype-policy'
-                )
+                ),
             )
 
         kwargs = {}
@@ -945,7 +974,7 @@ class SetVolume(command.Command):
 class ShowVolume(command.ShowOne):
     _description = _("Display volume details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
@@ -954,20 +983,26 @@ class ShowVolume(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '2'
+        )
+
         volume = volume_client.find_volume(
             parsed_args.volume, ignore_missing=False
         )
 
         data = _format_volume(volume)
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class UnsetVolume(command.Command):
     _description = _("Unset volume properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'volume',
@@ -996,7 +1031,7 @@ class UnsetVolume(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         volume = utils.find_resource(volume_client.volumes, parsed_args.volume)