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

openstackclient/volume/v3/volume_attachment.py

@@ -10,8 +10,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
-import typing as ty
+from typing import Any
 
 from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
@@ -32,7 +34,7 @@ _FILTER_DEPRECATED = _(
 )
 
 
-def _format_attachment(attachment):
+def _format_attachment(attachment: Any) -> tuple[tuple[str, ...], Any]:
     columns = (
         'id',
         'volume_id',
@@ -57,7 +59,7 @@ def _format_attachment(attachment):
     # VolumeAttachmentManager.create returns a dict while everything else
     # returns a VolumeAttachment object
     if isinstance(attachment, dict):
-        data: tuple[ty.Any, ...] = ()
+        data: tuple[Any, ...] = ()
         for column in columns:
             if column == 'connection_info':
                 data += (format_columns.DictColumn(attachment[column]),)
@@ -88,7 +90,7 @@ class CreateVolumeAttachment(command.ShowOne):
     add volume' command should be preferred.
     """
 
-    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',
@@ -171,8 +173,12 @@ class CreateVolumeAttachment(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'
+        )
         compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(volume_client, '3.27'):
@@ -249,7 +255,7 @@ class DeleteVolumeAttachment(command.Command):
     remove' command should be preferred.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'attachment',
@@ -258,8 +264,10 @@ class DeleteVolumeAttachment(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.27'):
             msg = _(
@@ -280,7 +288,7 @@ class SetVolumeAttachment(command.ShowOne):
     connected to.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'attachment',
@@ -332,8 +340,12 @@ class SetVolumeAttachment(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.27'):
             msg = _(
@@ -363,7 +375,7 @@ class SetVolumeAttachment(command.ShowOne):
 class CompleteVolumeAttachment(command.Command):
     """Complete an attachment for a volume."""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'attachment',
@@ -372,8 +384,10 @@ class CompleteVolumeAttachment(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.44'):
             msg = _(
@@ -388,7 +402,7 @@ class CompleteVolumeAttachment(command.Command):
 class ListVolumeAttachment(command.Lister):
     """Lists all volume attachments."""
 
-    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',
@@ -432,8 +446,12 @@ class ListVolumeAttachment(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'
+        )
         identity_client = self.app.client_manager.identity
 
         if not sdk_utils.supports_microversion(volume_client, '3.27'):
@@ -490,7 +508,7 @@ class ListVolumeAttachment(command.Lister):
 class ShowVolumeAttachment(command.ShowOne):
     """Show detailed information for a volume attachment."""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'attachment',
@@ -499,8 +517,12 @@ class ShowVolumeAttachment(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.27'):
             msg = _(

openstackclient/volume/v3/volume_backup.py

@@ -14,9 +14,12 @@
 
 """Volume v3 Backup action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import copy
 import functools
 import logging
+from typing import Any
 
 from cliff import columns as cliff_columns
 from openstack import utils as sdk_utils
@@ -42,11 +45,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]):
 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",
@@ -125,8 +130,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, '3'
+        )
 
         volume_id = volume_client.find_volume(
             parsed_args.volume,
@@ -182,7 +191,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",
@@ -198,8 +207,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, '3'
+        )
         result = 0
 
         for backup in parsed_args.backups:
