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

openstackclient/identity/v2_0/project.py

@@ -15,7 +15,10 @@
 
 """Identity v2 Project action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from keystoneauth1 import exceptions as ks_exc
 from osc_lib.cli import format_columns
@@ -33,7 +36,7 @@ LOG = logging.getLogger(__name__)
 class CreateProject(command.ShowOne):
     _description = _("Create new project")
 
-    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',
@@ -73,7 +76,9 @@ class CreateProject(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
 
         enabled = True
@@ -102,7 +107,8 @@ class CreateProject(command.ShowOne):
 
         # TODO(stevemar): Remove the line below when we support multitenancy
         project._info.pop('parent_id', None)
-        return zip(*sorted(project._info.items()))
+        col_headers, col_data = zip(*sorted(project._info.items()))
+        return col_headers, col_data
 
 
 class DeleteProject(command.Command):
@@ -115,7 +121,7 @@ class DeleteProject(command.Command):
         "regardless."
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'projects',
@@ -125,7 +131,7 @@ class DeleteProject(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
 
         errors = 0
@@ -158,7 +164,7 @@ class DeleteProject(command.Command):
 class ListProject(command.Lister):
     _description = _("List projects")
 
-    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',
@@ -177,7 +183,9 @@ class ListProject(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         columns: tuple[str, ...] = ('ID', 'Name')
         if parsed_args.long:
             columns += ('Description', 'Enabled')
@@ -200,7 +208,7 @@ class ListProject(command.Lister):
 class SetProject(command.Command):
     _description = _("Set project 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(
             'project',
@@ -240,7 +248,7 @@ class SetProject(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
 
         project = utils.find_resource(
@@ -272,7 +280,7 @@ class SetProject(command.Command):
 class ShowProject(command.ShowOne):
     _description = _("Display project 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(
             'project',
@@ -281,7 +289,9 @@ class ShowProject(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
 
         info = {}
@@ -324,13 +334,14 @@ class ShowProject(command.ShowOne):
                     properties[k] = v
 
         info['properties'] = format_columns.DictColumn(properties)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class UnsetProject(command.Command):
     _description = _("Unset project 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(
             'project',
@@ -350,7 +361,7 @@ class UnsetProject(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
         project = utils.find_resource(
             identity_client.tenants,

openstackclient/identity/v2_0/role.py

@@ -15,7 +15,10 @@
 
 """Identity v2 Role action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from keystoneauth1 import exceptions as ks_exc
 from osc_lib import exceptions
@@ -31,7 +34,7 @@ LOG = logging.getLogger(__name__)
 class AddRole(command.ShowOne):
     _description = _("Add role to project:user")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'role',
