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

openstackclient/volume/v2/volume_type.py

@@ -14,9 +14,12 @@
 
 """Volume v2 Type action implementations"""
 
+import argparse
+from collections.abc import MutableMapping
 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 osc_lib.cli import format_columns
@@ -32,7 +35,7 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-class EncryptionInfoColumn(cliff_columns.FormattableColumn[ty.Any]):
+class EncryptionInfoColumn(cliff_columns.FormattableColumn[Any]):
     """Formattable column for encryption info column.
 
     Unlike the parent FormattableColumn class, the initializer of the
@@ -43,26 +46,30 @@ class EncryptionInfoColumn(cliff_columns.FormattableColumn[ty.Any]):
     ``functools.partial(EncryptionInfoColumn encryption_data)``.
     """
 
-    def __init__(self, value, encryption_data=None):
+    def __init__(
+        self, value: Any, encryption_data: dict[str, Any] | None = None
+    ) -> None:
         super().__init__(value)
         self._encryption_data = encryption_data or {}
 
-    def _get_encryption_info(self):
+    def _get_encryption_info(self) -> Any:
         type_id = self._value
         return self._encryption_data.get(type_id)
 
-    def human_readable(self):
+    def human_readable(self) -> str:
         encryption_info = self._get_encryption_info()
         if encryption_info:
             return utils.format_dict(encryption_info)
         else:
             return '-'
 
-    def machine_readable(self):
+    def machine_readable(self) -> Any:
         return self._get_encryption_info()
 
 
