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

openstackclient/identity/common.py

@@ -15,19 +15,25 @@
 
 """Common identity code"""
 
+import argparse
+from collections.abc import Callable
+from typing import Any, cast
+
 from keystoneclient import exceptions as identity_exc
 from keystoneclient.v3 import domains
 from keystoneclient.v3 import groups
 from keystoneclient.v3 import projects
 from keystoneclient.v3 import users
 from openstack import exceptions as sdk_exceptions
+from openstack.identity import v3 as identity
+from openstack.identity.v3 import service as _service
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient.i18n import _
 
 
-def find_service_in_list(service_list, service_id):
+def find_service_in_list(service_list: list[Any], service_id: str) -> Any:
     """Find a service by id in service list."""
 
     for service in service_list:
@@ -38,7 +44,7 @@ def find_service_in_list(service_list, service_id):
     )
 
 
-def find_service(identity_client, name_type_or_id):
+def find_service(identity_client: Any, name_type_or_id: str) -> Any:
     """Find a service by id, name or type."""
 
     try:
@@ -74,7 +80,9 @@ def find_service(identity_client, name_type_or_id):
         raise exceptions.CommandError(msg % name_type_or_id)
 
 
-def find_service_sdk(identity_client, name_type_or_id):
+def find_service_sdk(
+    identity_client: identity.Proxy, name_type_or_id: str
+) -> _service.Service:
     """Find a service by id, name or type."""
 
     try:
@@ -107,7 +115,7 @@ def find_service_sdk(identity_client, name_type_or_id):
     return service
 
 
-def get_resource(manager, name_type_or_id):
+def get_resource(manager: Any, name_type_or_id: str) -> Any:
     # NOTE (vishakha): Due to bug #1799153 and for any another related case
     # where GET resource API does not support the filter by name,
     # osc_lib.utils.find_resource() method cannot be used because that method
@@ -126,7 +134,7 @@ def get_resource(manager, name_type_or_id):
         raise exceptions.CommandError(msg % name_type_or_id)
 
 
-def get_resource_by_id(manager, resource_id):
+def get_resource_by_id(manager: Any, resource_id: str) -> Any:
     """Get resource by ID
 
     Raises CommandError if the resource is not found
@@ -138,7 +146,12 @@ def get_resource_by_id(manager, resource_id):
         raise exceptions.CommandError(msg.format(resource_id))
 
 
-def _get_token_resource(client, resource, parsed_name, parsed_domain=None):
+def _get_token_resource(
+    client: Any,
+    resource: str,
+    parsed_name: str,
+    parsed_domain: str | None = None,
+) -> str:
     """Peek into the user's auth token to get resource IDs
 
     Look into a user's token to try and find the ID of a domain, project or
@@ -174,25 +187,28 @@ def _get_token_resource(client, resource, parsed_name, parsed_domain=None):
         if isinstance(obj, list):
             for item in obj:
                 if item['name'] == parsed_name:
-                    return item['id']
+                    return cast(str, item['id'])
                 if item['id'] == parsed_name:
                     return parsed_name
             return parsed_name
         return obj['id'] if obj['name'] == parsed_name else parsed_name
     # diaper defense in case parsing the token fails
-    except Exception:  # noqa
+    except Exception:
         return parsed_name
 
 