@@ -52,7 +55,9 @@ class AddRole(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
         role = utils.find_resource(identity_client.roles, parsed_args.role)
         project = utils.find_resource(
@@ -68,13 +73,14 @@ class AddRole(command.ShowOne):
 
         info = {}
         info.update(role._info)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class CreateRole(command.ShowOne):
     _description = _("Create new role")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'role_name',
@@ -88,7 +94,9 @@ class CreateRole(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
         try:
             role = identity_client.roles.create(parsed_args.role_name)
@@ -104,13 +112,14 @@ class CreateRole(command.ShowOne):
 
         info = {}
         info.update(role._info)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class DeleteRole(command.Command):
     _description = _("Delete role(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(
             'roles',
@@ -120,7 +129,7 @@ class DeleteRole(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
 
         errors = 0
@@ -153,7 +162,9 @@ class DeleteRole(command.Command):
 class ListRole(command.Lister):
     _description = _("List roles")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         identity_client = self.app.client_manager.identity
 
         columns = ('ID', 'Name')
@@ -175,7 +186,7 @@ class ListRole(command.Lister):
 class RemoveRole(command.Command):
     _description = _("Remove role from project : user")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'role',
@@ -196,7 +207,7 @@ class RemoveRole(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
         role = utils.find_resource(identity_client.roles, parsed_args.role)
         project = utils.find_resource(
@@ -210,7 +221,7 @@ class RemoveRole(command.Command):
 class ShowRole(command.ShowOne):
     _description = _("Display role 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(
             'role',
@@ -219,10 +230,13 @@ class ShowRole(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
         role = utils.find_resource(identity_client.roles, parsed_args.role)
 
         info = {}
         info.update(role._info)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data

openstackclient/identity/v2_0/role_assignment.py

@@ -13,17 +13,21 @@
 
 """Identity v2 Assignment action implementations"""
 
+import argparse
+from collections.abc import Iterable
+from typing import Any
+
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
-from openstackclient.i18n import _  # noqa
+from openstackclient.i18n import _
 
 
 class ListRoleAssignment(command.Lister):
     _description = _("List role assignments")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--user',
@@ -55,7 +59,9 @@ class ListRoleAssignment(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         identity_client = self.app.client_manager.identity
         auth_ref = self.app.client_manager.auth_ref
 

openstackclient/identity/v2_0/service.py

@@ -15,7 +15,10 @@
 
 """Service action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -31,7 +34,7 @@ LOG = logging.getLogger(__name__)
 class CreateService(command.ShowOne):
     _description = _("Create new service")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'type',
@@ -50,7 +53,9 @@ class CreateService(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
 
         name = parsed_args.name
@@ -64,13 +69,14 @@ class CreateService(command.ShowOne):
 
         info = {}
         info.update(service._info)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class DeleteService(command.Command):
     _description = _("Delete service(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(
             'services',
@@ -80,7 +86,7 @@ class DeleteService(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
 
         result = 0
@@ -110,7 +116,7 @@ class DeleteService(command.Command):
 class ListService(command.Lister):
     _description = _("List services")
 
-    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',
@@ -120,7 +126,9 @@ class ListService(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         columns: tuple[str, ...] = ('ID', 'Name', 'Type')
         if parsed_args.long:
             columns += ('Description',)
@@ -134,7 +142,7 @@ class ListService(command.Lister):
 class ShowService(command.ShowOne):
     _description = _("Display service 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(
             'service',
@@ -149,7 +157,9 @@ class ShowService(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
         auth_ref = self.app.client_manager.auth_ref
 
@@ -163,7 +173,8 @@ class ShowService(command.ShowOne):
                     # FIXME(stephenfin): The return type for this in ksa is
                     # wrong
                     info.update(service_endpoints[0])  # type: ignore
-                    return zip(*sorted(info.items()))
+                    col_headers, col_data = zip(*sorted(info.items()))
+                    return col_headers, col_data
 
             msg = _(
                 "No service catalog with a type, name or ID of '%s' exists."
@@ -173,4 +184,5 @@ class ShowService(command.ShowOne):
             service = common.find_service(identity_client, parsed_args.service)
             info = {}
             info.update(service._info)
-            return zip(*sorted(info.items()))
+            col_headers, col_data = zip(*sorted(info.items()))
+            return col_headers, col_data

openstackclient/identity/v2_0/token.py

@@ -15,6 +15,10 @@
 
 """Identity v2 Token action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
 from osc_lib import exceptions
 
 from openstackclient import command
@@ -27,11 +31,13 @@ class IssueToken(command.ShowOne):
     # scoped token is optional
     required_scope = False
 
-    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[Any]]:
         auth_ref = self.app.client_manager.auth_ref
         if not auth_ref:
             raise exceptions.AuthorizationFailure(
@@ -49,13 +55,14 @@ class IssueToken(command.ShowOne):
             data['project_id'] = auth_ref.project_id
         if auth_ref.user_id:
             data['user_id'] = auth_ref.user_id
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class RevokeToken(command.Command):
     _description = _("Revoke existing token")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'token',
@@ -64,7 +71,7 @@ class RevokeToken(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
 
         identity_client.tokens.delete(parsed_args.token)

openstackclient/identity/v2_0/user.py

@@ -15,8 +15,11 @@
 
 """Identity v2.0 User action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import functools
 import logging
+from typing import Any, cast
 
 from cliff import columns as cliff_columns
 from keystoneauth1 import exceptions as ks_exc
@@ -41,16 +44,16 @@ class ProjectColumn(cliff_columns.FormattableColumn[str]):
     ``functools.partial(ProjectColumn, project_cache)``.
     """
 
-    def __init__(self, value, project_cache=None):
+    def __init__(self, value: str, project_cache: Any = None) -> None:
         super().__init__(value)
         self.project_cache = project_cache or {}
 
-    def human_readable(self):
+    def human_readable(self) -> str:
         project = self._value
         if not project:
             return ""
         if project in self.project_cache.keys():
-            return self.project_cache[project].name
+            return cast(str, self.project_cache[project].name)
         else:
             return project
 
@@ -58,7 +61,7 @@ class ProjectColumn(cliff_columns.FormattableColumn[str]):
 class CreateUser(command.ShowOne):
     _description = _("Create new user")
 
-    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',
@@ -104,7 +107,9 @@ class CreateUser(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
 
         if parsed_args.project:
@@ -155,13 +160,14 @@ class CreateUser(command.ShowOne):
 
         info = {}
         info.update(user._info)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class DeleteUser(command.Command):
     _description = _("Delete user(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(
             'users',
@@ -171,7 +177,7 @@ class DeleteUser(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
 
         errors = 0
@@ -204,7 +210,7 @@ class DeleteUser(command.Command):
 class ListUser(command.Lister):
     _description = _("List users")
 
-    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',
@@ -219,7 +225,9 @@ class ListUser(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         identity_client = self.app.client_manager.identity
         formatters = {}
         project = None
@@ -278,7 +286,7 @@ class ListUser(command.Lister):
 class SetUser(command.Command):
     _description = _("Set user 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(
             'user',
@@ -324,7 +332,7 @@ class SetUser(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
 
         if parsed_args.password_prompt:
@@ -376,7 +384,7 @@ class SetUser(command.Command):
 class ShowUser(command.ShowOne):
     _description = _("Display user 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(
             'user',
@@ -385,7 +393,9 @@ class ShowUser(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
 
         info = {}
@@ -417,4 +427,5 @@ class ShowUser(command.ShowOne):
         if 'tenant_id' in info:
             info.update({'project_id': info.pop('tenant_id')})
 
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data