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

openstackclient/volume/v3/block_storage_log_level.py

@@ -14,6 +14,9 @@
 
 """Block Storage Service action implementations"""
 
+import argparse
+from typing import Any
+
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
 
@@ -27,7 +30,7 @@ class BlockStorageLogLevelList(command.Lister):
     Supported by --os-volume-api-version 3.32 or greater.
     """
 
-    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",
@@ -63,8 +66,12 @@ class BlockStorageLogLevelList(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[list[str], list[tuple[Any, ...]]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
         columns = [
             "Binary",
             "Host",
@@ -98,7 +105,7 @@ class BlockStorageLogLevelSet(command.Command):
     Supported by --os-volume-api-version 3.32 or greater.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "level",
@@ -141,8 +148,10 @@ class BlockStorageLogLevelSet(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, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.32'):
             msg = _(

openstackclient/volume/v3/block_storage_manage.py

@@ -14,6 +14,8 @@
 """Block Storage Volume/Snapshot Management implementations"""
 
 import argparse
+from collections.abc import Iterable
+from typing import Any
 
 from cinderclient import api_versions
 from osc_lib import exceptions
@@ -32,7 +34,7 @@ class BlockStorageManageVolumes(command.Lister):
     Supported by --os-volume-api-version 3.8 or greater.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         host_group = parser.add_mutually_exclusive_group()
         host_group.add_argument(
@@ -104,7 +106,9 @@ class BlockStorageManageVolumes(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[list[str], Iterable[tuple[Any, ...]]]:
         volume_client = self.app.client_manager.volume
 
         if parsed_args.host is None and parsed_args.cluster is None:
@@ -196,7 +200,7 @@ class BlockStorageManageSnapshots(command.Lister):
     Supported by --os-volume-api-version 3.8 or greater.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         host_group = parser.add_mutually_exclusive_group()
         host_group.add_argument(
@@ -268,7 +272,9 @@ class BlockStorageManageSnapshots(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[list[str], Iterable[tuple[Any, ...]]]:
         volume_client = self.app.client_manager.volume
 
         if parsed_args.host is None and parsed_args.cluster is None:

openstackclient/volume/v3/block_storage_resource_filter.py

@@ -12,6 +12,10 @@
 
 """Volume V3 Resource Filters implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
 from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
@@ -24,8 +28,12 @@ from openstackclient.i18n import _
 class ListBlockStorageResourceFilter(command.Lister):
     _description = _('List block storage resource filters')
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.33'):
             msg = _(
@@ -58,7 +66,7 @@ class ListBlockStorageResourceFilter(command.Lister):
 class ShowBlockStorageResourceFilter(command.ShowOne):
     _description = _('Show filters for a block storage resource 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(
             'resource',
@@ -68,8 +76,12 @@ class ShowBlockStorageResourceFilter(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, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.33'):
             msg = _(

openstackclient/volume/v3/service.py

@@ -14,6 +14,10 @@
 
 """Service action implementations"""
 
+import argparse
+from collections.abc import Iterable
+from typing import Any
+
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
@@ -25,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",
@@ -45,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[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         columns: tuple[str, ...] = (
             "binary",
@@ -93,7 +101,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",
@@ -122,7 +130,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 "
@@ -130,7 +138,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, '3'
+        )
 
         service = volume_client.find_service(
             parsed_args.service, ignore_missing=False, host=parsed_args.host

openstackclient/volume/v3/volume.py

@@ -15,10 +15,11 @@
 """Volume V3 Volume action implementations"""
 
 import argparse
+from collections.abc import Iterable, Sequence
 import copy
 import functools
 import logging
-import typing as ty
+from typing import Any
 
 from cliff import columns as cliff_columns
 from openstack.block_storage.v3 import volume as _volume
@@ -44,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
@@ -62,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
@@ -73,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
@@ -93,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 = {
@@ -143,7 +152,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 in case if any of the following is not
@@ -164,7 +173,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",
@@ -313,7 +322,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
@@ -321,7 +332,9 @@ class CreateVolume(command.ShowOne):
         # volume from snapshot, backup 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, '3'
+        )
         image_client = self.app.client_manager.image
 
         if (
@@ -386,7 +399,8 @@ class CreateVolume(command.ShowOne):
                 bootable=parsed_args.bootable,
             )
             data = _format_volume(volume)
-            return zip(*sorted(data.items()))
+            col_headers, col_data = zip(*sorted(data.items()))
+            return col_headers, col_data
 
         source_volume = None
         if parsed_args.source:
@@ -491,13 +505,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",
@@ -535,8 +550,10 @@ class DeleteVolume(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, '3'
+        )
         result = 0
 
         if parsed_args.remote and (parsed_args.force or parsed_args.cascade):
@@ -581,7 +598,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',
@@ -630,7 +647,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
 
@@ -706,7 +725,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(
@@ -736,21 +755,29 @@ 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',
             metavar="<volume>",
             help=_("Volume to migrate (name or ID)"),
         )
-        parser.add_argument(
+        destination_group = parser.add_mutually_exclusive_group(required=True)
+        destination_group.add_argument(
             '--host',
             metavar="<host>",
-            required=True,
             help=_(
                 "Destination host (takes the form: host@backend-name#pool)"
             ),
         )
+        destination_group.add_argument(
+            '--cluster',
+            metavar="<cluster>",
+            help=_(
+                "Destination cluster to migrate the volume to "
+                "(requires --os-volume-api-version 3.16 or higher)"
+            ),
+        )
         parser.add_argument(
             '--force-host-copy',
             action="store_true",
@@ -768,26 +795,38 @@ class MigrateVolume(command.Command):
                 "(possibly by another operation)"
             ),
         )
-        # TODO(stephenfin): Add --cluster argument
         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, '3'
+        )
         volume = volume_client.find_volume(
             parsed_args.volume, ignore_missing=False
         )
+
+        if parsed_args.cluster and not sdk_utils.supports_microversion(
+            volume_client, '3.16'
+        ):
+            msg = _(
+                "--os-volume-api-version 3.16 or greater is required to "
+                "support the volume migration with cluster"
+            )
+            raise exceptions.CommandError(msg)
+
         volume_client.migrate_volume(
             volume.id,
             host=parsed_args.host,
             force_host_copy=parsed_args.force_host_copy,
             lock_volume=parsed_args.lock_volume,
+            cluster=parsed_args.cluster,
         )
 
 
 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',
@@ -940,7 +979,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)
 
@@ -1113,7 +1152,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',
@@ -1122,20 +1161,25 @@ 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, '3'
+        )
         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',
@@ -1164,7 +1208,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)
 
@@ -1196,7 +1240,7 @@ class UnsetVolume(command.Command):
 class VolumeSummary(command.ShowOne):
     _description = _("Show a summary of all volumes in this deployment.")
 
-    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',
@@ -1206,8 +1250,12 @@ class VolumeSummary(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, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.12'):
             msg = _(
@@ -1246,7 +1294,7 @@ class VolumeSummary(command.ShowOne):
 class VolumeRevertToSnapshot(command.Command):
     _description = _("Revert a volume to a 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',
@@ -1258,8 +1306,10 @@ class VolumeRevertToSnapshot(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, '3'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.40'):
             msg = _(