typing: Add hints to object commands

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

Author: stephenfin

openstackclient/object/client.py

@@ -15,6 +15,9 @@
 
 """Object client"""
 
+import argparse
+from typing import Any
+
 from osc_lib import utils
 
 from openstackclient.api import object_store_v1
@@ -26,7 +29,7 @@
 API_VERSIONS = ('1',)
 
 
-def make_client(instance):
+def make_client(instance: Any) -> object_store_v1.APIv1:
     """Returns an object-store API client."""
 
     endpoint = instance.get_endpoint_for_service_type(
@@ -43,7 +46,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-object-api-version',

openstackclient/object/v1/account.py

@@ -13,6 +13,10 @@
 
 """Account v1 action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 
@@ -23,7 +27,7 @@
 class SetAccount(command.Command):
     _description = _("Set account 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(
             "--property",
@@ -37,7 +41,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.account_set(
             properties=parsed_args.property,
         )
@@ -46,19 +50,22 @@ def take_action(self, parsed_args):
 class ShowAccount(command.ShowOne):
     _description = _("Display account details")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         data = self.app.client_manager.object_store.account_show()
         if 'properties' in data:
             data['properties'] = format_columns.DictColumn(
                 data.pop('properties')
             )
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class UnsetAccount(command.Command):
     _description = _("Unset account 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(
             '--property',
@@ -73,7 +80,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.account_unset(
             properties=parsed_args.property,
         )

openstackclient/object/v1/container.py

@@ -15,7 +15,10 @@
 
 """Container v1 action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -31,7 +34,7 @@
 class CreateContainer(command.Lister):
     _description = _("Create new container")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--public',
@@ -51,7 +54,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, ...]]]:
         results = []
         for container in parsed_args.containers:
             if len(container) > 256:
@@ -84,7 +89,7 @@ def take_action(self, parsed_args):
 class DeleteContainer(command.Command):
     _description = _("Delete container")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--recursive',
@@ -101,7 +106,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         for container in parsed_args.containers:
             if parsed_args.recursive:
                 objs = self.app.client_manager.object_store.object_list(
@@ -120,7 +125,7 @@ def take_action(self, parsed_args):
 class ListContainer(command.Lister):
     _description = _("List containers")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--prefix",
@@ -147,7 +152,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, ...]]]:
         columns: tuple[str, ...] = ('Name',)
         if parsed_args.long:
             columns += ('Bytes', 'Count')
@@ -182,7 +189,7 @@ def take_action(self, parsed_args):
 class SaveContainer(command.Command):
     _description = _("Save container contents 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(
             'container',
@@ -191,7 +198,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.container_save(
             container=parsed_args.container,
         )
@@ -200,7 +207,7 @@ def take_action(self, parsed_args):
 class SetContainer(command.Command):
     _description = _("Set container 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(
             'container',
@@ -219,7 +226,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.container_set(
             parsed_args.container,
             properties=parsed_args.property,
@@ -229,7 +236,7 @@ def take_action(self, parsed_args):
 class ShowContainer(command.ShowOne):
     _description = _("Display container 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(
             'container',
@@ -238,20 +245,23 @@ 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]]:
         data = self.app.client_manager.object_store.container_show(
             container=parsed_args.container,
         )
         if 'properties' in data:
             data['properties'] = format_columns.DictColumn(data['properties'])
 
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class UnsetContainer(command.Command):
     _description = _("Unset container 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(
             'container',
@@ -271,7 +281,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.container_unset(
             parsed_args.container,
             properties=parsed_args.property,

openstackclient/object/v1/object.py

@@ -15,7 +15,10 @@
 
 """Object v1 action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -33,7 +36,7 @@
 class CreateObject(command.Lister):
     _description = _("Upload object to container")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'container',
@@ -56,7 +59,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.name:
             if len(parsed_args.objects) > 1:
                 msg = _(
@@ -98,7 +103,7 @@ def take_action(self, parsed_args):
 class DeleteObject(command.Command):
     _description = _("Delete object from container")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'container',
@@ -113,7 +118,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         for obj in parsed_args.objects:
             self.app.client_manager.object_store.object_delete(
                 container=parsed_args.container,
@@ -124,7 +129,7 @@ def take_action(self, parsed_args):
 class ListObject(command.Lister):
     _description = _("List objects")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "container",
@@ -161,7 +166,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, ...]]]:
         columns: tuple[str, ...] = ('Name',)
         if parsed_args.long:
             columns += ('Bytes', 'Hash', 'Content Type', 'Last Modified')
@@ -200,7 +207,7 @@ def take_action(self, parsed_args):
 class SaveObject(command.Command):
     _description = _("Save object 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(
             "--file",
@@ -222,7 +229,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.object_save(
             container=parsed_args.container,
             object=parsed_args.object,
@@ -233,7 +240,7 @@ def take_action(self, parsed_args):
 class SetObject(command.Command):
     _description = _("Set object 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(
             'container',
@@ -257,7 +264,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.object_set(
             parsed_args.container,
             parsed_args.object,
@@ -268,7 +275,7 @@ def take_action(self, parsed_args):
 class ShowObject(command.ShowOne):
     _description = _("Display object 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(
             'container',
@@ -282,21 +289,24 @@ 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]]:
         data = self.app.client_manager.object_store.object_show(
             container=parsed_args.container,
             object=parsed_args.object,
         )
         if 'properties' in data:
             data['properties'] = format_columns.DictColumn(data['properties'])
 
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class UnsetObject(command.Command):
     _description = _("Unset object 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(
             'container',
@@ -321,7 +331,7 @@ def get_parser(self, prog_name):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.object_unset(
             parsed_args.container,
             parsed_args.object,