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

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, object]:
     # 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",
@@ -405,8 +420,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, '2'
+        )
         result = 0
 
         for volume in parsed_args.volumes:
@@ -441,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',
@@ -477,10 +494,14 @@ class ListVolume(command.Lister):
             default=False,
             help=_('List additional fields in output'),
         )
-        pagination.add_marker_pagination_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(
+            parser, include_max_items=False
+        )
         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
 
@@ -555,7 +576,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(
@@ -585,7 +606,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',
@@ -619,8 +640,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
         )
@@ -635,7 +659,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',
@@ -788,7 +812,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)
 
@@ -952,7 +976,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',
@@ -961,20 +985,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',
@@ -1003,7 +1033,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)
 

openstackclient/volume/v2/volume_backend.py

@@ -14,6 +14,11 @@
 
 """Storage backend action 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 utils
 
@@ -24,7 +29,7 @@ from openstackclient.i18n import _
 class ShowCapability(command.Lister):
     _description = _("Show capability 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",
@@ -33,8 +38,12 @@ class ShowCapability(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 = [
             'Title',
@@ -71,7 +80,7 @@ class ShowCapability(command.Lister):
 class ListPool(command.Lister):
     _description = _("List pool 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(
             "--long",
@@ -83,8 +92,12 @@ class ListPool(command.Lister):
         # able to pass in --filters with a <key>=<value> pair to filter on.
         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'
+        )
 
         if parsed_args.long:
             columns = [

openstackclient/volume/v2/volume_backup.py

@@ -14,10 +14,14 @@
 
 """Volume v2 Backup action implementations"""
 
+import argparse
 import functools
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from cliff import columns as cliff_columns
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -39,11 +43,13 @@ class VolumeIdColumn(cliff_columns.FormattableColumn[str]):
     ``functools.partial(VolumeIdColumn, volume_cache)``.
     """
 
-    def __init__(self, value, volume_cache=None):
+    def __init__(
+        self, value: str, volume_cache: dict[str, Any] | None = None
+    ) -> None:
         super().__init__(value)
         self._volume_cache = volume_cache or {}
 
-    def human_readable(self):
+    def human_readable(self) -> str:
         """Return a volume name if available
 
         :rtype: either the volume ID or name
@@ -58,7 +64,7 @@ class VolumeIdColumn(cliff_columns.FormattableColumn[str]):
 class CreateVolumeBackup(command.ShowOne):
     _description = _("Create new volume backup")
 
-    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",
@@ -102,8 +108,12 @@ class CreateVolumeBackup(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_id = volume_client.find_volume(
             parsed_args.volume,
@@ -139,7 +149,7 @@ class CreateVolumeBackup(command.ShowOne):
 class DeleteVolumeBackup(command.Command):
     _description = _("Delete volume backup(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(
             "backups",
@@ -155,8 +165,10 @@ class DeleteVolumeBackup(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'
+        )
         result = 0
 
         for backup in parsed_args.backups:
@@ -191,7 +203,7 @@ class DeleteVolumeBackup(command.Command):
 class ListVolumeBackup(command.Lister):
     _description = _("List volume backups")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--long",
@@ -237,8 +249,12 @@ class ListVolumeBackup(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, ...] = (
             'id',
@@ -306,6 +322,7 @@ class ListVolumeBackup(command.Lister):
             all_tenants=parsed_args.all_projects,
             marker=marker_backup_id,
             limit=parsed_args.limit,
+            max_items=parsed_args.max_items,
         )
 
         return (
@@ -324,7 +341,7 @@ class ListVolumeBackup(command.Lister):
 class RestoreVolumeBackup(command.ShowOne):
     _description = _("Restore volume backup")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "backup",
@@ -350,8 +367,12 @@ class RestoreVolumeBackup(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'
+        )
 
         backup = volume_client.find_backup(
             parsed_args.backup,
@@ -384,9 +405,7 @@ class RestoreVolumeBackup(command.ShowOne):
                 raise exceptions.CommandError(msg % parsed_args.volume)
 
         restore = volume_client.restore_backup(
-            backup.id,
-            volume_id=volume_id,
-            name=volume_name,
+            backup.id, volume=volume_id, name=volume_name
         )
 
         data = utils.get_dict_properties(restore, columns)
@@ -396,7 +415,7 @@ class RestoreVolumeBackup(command.ShowOne):
 class SetVolumeBackup(command.Command):
     _description = _("Set volume backup 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(
             "backup",
@@ -416,8 +435,10 @@ class SetVolumeBackup(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'
+        )
 
         backup = volume_client.find_backup(
             parsed_args.backup,
@@ -442,7 +463,7 @@ class SetVolumeBackup(command.Command):
 class ShowVolumeBackup(command.ShowOne):
     _description = _("Display volume backup 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(
             "backup",
@@ -451,8 +472,12 @@ class ShowVolumeBackup(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'
+        )
         backup = volume_client.find_backup(
             parsed_args.backup, ignore_missing=False
         )

openstackclient/volume/v2/volume_host.py

@@ -14,6 +14,8 @@
 
 """Volume v2 host action implementations"""
 
+import argparse
+
 from openstackclient import command
 from openstackclient.i18n import _
 
@@ -21,7 +23,7 @@ from openstackclient.i18n import _
 class FailoverVolumeHost(command.Command):
     _description = _("Failover volume host to different backend")
 
-    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", metavar="<host-name>", help=_("Name of volume host")
@@ -37,7 +39,7 @@ class FailoverVolumeHost(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         service_client = self.app.client_manager.volume
         service_client.services.failover_host(
             parsed_args.host, parsed_args.volume_backend
@@ -47,7 +49,7 @@ class FailoverVolumeHost(command.Command):
 class SetVolumeHost(command.Command):
     _description = _("Set volume host 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", metavar="<host-name>", help=_("Name of volume host")
@@ -65,7 +67,7 @@ class SetVolumeHost(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         service_client = self.app.client_manager.volume
         if parsed_args.enable:
             service_client.services.thaw_host(parsed_args.host)