@@ -234,7 +245,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(
             '--project',
@@ -299,9 +310,15 @@ class ListVolumeBackup(command.Lister):
         # )
         return parser
 
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
-        identity_client = self.app.client_manager.sdk_connection.identity
+    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 = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         columns: tuple[str, ...] = (
             'id',
@@ -396,7 +413,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",
@@ -422,8 +439,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[tuple[str, ...], Iterable[Any]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         columns: tuple[str, ...] = (
             'id',
@@ -468,7 +489,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",
@@ -525,8 +546,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, '3'
+        )
 
         backup = volume_client.find_backup(
             parsed_args.backup,
@@ -608,7 +631,7 @@ class UnsetVolumeBackup(command.Command):
     This command requires ``--os-volume-api-version`` 3.43 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(
             'backup',
@@ -627,8 +650,10 @@ class UnsetVolumeBackup(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.43'):
             msg = _(
@@ -660,7 +685,7 @@ class UnsetVolumeBackup(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",
@@ -669,8 +694,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[tuple[str, ...], Iterable[Any]]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
         backup = volume_client.find_backup(
             parsed_args.backup, ignore_missing=False
         )

openstackclient/volume/v3/volume_group.py

@@ -11,6 +11,8 @@
 # under the License.
 
 import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from cinderclient import api_versions
 from osc_lib import exceptions
@@ -21,7 +23,7 @@ from openstackclient.common import envvars
 from openstackclient.i18n import _
 
 
-def _format_group(group):
+def _format_group(group: Any) -> tuple[Sequence[str], Iterable[Any]]:
     columns = (
         'id',
         'status',
@@ -79,7 +81,7 @@ class CreateVolumeGroup(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.13 or greater.
     """
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         # This is a bit complicated. We accept two patterns: a legacy pattern
         #
@@ -168,7 +170,9 @@ class CreateVolumeGroup(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 parsed_args.volume_group_type_legacy:
@@ -276,7 +280,7 @@ class DeleteVolumeGroup(command.Command):
     This command requires ``--os-volume-api-version`` 3.13 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',
@@ -294,7 +298,7 @@ class DeleteVolumeGroup(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.13'):
@@ -318,7 +322,7 @@ class SetVolumeGroup(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.13 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',
@@ -356,7 +360,9 @@ class SetVolumeGroup(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.13'):
@@ -405,7 +411,7 @@ class ListVolumeGroup(command.Lister):
     This command requires ``--os-volume-api-version`` 3.13 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(
             '--all-projects',
@@ -430,7 +436,9 @@ class ListVolumeGroup(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.13'):
@@ -469,7 +477,7 @@ class ShowVolumeGroup(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.13 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',
@@ -517,7 +525,9 @@ class ShowVolumeGroup(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.13'):
@@ -571,7 +581,7 @@ class FailoverVolumeGroup(command.Command):
     This command requires ``--os-volume-api-version`` 3.38 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',
@@ -599,7 +609,7 @@ class FailoverVolumeGroup(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.38'):

openstackclient/volume/v3/volume_group_snapshot.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 openstack import utils as sdk_utils
 from osc_lib import exceptions
@@ -23,7 +26,9 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _format_group_snapshot(snapshot):
+def _format_group_snapshot(
+    snapshot: Any,
+) -> tuple[Sequence[str], Iterable[Any]]:
     columns = (
         'id',
         'status',
@@ -56,7 +61,7 @@ class CreateVolumeGroupSnapshot(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.13 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(
             'volume_group',
@@ -75,8 +80,12 @@ class CreateVolumeGroupSnapshot(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.14'):
             msg = _(
@@ -106,7 +115,7 @@ class DeleteVolumeGroupSnapshot(command.Command):
     This command requires ``--os-volume-api-version`` 3.14 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(
             'snapshot',
@@ -115,8 +124,10 @@ class DeleteVolumeGroupSnapshot(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.14'):
             msg = _(
@@ -140,7 +151,7 @@ class ListVolumeGroupSnapshot(command.Lister):
     This command requires ``--os-volume-api-version`` 3.14 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(
             '--all-projects',
@@ -165,8 +176,12 @@ class ListVolumeGroupSnapshot(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'
+        )
 
         if not sdk_utils.supports_microversion(volume_client, '3.14'):
             msg = _(
@@ -202,7 +217,7 @@ class ShowVolumeGroupSnapshot(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.14 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(
             'snapshot',
@@ -211,8 +226,12 @@ class ShowVolumeGroupSnapshot(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.14'):
             msg = _(