typing: Add hints to image commands

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

Author: stephenfin

openstackclient/image/client.py

@@ -12,7 +12,9 @@
 #   License for the specific language governing permissions and limitations
 #   under the License.
 
+import argparse
 import logging
+from typing import Any
 
 from osc_lib import utils
 
@@ -27,7 +29,7 @@
 API_VERSIONS = ('1', '2')
 
 
-def make_client(instance):
+def make_client(instance: Any) -> Any:
     """Returns an image service client."""
     LOG.debug(
         'Image client initialized using OpenStack SDK: %s',
@@ -36,7 +38,9 @@ def make_client(instance):
     return instance.sdk_connection.image
 
 
-def build_option_parser(parser):
+def build_option_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
     """Hook to add global options"""
     parser.add_argument(
         '--os-image-api-version',
@@ -48,6 +52,6 @@ def build_option_parser(parser):
     return parser
 
 
-def check_api_version(check_version):
+def check_api_version(check_version: str) -> bool:
     # SDK supports auto-negotiation for us: always return True
     return True

openstackclient/image/v1/image.py

@@ -19,6 +19,7 @@
 import logging
 import os
 import sys
+from collections.abc import Iterable, Sequence
 from typing import Any
 
 from cliff import columns as cliff_columns
@@ -51,7 +52,7 @@
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {'is_protected': 'protected', 'owner_id': 'owner'}
     hidden_columns = [
         'location',
@@ -69,7 +70,7 @@ def _get_columns(item):
 
 
 class HumanReadableSizeColumn(cliff_columns.FormattableColumn[int]):
-    def human_readable(self):
+    def human_readable(self) -> str:
         """Return a formatted visibility string
 
         :rtype:
@@ -83,7 +84,7 @@ def human_readable(self):
 
 
 class VisibilityColumn(cliff_columns.FormattableColumn[bool]):
-    def human_readable(self):
+    def human_readable(self) -> str:
         """Return a formatted visibility string
 
         :rtype:
@@ -99,7 +100,7 @@ def human_readable(self):
 class CreateImage(command.ShowOne):
     _description = _("Create/upload an image")
 
-    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",
@@ -239,7 +240,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]]:
         image_client = self.app.client_manager.image
 
         # Build an attribute dict from the parsed args, only include
@@ -351,13 +354,15 @@ def take_action(self, parsed_args):
             info['properties'] = format_columns.DictColumn(
                 info.get('properties', {})
             )
-            return zip(*sorted(info.items()))
+            col_headers, col_data = zip(*sorted(info.items()))
+            return col_headers, col_data
+        return ((), ())
 
 
 class DeleteImage(command.Command):
     _description = _("Delete image(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(
             "images",
@@ -367,7 +372,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         result = 0
         image_client = self.app.client_manager.image
         for image in parsed_args.images:
@@ -396,7 +401,7 @@ def take_action(self, parsed_args):
 class ListImage(command.Lister):
     _description = _("List available images")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         public_group = parser.add_mutually_exclusive_group()
         public_group.add_argument(
@@ -453,7 +458,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, ...]]]:
         image_client = self.app.client_manager.image
 
         kwargs = {}
@@ -527,7 +534,7 @@ def take_action(self, parsed_args):
 class SaveImage(command.Command):
     _description = _("Save an image locally")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--chunk-size",
@@ -551,7 +558,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         image_client = self.app.client_manager.image
         image = image_client.find_image(
             parsed_args.image, ignore_missing=False
@@ -572,7 +579,7 @@ def take_action(self, parsed_args):
 class SetImage(command.Command):
     _description = _("Set image 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(
             "image",
@@ -702,7 +709,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         image_client = self.app.client_manager.image
 
         kwargs = {}
@@ -819,7 +826,7 @@ def take_action(self, parsed_args):
 class ShowImage(command.ShowOne):
     _description = _("Display image 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(
             "--human-readable",
@@ -834,7 +841,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]]:
         image_client = self.app.client_manager.image
         image = image_client.find_image(
             parsed_args.image, ignore_missing=False

openstackclient/image/v2/cache.py

@@ -13,9 +13,12 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import argparse
+from collections.abc import Iterable, Sequence
 import copy
 import datetime
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -27,7 +30,7 @@
 LOG = logging.getLogger(__name__)
 
 
-def _format_image_cache(cached_images):
+def _format_image_cache(cached_images: dict[str, Any]) -> list[dict[str, Any]]:
     """Format image cache to make it more consistent with OSC operations."""
 
     image_list = []
@@ -70,11 +73,13 @@ def _format_image_cache(cached_images):
 class ListCachedImage(command.Lister):
     _description = _("Get Cache State")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         image_client = self.app.client_manager.image
 
         # List of Cache data received
@@ -111,7 +116,7 @@ def take_action(self, parsed_args):
 class QueueCachedImage(command.Command):
     _description = _("Queue image(s) for caching.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "images",
@@ -121,7 +126,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         image_client = self.app.client_manager.image
 
         failures = 0
@@ -151,7 +156,7 @@ def take_action(self, parsed_args):
 class DeleteCachedImage(command.Command):
     _description = _("Delete image(s) from cache")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "images",
@@ -161,7 +166,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         failures = 0
         image_client = self.app.client_manager.image
         for image in parsed_args.images:
@@ -190,7 +195,7 @@ def take_action(self, parsed_args):
 class ClearCachedImage(command.Command):
     _description = _("Clear all images from cache, queue or both")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--cache",
@@ -210,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:
         image_client = self.app.client_manager.image
 
         target = parsed_args.target