-def _create_encryption_type(volume_client, volume_type, parsed_args):
+def _create_encryption_type(
+    volume_client: Any, volume_type: Any, parsed_args: argparse.Namespace
+) -> Any:
     if not parsed_args.encryption_provider:
         msg = _(
             "'--encryption-provider' should be specified while "
@@ -85,7 +92,9 @@ def _create_encryption_type(volume_client, volume_type, parsed_args):
     return encryption
 
 
-def _set_encryption_type(volume_client, volume_type, parsed_args):
+def _set_encryption_type(
+    volume_client: Any, volume_type: Any, parsed_args: argparse.Namespace
+) -> None:
     # update the existing encryption type
     body = {}
     for attr in ['provider', 'cipher', 'key_size', 'control_location']:
@@ -109,7 +118,7 @@ def _set_encryption_type(volume_client, volume_type, parsed_args):
 class CreateVolumeType(command.ShowOne):
     _description = _("Create new volume 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(
             "name",
@@ -243,7 +252,9 @@ class CreateVolumeType(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         identity_client = self.app.client_manager.identity
         volume_client = self.app.client_manager.volume
 
@@ -277,7 +288,7 @@ class CreateVolumeType(command.ShowOne):
                 msg = _(
                     "Failed to add project %(project)s access to type: %(e)s"
                 )
-                LOG.error(msg % {'project': parsed_args.project, 'e': e})
+                LOG.error(msg, {'project': parsed_args.project, 'e': e})
 
         properties = {}
         if parsed_args.properties:
@@ -325,13 +336,14 @@ class CreateVolumeType(command.ShowOne):
 
         volume_type._info.pop("os-volume-type-access:is_public", None)
 
-        return zip(*sorted(volume_type._info.items()))
+        col_headers, col_data = zip(*sorted(volume_type._info.items()))
+        return col_headers, col_data
 
 
 class DeleteVolumeType(command.Command):
     _description = _("Delete volume type(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(
             "volume_types",
@@ -341,7 +353,7 @@ class DeleteVolumeType(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
 
@@ -358,8 +370,8 @@ class DeleteVolumeType(command.Command):
                     _(
                         "Failed to delete volume type with "
                         "name or ID '%(volume_type)s': %(e)s"
-                    )
-                    % {'volume_type': volume_type, 'e': e}
+                    ),
+                    {'volume_type': volume_type, 'e': e},
                 )
 
         if result > 0:
@@ -373,7 +385,7 @@ class DeleteVolumeType(command.Command):
 class ListVolumeType(command.Lister):
     _description = _("List volume types")
 
-    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',
@@ -412,7 +424,9 @@ class ListVolumeType(command.Lister):
         )
         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
 
         if parsed_args.long:
@@ -439,7 +453,9 @@ class ListVolumeType(command.Lister):
                 is_public=parsed_args.is_public,
             )
 
-        formatters = {'Extra Specs': format_columns.DictColumn}
+        formatters: MutableMapping[str, Any] = {
+            'Extra Specs': format_columns.DictColumn
+        }
 
         if parsed_args.encryption_type:
             encryption = {}
@@ -484,7 +500,7 @@ class ListVolumeType(command.Lister):
 class SetVolumeType(command.Command):
     _description = _("Set volume type 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_type',
@@ -623,7 +639,7 @@ class SetVolumeType(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
         identity_client = self.app.client_manager.identity
 
@@ -719,7 +735,7 @@ class SetVolumeType(command.Command):
 class ShowVolumeType(command.ShowOne):
     _description = _("Display volume type 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_type",
@@ -736,7 +752,9 @@ class ShowVolumeType(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_type = utils.find_resource(
             volume_client.volume_types, parsed_args.volume_type
@@ -763,7 +781,7 @@ class ShowVolumeType(command.ShowOne):
                     'Failed to get access project list for volume type '
                     '%(type)s: %(e)s'
                 )
-                LOG.error(msg % {'type': volume_type.id, 'e': e})
+                LOG.error(msg, {'type': volume_type.id, 'e': e})
         volume_type._info.update({'access_project_ids': access_project_ids})
         if parsed_args.encryption_type:
             # show encryption type information for this volume type
@@ -784,13 +802,14 @@ class ShowVolumeType(command.ShowOne):
                     e,
                 )
         volume_type._info.pop("os-volume-type-access:is_public", None)
-        return zip(*sorted(volume_type._info.items()))
+        col_headers, col_data = zip(*sorted(volume_type._info.items()))
+        return col_headers, col_data
 
 
 class UnsetVolumeType(command.Command):
     _description = _("Unset volume type 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_type',
@@ -825,7 +844,7 @@ class UnsetVolumeType(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
         identity_client = self.app.client_manager.identity
 

openstackclient/volume/v3/block_storage_cleanup.py

@@ -10,6 +10,10 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import argparse
+from collections.abc import Iterable
+from typing import Any
+
 from cinderclient import api_versions
 from osc_lib import exceptions
 
@@ -17,7 +21,9 @@ from openstackclient import command
 from openstackclient.i18n import _
 
 
-def _format_cleanup_response(cleaning, unavailable):
+def _format_cleanup_response(
+    cleaning: Any, unavailable: Any
+) -> tuple[tuple[str, ...], list[tuple[Any, ...]]]:
     column_headers = (
         'ID',
         'Cluster Name',
@@ -49,7 +55,7 @@ class BlockStorageCleanup(command.Lister):
     This command requires ``--os-volume-api-version`` 3.24 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(
             '--cluster',
@@ -127,7 +133,9 @@ class BlockStorageCleanup(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.24'):

openstackclient/volume/v3/block_storage_cluster.py

@@ -10,6 +10,10 @@
 # License for the specific language governing permissions and limitations
 # 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
 from osc_lib import utils
@@ -18,7 +22,9 @@ from openstackclient import command
 from openstackclient.i18n import _
 
 
-def _format_cluster(cluster, detailed=False):
+def _format_cluster(
+    cluster: Any, detailed: bool = False
+) -> tuple[Sequence[str], Iterable[Any]]:
     columns: tuple[str, ...] = (
         'name',
         'binary',
@@ -73,7 +79,7 @@ class ListBlockStorageCluster(command.Lister):
     This command requires ``--os-volume-api-version`` 3.7 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(
             '--cluster',
@@ -137,7 +143,9 @@ class ListBlockStorageCluster(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.7'):
@@ -180,7 +188,7 @@ class SetBlockStorageCluster(command.Command):
     This command requires ``--os-volume-api-version`` 3.7 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(
             'cluster',
@@ -221,7 +229,9 @@ class SetBlockStorageCluster(command.Command):
         )
         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.7'):
@@ -251,7 +261,7 @@ class ShowBlockStorageCluster(command.ShowOne):
     This command requires ``--os-volume-api-version`` 3.7 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(
             'cluster',
@@ -265,7 +275,9 @@ class ShowBlockStorageCluster(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.7'):

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