typing: Add hints to volume commands

Change-Id: I0bd114c1a0310e108bd14aede98f574a1f9e64c7
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Author: stephenfin

openstackclient/volume/client.py

@@ -13,7 +13,9 @@
 #   under the License.
 #
 
+import argparse
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -34,7 +36,7 @@
 _volume_api_version = None
 
 
-def make_client(instance):
+def make_client(instance: Any) -> Any:
     """Returns a volume service client."""
 
     # Defer client imports until we actually need them
@@ -92,7 +94,9 @@ def make_client(instance):
     return client
 
 
-def build_option_parser(parser):
+def build_option_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
     """Hook to add global options"""
     parser.add_argument(
         '--os-volume-api-version',
@@ -104,7 +108,7 @@ def build_option_parser(parser):
     return parser
 
 
-def check_api_version(check_version):
+def check_api_version(check_version: str) -> bool:
     """Validate version supplied by user
 
     Returns:

openstackclient/volume/v2/backup_record.py

@@ -14,7 +14,10 @@
 
 """Volume v2 Backup action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib import utils
 
@@ -33,7 +36,7 @@ class ExportBackupRecord(command.ShowOne):
 restore."""
     )
 
-    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",
@@ -42,7 +45,9 @@ def get_parser(self, prog_name):
         )
         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
         backup = utils.find_resource(volume_client.backups, parsed_args.backup)
         backup_data = volume_client.backups.export_record(backup.id)
@@ -53,7 +58,8 @@ def take_action(self, parsed_args):
             backup_data['Backup Service'] = backup_data.pop('backup_service')
             backup_data['Metadata'] = backup_data.pop('backup_url')
 
-        return zip(*sorted(backup_data.items()))
+        col_headers, col_data = zip(*sorted(backup_data.items()))
+        return col_headers, col_data
 
 
 class ImportBackupRecord(command.ShowOne):
@@ -64,7 +70,7 @@ class ImportBackupRecord(command.ShowOne):
 rebuilt service instance"""
     )
 
-    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_service",
@@ -78,10 +84,13 @@ def get_parser(self, prog_name):
         )
         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
         backup_data = volume_client.backups.import_record(
             parsed_args.backup_service, parsed_args.backup_metadata
         )
         backup_data.pop('links', None)
-        return zip(*sorted(backup_data.items()))
+        col_headers, col_data = zip(*sorted(backup_data.items()))
+        return col_headers, col_data

openstackclient/volume/v2/consistency_group.py

@@ -16,6 +16,8 @@
 
 import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
@@ -28,7 +30,9 @@
 LOG = logging.getLogger(__name__)
 
 
-def _find_volumes(parsed_args_volumes, volume_client):
+def _find_volumes(
+    parsed_args_volumes: list[str], volume_client: Any
+) -> tuple[int, str]:
     result = 0
     uuid = ''
     for volume in parsed_args_volumes:
@@ -48,7 +52,7 @@ def _find_volumes(parsed_args_volumes, volume_client):
 class AddVolumeToConsistencyGroup(command.Command):
     _description = _("Add volume(s) to consistency group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'consistency_group',
@@ -66,7 +70,7 @@ def get_parser(self, prog_name):
         )
         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, add_uuid = _find_volumes(parsed_args.volumes, volume_client)
 
@@ -90,7 +94,7 @@ def take_action(self, parsed_args):
 class CreateConsistencyGroup(command.ShowOne):
     _description = _("Create new consistency group.")
 
-    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",
@@ -144,7 +148,9 @@ def get_parser(self, prog_name):
         )
         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_type:
             volume_type_id = utils.find_resource(
@@ -186,13 +192,14 @@ def take_action(self, parsed_args):
                 )
             )
 
-        return zip(*sorted(consistency_group._info.items()))
+        col_headers, col_data = zip(*sorted(consistency_group._info.items()))
+        return col_headers, col_data
 
 
 class DeleteConsistencyGroup(command.Command):
     _description = _("Delete consistency group(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(
             'consistency_groups',
@@ -208,7 +215,7 @@ def get_parser(self, prog_name):
         )
         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
 
@@ -241,7 +248,7 @@ def take_action(self, parsed_args):
 class ListConsistencyGroup(command.Lister):
     _description = _("List consistency groups.")
 
-    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',
@@ -258,7 +265,9 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         if parsed_args.long:
             columns = [
                 'ID',
@@ -292,7 +301,7 @@ def take_action(self, parsed_args):
 class RemoveVolumeFromConsistencyGroup(command.Command):
     _description = _("Remove volume(s) from consistency group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'consistency_group',
@@ -310,7 +319,7 @@ def get_parser(self, prog_name):
         )
         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, remove_uuid = _find_volumes(parsed_args.volumes, volume_client)
 
@@ -334,7 +343,7 @@ def take_action(self, parsed_args):
 class SetConsistencyGroup(command.Command):
     _description = _("Set consistency group 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(
             'consistency_group',
@@ -353,7 +362,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         volume_client = self.app.client_manager.volume
         kwargs = {}
         if parsed_args.name:
@@ -372,7 +381,7 @@ def take_action(self, parsed_args):
 class ShowConsistencyGroup(command.ShowOne):
     _description = _("Display consistency group 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(
             "consistency_group",
@@ -381,9 +390,12 @@ def get_parser(self, prog_name):
         )
         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
         consistency_group = utils.find_resource(
             volume_client.consistencygroups, parsed_args.consistency_group
         )
-        return zip(*sorted(consistency_group._info.items()))
+        col_headers, col_data = zip(*sorted(consistency_group._info.items()))
+        return col_headers, col_data

openstackclient/volume/v2/consistency_group_snapshot.py

@@ -14,7 +14,10 @@
 
 """Volume v2 consistency group snapshot 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 @@
 class CreateConsistencyGroupSnapshot(command.ShowOne):
     _description = _("Create new consistency group 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",
@@ -52,7 +55,9 @@ def get_parser(self, prog_name):
         )
         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
         consistency_group = parsed_args.consistency_group
         if not parsed_args.consistency_group:
@@ -68,13 +73,16 @@ def take_action(self, parsed_args):
             description=parsed_args.description,
         )
 
-        return zip(*sorted(consistency_group_snapshot._info.items()))
+        col_headers, col_data = zip(
+            *sorted(consistency_group_snapshot._info.items())
+        )
+        return col_headers, col_data
 
 
 class DeleteConsistencyGroupSnapshot(command.Command):
     _description = _("Delete consistency group 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(
             "consistency_group_snapshot",
@@ -84,7 +92,7 @@ def get_parser(self, prog_name):
         )
         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
 
@@ -117,7 +125,7 @@ def take_action(self, parsed_args):
 class ListConsistencyGroupSnapshot(command.Lister):
     _description = _("List consistency group 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',
@@ -153,7 +161,9 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         if parsed_args.long:
             columns = [
                 'ID',
@@ -194,7 +204,7 @@ def take_action(self, parsed_args):
 class ShowConsistencyGroupSnapshot(command.ShowOne):
     _description = _("Display consistency group 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(
             "consistency_group_snapshot",
@@ -203,9 +213,14 @@ def get_parser(self, prog_name):
         )
         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
         consistency_group_snapshot = utils.find_resource(
             volume_client.cgsnapshots, parsed_args.consistency_group_snapshot
         )
-        return zip(*sorted(consistency_group_snapshot._info.items()))
+        col_headers, col_data = zip(
+            *sorted(consistency_group_snapshot._info.items())
+        )
+        return col_headers, col_data