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

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:
@@ -175,8 +187,8 @@ class DeleteVolumeBackup(command.Command):
                     _(
                         "Failed to delete backup with "
                         "name or ID '%(backup)s': %(e)s"
-                    )
-                    % {'backup': backup, 'e': e}
+                    ),
+                    {'backup': backup, 'e': e},
                 )
 
         if result > 0:
@@ -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',
@@ -324,7 +340,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 +366,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,
@@ -396,7 +416,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 +436,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 +464,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 +473,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)

openstackclient/volume/v2/volume_snapshot.py

@@ -14,12 +14,15 @@
 
 """Volume v2 snapshot action implementations"""
 
+import argparse
 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 snapshot as _snapshot
+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
@@ -45,11 +48,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
@@ -61,7 +66,7 @@ class VolumeIdColumn(cliff_columns.FormattableColumn[str]):
         return volume
 
 
-def _format_snapshot(snapshot: _snapshot.Snapshot) -> dict[str, ty.Any]:
+def _format_snapshot(snapshot: _snapshot.Snapshot) -> dict[str, Any]:
     # Some columns returned by openstacksdk should not be shown because they're
     # either irrelevant or duplicates
     ignored_columns = {
@@ -100,7 +105,7 @@ def _format_snapshot(snapshot: _snapshot.Snapshot) -> dict[str, ty.Any]:
 class CreateVolumeSnapshot(command.ShowOne):
     _description = _("Create new volume 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",
@@ -150,8 +155,12 @@ class CreateVolumeSnapshot(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 = parsed_args.volume
         if not parsed_args.volume:
@@ -186,13 +195,14 @@ class CreateVolumeSnapshot(command.ShowOne):
             )
 
         data = _format_snapshot(snapshot)
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class DeleteVolumeSnapshot(command.Command):
     _description = _("Delete volume 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(
             "snapshots",
@@ -210,8 +220,10 @@ class DeleteVolumeSnapshot(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 snapshot in parsed_args.snapshots:
@@ -219,8 +231,11 @@ class DeleteVolumeSnapshot(command.Command):
                 snapshot_id = volume_client.find_snapshot(
                     snapshot, ignore_missing=False
                 ).id
+                # FIXME(stephenfin): This parameter is missing from sdk
+                # https://review.opendev.org/c/openstack/openstacksdk/+/984529
                 volume_client.delete_snapshot(
-                    snapshot_id, force=parsed_args.force
+                    snapshot_id,
+                    force=parsed_args.force,  # type: ignore
                 )
             except Exception as e:
                 result += 1
@@ -228,8 +243,8 @@ class DeleteVolumeSnapshot(command.Command):
                     _(
                         "Failed to delete snapshot with "
                         "name or ID '%(snapshot)s': %(e)s"
-                    )
-                    % {'snapshot': snapshot, 'e': e}
+                    ),
+                    {'snapshot': snapshot, 'e': e},
                 )
 
         if result > 0:
@@ -244,7 +259,7 @@ class DeleteVolumeSnapshot(command.Command):
 class ListVolumeSnapshot(command.Lister):
     _description = _("List volume 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',
@@ -295,8 +310,12 @@ class ListVolumeSnapshot(command.Lister):
         pagination.add_marker_pagination_option_to_parser(parser)
         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'
+        )
         identity_client = self.app.client_manager.identity
 
         columns: tuple[str, ...] = (
@@ -384,7 +403,7 @@ class ListVolumeSnapshot(command.Lister):
 class SetVolumeSnapshot(command.Command):
     _description = _("Set volume snapshot 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(
             'snapshot',
@@ -440,8 +459,10 @@ class SetVolumeSnapshot(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'
+        )
 
         snapshot = volume_client.find_snapshot(
             parsed_args.snapshot, ignore_missing=False
@@ -499,7 +520,7 @@ class SetVolumeSnapshot(command.Command):
 class ShowVolumeSnapshot(command.ShowOne):
     _description = _("Display volume 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(
             "snapshot",
@@ -508,21 +529,26 @@ class ShowVolumeSnapshot(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'
+        )
 
         snapshot = volume_client.find_snapshot(
             parsed_args.snapshot, ignore_missing=False
         )
 
         data = _format_snapshot(snapshot)
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class UnsetVolumeSnapshot(command.Command):
     _description = _("Unset volume snapshot 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(
             'snapshot',
@@ -542,7 +568,7 @@ class UnsetVolumeSnapshot(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.sdk_connection.volume
 
         snapshot = volume_client.find_snapshot(

openstackclient/volume/v2/volume_transfer_request.py

@@ -14,7 +14,10 @@
 
 """Volume v2 transfer 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 AcceptTransferRequest(command.ShowOne):
     _description = _("Accept volume transfer request.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'transfer_request',
@@ -44,7 +47,9 @@ class AcceptTransferRequest(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
 
         try:
@@ -62,13 +67,14 @@ class AcceptTransferRequest(command.ShowOne):
         )
         transfer_accept._info.pop("links", None)
 
-        return zip(*sorted(transfer_accept._info.items()))
+        col_headers, col_data = zip(*sorted(transfer_accept._info.items()))
+        return col_headers, col_data
 
 
 class CreateTransferRequest(command.ShowOne):
     _description = _("Create volume transfer request.")
 
-    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',
@@ -82,7 +88,9 @@ class CreateTransferRequest(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
 
         volume_id = utils.find_resource(
@@ -95,13 +103,16 @@ class CreateTransferRequest(command.ShowOne):
         )
         volume_transfer_request._info.pop("links", None)
 
-        return zip(*sorted(volume_transfer_request._info.items()))
+        col_headers, col_data = zip(
+            *sorted(volume_transfer_request._info.items())
+        )
+        return col_headers, col_data
 
 
 class DeleteTransferRequest(command.Command):
     _description = _("Delete volume transfer request(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(
             'transfer_request',
@@ -111,7 +122,7 @@ class DeleteTransferRequest(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
 
@@ -128,8 +139,8 @@ class DeleteTransferRequest(command.Command):
                     _(
                         "Failed to delete volume transfer request "
                         "with name or ID '%(transfer)s': %(e)s"
-                    )
-                    % {'transfer': t, 'e': e}
+                    ),
+                    {'transfer': t, 'e': e},
                 )
 
         if result > 0:
@@ -144,7 +155,7 @@ class DeleteTransferRequest(command.Command):
 class ListTransferRequest(command.Lister):
     _description = _("Lists all volume transfer requests.")
 
-    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',
@@ -155,7 +166,9 @@ class ListTransferRequest(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         columns = ['ID', 'Name', 'Volume ID']
         column_headers = ['ID', 'Name', 'Volume']
 
@@ -178,7 +191,7 @@ class ListTransferRequest(command.Lister):
 class ShowTransferRequest(command.ShowOne):
     _description = _("Show volume transfer request 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(
             'transfer_request',
@@ -187,7 +200,9 @@ class ShowTransferRequest(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
         volume_transfer_request = utils.find_resource(
             volume_client.transfers,
@@ -195,4 +210,7 @@ class ShowTransferRequest(command.ShowOne):
         )
         volume_transfer_request._info.pop("links", None)
 
-        return zip(*sorted(volume_transfer_request._info.items()))
+        col_headers, col_data = zip(
+            *sorted(volume_transfer_request._info.items())
+        )
+        return col_headers, col_data