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

openstackclient/volume/v3/volume_group_type.py

@@ -10,7 +10,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from cinderclient import api_versions
 from osc_lib.cli import format_columns
@@ -24,7 +27,7 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _format_group_type(group):
+def _format_group_type(group: Any) -> tuple[Sequence[str], Iterable[Any]]:
     columns = (
         'id',
         'name',
@@ -60,7 +63,7 @@ class CreateVolumeGroupType(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.11 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(
             'name',
@@ -90,7 +93,9 @@ class CreateVolumeGroupType(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
 
         if volume_client.api_version < api_versions.APIVersion('3.11'):
@@ -113,7 +118,7 @@ class DeleteVolumeGroupType(command.Command):
     This command requires ``--os-volume-api-version`` 3.11 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(
             'group_type',
@@ -122,7 +127,7 @@ class DeleteVolumeGroupType(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
 
         if volume_client.api_version < api_versions.APIVersion('3.11'):
@@ -146,7 +151,7 @@ class SetVolumeGroupType(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.11 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(
             'group_type',
@@ -199,7 +204,9 @@ class SetVolumeGroupType(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
 
         if volume_client.api_version < api_versions.APIVersion('3.11'):
@@ -263,7 +270,7 @@ class UnsetVolumeGroupType(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.11 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(
             'group_type',
@@ -282,7 +289,9 @@ class UnsetVolumeGroupType(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
 
         if volume_client.api_version < api_versions.APIVersion('3.11'):
@@ -313,7 +322,7 @@ class ListVolumeGroupType(command.Lister):
     This command requires ``--os-volume-api-version`` 3.11 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(
             '--default',
@@ -338,7 +347,9 @@ class ListVolumeGroupType(command.Lister):
         # )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         volume_client = self.app.client_manager.volume
 
         if volume_client.api_version < api_versions.APIVersion('3.11'):
@@ -378,7 +389,7 @@ class ShowVolumeGroupType(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.11 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(
             'group_type',
@@ -387,7 +398,9 @@ class ShowVolumeGroupType(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
 
         if volume_client.api_version < api_versions.APIVersion('3.11'):

openstackclient/volume/v3/volume_message.py

@@ -14,7 +14,10 @@
 
 """Volume V3 Messages implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging as LOG
+from typing import Any
 
 from cinderclient import api_versions
 from osc_lib import exceptions
@@ -29,7 +32,7 @@ from openstackclient.identity import common as identity_common
 class DeleteMessage(command.Command):
     _description = _('Delete a volume failure message')
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'message_ids',
@@ -40,7 +43,7 @@ class DeleteMessage(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
 
         if volume_client.api_version < api_versions.APIVersion('3.3'):
@@ -70,7 +73,7 @@ class DeleteMessage(command.Command):
 class ListMessages(command.Lister):
     _description = _('List volume failure messages')
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -83,7 +86,9 @@ class ListMessages(command.Lister):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         volume_client = self.app.client_manager.volume
         identity_client = self.app.client_manager.identity
 
@@ -132,7 +137,7 @@ class ListMessages(command.Lister):
 class ShowMessage(command.ShowOne):
     _description = _('Show a volume failure message')
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'message_id',
@@ -142,7 +147,9 @@ class ShowMessage(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
 
         if volume_client.api_version < api_versions.APIVersion('3.3'):
@@ -154,4 +161,5 @@ class ShowMessage(command.ShowOne):
 
         message = volume_client.messages.get(parsed_args.message_id)
 
-        return zip(*sorted(message._info.items()))
+        col_headers, col_data = zip(*sorted(message._info.items()))
+        return col_headers, col_data

openstackclient/volume/v3/volume_snapshot.py

@@ -14,12 +14,15 @@
 
 """Volume v3 snapshot action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 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 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
@@ -44,11 +47,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
@@ -60,7 +65,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 = {
@@ -99,7 +104,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",
@@ -123,7 +128,9 @@ class CreateVolumeSnapshot(command.ShowOne):
             action="store_true",
             default=False,
             help=_(
-                "Create a snapshot attached to an instance. Default is False"
+                "Allow snapshot of in-use (attached) volume. "
+                "Only needed for microversions prior to 3.66; "
+                "ignored for 3.66+"
             ),
         )
         parser.add_argument(
@@ -149,8 +156,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, '3'
+        )
 
         volume = parsed_args.volume
         if not parsed_args.volume:
@@ -176,22 +187,33 @@ class CreateVolumeSnapshot(command.ShowOne):
             )
         else:
             # Create a new snapshot from scratch
-            snapshot = volume_client.create_snapshot(
-                volume_id=volume_id,
-                force=parsed_args.force,
-                name=parsed_args.snapshot_name,
-                description=parsed_args.description,
-                metadata=parsed_args.properties,
-            )
+            # only for microversion < 3.66, pass force parameter
+            # for backward compatibility
+            if not sdk_utils.supports_microversion(volume_client, '3.66'):
+                snapshot = volume_client.create_snapshot(
+                    volume_id=volume_id,
+                    force=parsed_args.force,
+                    name=parsed_args.snapshot_name,
+                    description=parsed_args.description,
+                    metadata=parsed_args.properties,
+                )
+            else:
+                snapshot = volume_client.create_snapshot(
+                    volume_id=volume_id,
+                    name=parsed_args.snapshot_name,
+                    description=parsed_args.description,
+                    metadata=parsed_args.properties,
+                )
 
         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",
@@ -217,8 +239,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, '3'
+        )
         result = 0
 
         if parsed_args.remote:
@@ -262,7 +286,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',
@@ -313,8 +337,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[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
         identity_client = self.app.client_manager.identity
 
         columns: tuple[str, ...] = (
@@ -402,7 +430,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',
@@ -458,8 +486,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, '3'
+        )
 
         snapshot = volume_client.find_snapshot(
             parsed_args.snapshot, ignore_missing=False
@@ -517,7 +547,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",
@@ -526,21 +556,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, '3'
+        )
 
         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',
@@ -560,8 +595,10 @@ class UnsetVolumeSnapshot(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'
+        )
 
         snapshot = volume_client.find_snapshot(
             parsed_args.snapshot, ignore_missing=False

openstackclient/volume/v3/volume_transfer_request.py

@@ -14,7 +14,10 @@
 
 """Volume v3 transfer action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from cinderclient import api_versions
 from osc_lib import exceptions
@@ -30,7 +33,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',
@@ -45,7 +48,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:
@@ -63,13 +68,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',
@@ -102,7 +108,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
 
         kwargs = {}
@@ -130,13 +138,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',
@@ -146,7 +157,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
 
@@ -179,7 +190,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',
@@ -190,7 +201,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']
 
@@ -213,7 +226,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',
@@ -222,7 +235,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,
@@ -230,4 +245,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