-def find_domain(identity_client, name_or_id):
+def find_domain(identity_client: Any, name_or_id: str) -> domains.Domain:
     return _find_identity_resource(
         identity_client.domains, name_or_id, domains.Domain
     )
 
 
 def find_domain_id_sdk(
-    identity_client, name_or_id, *, validate_actor_existence=True
-):
+    identity_client: Any,
+    name_or_id: str,
+    *,
+    validate_actor_existence: bool = True,
+) -> str:
     return _find_sdk_id(
         identity_client.find_domain,
         name_or_id=name_or_id,
@@ -200,7 +216,11 @@ def find_domain_id_sdk(
     )
 
 
-def find_group(identity_client, name_or_id, domain_name_or_id=None):
+def find_group(
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
+) -> groups.Group:
     if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.groups, name_or_id, groups.Group
@@ -216,12 +236,12 @@ def find_group(identity_client, name_or_id, domain_name_or_id=None):
 
 
 def find_group_id_sdk(
-    identity_client,
-    name_or_id,
-    domain_name_or_id=None,
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
     *,
-    validate_actor_existence=True,
-):
+    validate_actor_existence: bool = True,
+) -> str:
     if domain_name_or_id is None:
         return _find_sdk_id(
             identity_client.find_group,
@@ -242,7 +262,11 @@ def find_group_id_sdk(
     )
 
 
-def find_project(identity_client, name_or_id, domain_name_or_id=None):
+def find_project(
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
+) -> projects.Project:
     if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.projects, name_or_id, projects.Project
@@ -257,13 +281,13 @@ def find_project(identity_client, name_or_id, domain_name_or_id=None):
 
 
 def find_project_id_sdk(
-    identity_client,
-    name_or_id,
-    domain_name_or_id=None,
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
     *,
-    validate_actor_existence=True,
-    validate_domain_actor_existence=None,
-):
+    validate_actor_existence: bool = True,
+    validate_domain_actor_existence: bool | None = None,
+) -> str:
     if domain_name_or_id is None:
         return _find_sdk_id(
             identity_client.find_project,
@@ -287,7 +311,11 @@ def find_project_id_sdk(
     )
 
 
-def find_user(identity_client, name_or_id, domain_name_or_id=None):
+def find_user(
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
+) -> users.User:
     if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.users, name_or_id, users.User
@@ -299,12 +327,12 @@ def find_user(identity_client, name_or_id, domain_name_or_id=None):
 
 
 def find_user_id_sdk(
-    identity_client,
-    name_or_id,
-    domain_name_or_id=None,
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
     *,
-    validate_actor_existence=True,
-):
+    validate_actor_existence: bool = True,
+) -> str:
     if domain_name_or_id is None:
         return _find_sdk_id(
             identity_client.find_user,
@@ -325,8 +353,11 @@ def find_user_id_sdk(
 
 
 def _find_identity_resource(
-    identity_client_manager, name_or_id, resource_type, **kwargs
-):
+    identity_client_manager: Any,
+    name_or_id: str,
+    resource_type: Any,
+    **kwargs: Any,
+) -> Any:
     """Find a specific identity resource.
 
     Using keystoneclient's manager, attempt to find a specific resource by its
@@ -365,8 +396,12 @@ def _find_identity_resource(
 
 
 def _find_sdk_id(
-    find_command, name_or_id, *, validate_actor_existence=True, **kwargs
-):
+    find_command: Callable[..., Any],
+    name_or_id: str,
+    *,
+    validate_actor_existence: bool = True,
+    **kwargs: Any,
+) -> str:
     try:
         resource = find_command(
             name_or_id=name_or_id, ignore_missing=False, **kwargs
@@ -377,10 +412,10 @@ def _find_sdk_id(
         if not validate_actor_existence:
             return name_or_id
         raise exceptions.CommandError from exc
-    return resource.id
+    return cast(str, resource.id)
 
 
-def add_user_domain_option_to_parser(parser):
+def add_user_domain_option_to_parser(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         '--user-domain',
         metavar='<user-domain>',
@@ -392,7 +427,7 @@ def add_user_domain_option_to_parser(parser):
     )
 
 
-def add_group_domain_option_to_parser(parser):
+def add_group_domain_option_to_parser(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         '--group-domain',
         metavar='<group-domain>',
@@ -404,21 +439,21 @@ def add_group_domain_option_to_parser(parser):
     )
 
 
-def add_project_domain_option_to_parser(parser, enhance_help=lambda _h: _h):
+def add_project_domain_option_to_parser(
+    parser: argparse.ArgumentParser,
+) -> None:
     parser.add_argument(
         '--project-domain',
         metavar='<project-domain>',
-        help=enhance_help(
-            _(
-                'Domain the project belongs to (name or ID). This '
-                'can be used in case collisions between project '
-                'names exist.'
-            )
+        help=_(
+            'Domain the project belongs to (name or ID). This '
+            'can be used in case collisions between project '
+            'names exist.'
         ),
     )
 
 
-def add_role_domain_option_to_parser(parser):
+def add_role_domain_option_to_parser(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         '--role-domain',
         metavar='<role-domain>',
@@ -430,7 +465,7 @@ def add_role_domain_option_to_parser(parser):
     )
 
 
-def add_inherited_option_to_parser(parser):
+def add_inherited_option_to_parser(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         '--inherited',
         action='store_true',
@@ -441,7 +476,7 @@ def add_inherited_option_to_parser(parser):
     )
 
 
-def add_resource_option_to_parser(parser):
+def add_resource_option_to_parser(parser: argparse.ArgumentParser) -> None:
     immutable_group = parser.add_mutually_exclusive_group()
     immutable_group.add_argument(
         '--immutable',

openstackclient/identity/v2_0/catalog.py

@@ -13,8 +13,10 @@
 
 """Identity v2 Service Catalog action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
-import typing as ty
+from typing import Any
 
 from cliff import columns as cliff_columns
 from osc_lib import exceptions
@@ -27,8 +29,8 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-class EndpointsColumn(cliff_columns.FormattableColumn[ty.Any]):
-    def human_readable(self):
+class EndpointsColumn(cliff_columns.FormattableColumn[Any]):
+    def human_readable(self) -> str:
         if not self._value:
             return ""
         ret = ''
@@ -47,7 +49,9 @@ class EndpointsColumn(cliff_columns.FormattableColumn[ty.Any]):
 class ListCatalog(command.Lister):
     _description = _("List services in the service catalog")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         # Trigger auth if it has not happened yet
         auth_ref = self.app.client_manager.auth_ref
         if not auth_ref:
@@ -75,7 +79,7 @@ class ListCatalog(command.Lister):
 class ShowCatalog(command.ShowOne):
     _description = _("Display service catalog 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',
@@ -84,7 +88,9 @@ class ShowCatalog(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         # Trigger auth if it has not happened yet
         auth_ref = self.app.client_manager.auth_ref
         if not auth_ref:
@@ -108,4 +114,5 @@ class ShowCatalog(command.ShowOne):
             LOG.error(_('service %s not found\n'), parsed_args.service)
             return ((), ())
 
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data

openstackclient/identity/v2_0/ec2creds.py

@@ -16,7 +16,10 @@
 
 """Identity v2 EC2 Credentials 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 CreateEC2Creds(command.ShowOne):
     _description = _("Create EC2 credentials")
 
-    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',
@@ -51,7 +54,9 @@ class CreateEC2Creds(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:
@@ -79,13 +84,14 @@ class CreateEC2Creds(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
 
 
 class DeleteEC2Creds(command.Command):
     _description = _("Delete EC2 credentials")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'access_keys',
@@ -100,7 +106,7 @@ class DeleteEC2Creds(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.user:
@@ -138,7 +144,7 @@ class DeleteEC2Creds(command.Command):
 class ListEC2Creds(command.Lister):
     _description = _("List EC2 credentials")
 
-    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',
@@ -147,7 +153,9 @@ class ListEC2Creds(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
 
         if parsed_args.user:
@@ -179,7 +187,7 @@ class ListEC2Creds(command.Lister):
 class ShowEC2Creds(command.ShowOne):
     _description = _("Display EC2 credentials 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(
             'access_key',
@@ -193,7 +201,9 @@ class ShowEC2Creds(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.user:
@@ -213,4 +223,5 @@ class ShowEC2Creds(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

openstackclient/identity/v2_0/endpoint.py

@@ -15,7 +15,10 @@
 
 """Endpoint 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 CreateEndpoint(command.ShowOne):
     _description = _("Create new endpoint")
 
-    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',
@@ -61,7 +64,9 @@ class CreateEndpoint(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
         service = common.find_service(identity_client, parsed_args.service)
         endpoint = identity_client.endpoints.create(
@@ -76,13 +81,14 @@ class CreateEndpoint(command.ShowOne):
         info.update(endpoint._info)
         info['service_name'] = service.name
         info['service_type'] = service.type
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class DeleteEndpoint(command.Command):
     _description = _("Delete endpoint(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(
             'endpoints',
@@ -92,7 +98,7 @@ class DeleteEndpoint(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
@@ -121,7 +127,7 @@ class DeleteEndpoint(command.Command):
 class ListEndpoint(command.Lister):
     _description = _("List endpoints")
 
-    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',
@@ -131,7 +137,9 @@ class ListEndpoint(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
 
         columns: tuple[str, ...] = (
@@ -168,7 +176,7 @@ class ListEndpoint(command.Lister):
 class ShowEndpoint(command.ShowOne):
     _description = _("Display endpoint 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(
             'endpoint_or_service',
@@ -180,7 +188,9 @@ class ShowEndpoint(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
         data = identity_client.endpoints.list()
         match = None
@@ -196,9 +206,11 @@ class ShowEndpoint(command.ShowOne):
                 if ep.service_id == service.id:
                     match = ep
         if match is None:
-            return None
+            return ((), ())
+
         info = {}
         info.update(match._info)
         info['service_name'] = service.name
         info['service_type'] = service.type
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data