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

openstackclient/identity/v3/domain.py

@@ -15,9 +15,14 @@
 
 """Identity v3 Domain action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from openstack import exceptions as sdk_exceptions
+from openstack.identity.v3 import domain as _domain
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -25,11 +30,12 @@ from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _format_domain(domain):
+def _format_domain(
+    domain: _domain.Domain,
+) -> tuple[tuple[str, ...], tuple[Any, ...]]:
     columns = (
         'id',
         'name',
@@ -57,7 +63,7 @@ def _format_domain(domain):
 class CreateDomain(command.ShowOne):
     _description = _("Create new domain")
 
-    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',
@@ -91,8 +97,12 @@ class CreateDomain(command.ShowOne):
         common.add_resource_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         options = {}
         if parsed_args.immutable is not None:
@@ -120,7 +130,7 @@ class CreateDomain(command.ShowOne):
 class DeleteDomain(command.Command):
     _description = _("Delete domain(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(
             'domain',
@@ -130,8 +140,10 @@ class DeleteDomain(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         result = 0
         for i in parsed_args.domain:
             try:
@@ -159,7 +171,7 @@ class DeleteDomain(command.Command):
 class ListDomain(command.Lister):
     _description = _("List domains")
 
-    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',
@@ -174,7 +186,12 @@ class ListDomain(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 = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         kwargs = {}
         if parsed_args.name:
             kwargs['name'] = parsed_args.name
@@ -183,9 +200,7 @@ class ListDomain(command.Lister):
 
         columns = ('id', 'name', 'is_enabled', 'description')
         column_headers = ('ID', 'Name', 'Enabled', 'Description')
-        data = self.app.client_manager.sdk_connection.identity.domains(
-            **kwargs
-        )
+        data = identity_client.domains(**kwargs)
 
         return (
             column_headers,
@@ -203,7 +218,7 @@ class ListDomain(command.Lister):
 class SetDomain(command.Command):
     _description = _("Set domain 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(
             'domain',
@@ -238,8 +253,10 @@ class SetDomain(command.Command):
         common.add_resource_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         domain = identity_client.find_domain(
             parsed_args.domain, ignore_missing=False
         )
@@ -259,7 +276,7 @@ class SetDomain(command.Command):
 class ShowDomain(command.ShowOne):
     _description = _("Display domain 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(
             'domain',
@@ -268,8 +285,12 @@ class ShowDomain(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         domain = identity_client.find_domain(
             parsed_args.domain, ignore_missing=False
         )

openstackclient/identity/v3/ec2creds.py

@@ -12,7 +12,10 @@
 
 """Identity v3 EC2 Credentials action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any, cast
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -25,7 +28,9 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
-def _determine_ec2_user(parsed_args, client_manager):
+def _determine_ec2_user(
+    parsed_args: argparse.Namespace, client_manager: Any
+) -> str:
     """Determine a user several different ways.
 
     Assumes parsed_args has user and user_domain arguments. Attempts to find
@@ -53,13 +58,13 @@ def _determine_ec2_user(parsed_args, client_manager):
     else:
         # Get the user from the current auth
         user = client_manager.auth_ref.user_id
-    return user
+    return cast(str, user)
 
 
 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',
@@ -81,7 +86,9 @@ class CreateEC2Creds(command.ShowOne):
         common.add_project_domain_option_to_parser(parser)
         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
         client_manager = self.app.client_manager
         user = _determine_ec2_user(parsed_args, client_manager)
@@ -115,13 +122,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_key',
@@ -137,7 +145,7 @@ class DeleteEC2Creds(command.Command):
         common.add_user_domain_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client_manager = self.app.client_manager
         user = _determine_ec2_user(parsed_args, client_manager)
         result = 0
@@ -166,7 +174,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',
@@ -176,7 +184,9 @@ class ListEC2Creds(command.Lister):
         common.add_user_domain_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         client_manager = self.app.client_manager
         user = _determine_ec2_user(parsed_args, client_manager)
 
@@ -200,7 +210,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',
@@ -215,7 +225,9 @@ class ShowEC2Creds(command.ShowOne):
         common.add_user_domain_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         client_manager = self.app.client_manager
         user = _determine_ec2_user(parsed_args, client_manager)
         creds = client_manager.identity.ec2.get(user, parsed_args.access_key)
@@ -226,4 +238,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/v3/endpoint.py

@@ -15,8 +15,14 @@
 
 """Identity v3 Endpoint action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack.identity.v3 import endpoint as _endpoint
+from openstack.identity.v3 import service as _service
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -24,11 +30,12 @@ from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _format_endpoint(endpoint, service):
+def _format_endpoint(
+    endpoint: _endpoint.Endpoint, service: _service.Service
+) -> tuple[tuple[str, ...], Any]:
     columns = (
         'is_enabled',
         'id',
@@ -58,7 +65,7 @@ def _format_endpoint(endpoint, service):
 class AddProjectToEndpoint(command.Command):
     _description = _("Associate a project to an 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(
             'endpoint',
@@ -75,7 +82,7 @@ class AddProjectToEndpoint(command.Command):
         common.add_project_domain_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.identity
 
         endpoint = utils.find_resource(client.endpoints, parsed_args.endpoint)
@@ -92,7 +99,7 @@ class AddProjectToEndpoint(command.Command):
 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',
@@ -131,8 +138,12 @@ class CreateEndpoint(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         service = common.find_service_sdk(identity_client, parsed_args.service)
 
         kwargs = {}
@@ -154,7 +165,7 @@ class CreateEndpoint(command.ShowOne):
 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(
             'endpoint',
@@ -164,8 +175,10 @@ class DeleteEndpoint(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         result = 0
         for i in parsed_args.endpoint:
             try:
@@ -195,7 +208,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(
             '--service',
@@ -227,8 +240,12 @@ class ListEndpoint(command.Lister):
         common.add_project_domain_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         endpoint = None
         if parsed_args.endpoint:
@@ -253,54 +270,65 @@ class ListEndpoint(command.Lister):
                 domain_id=project_domain_id,
             )
 
+        # FIXME(stephenfin): This belongs under the project list command
         if endpoint:
             column_headers: tuple[str, ...] = ('ID', 'Name')
             columns: tuple[str, ...] = ('id', 'name')
-            data = identity_client.endpoint_projects(endpoint=endpoint.id)
-        else:
-            column_headers = (
-                'ID',
-                'Region',
-                'Service Name',
-                'Service Type',
-                'Enabled',
-                'Interface',
-                'URL',
+            projects = identity_client.endpoint_projects(endpoint=endpoint.id)
+            return (
+                column_headers,
+                (
+                    utils.get_item_properties(
+                        s,
+                        columns,
+                        formatters={},
+                    )
+                    for s in projects
+                ),
             )
-            columns = (
-                'id',
-                'region_id',
-                'service_name',
-                'service_type',
-                'is_enabled',
-                'interface',
-                'url',
+
+        column_headers = (
+            'ID',
+            'Region',
+            'Service Name',
+            'Service Type',
+            'Enabled',
+            'Interface',
+            'URL',
+        )
+        columns = (
+            'id',
+            'region_id',
+            'service_name',
+            'service_type',
+            'is_enabled',
+            'interface',
+            'url',
+        )
+        kwargs = {}
+        if parsed_args.service:
+            service = common.find_service_sdk(
+                identity_client, parsed_args.service
             )
-            kwargs = {}
-            if parsed_args.service:
-                service = common.find_service_sdk(
-                    identity_client, parsed_args.service
-                )
-                kwargs['service_id'] = service.id
-            if parsed_args.interface:
-                kwargs['interface'] = parsed_args.interface
-            if parsed_args.region:
-                region = identity_client.get_region(parsed_args.region)
-                kwargs['region_id'] = region.id
-
-            if project_id:
-                data = list(
-                    identity_client.project_endpoints(project=project_id)
-                )
-            else:
-                data = list(identity_client.endpoints(**kwargs))
+            kwargs['service_id'] = service.id
+        if parsed_args.interface:
+            kwargs['interface'] = parsed_args.interface
+        if parsed_args.region:
+            region = identity_client.get_region(parsed_args.region)
+            kwargs['region_id'] = region.id
 
-            for ep in data:
-                service = identity_client.find_service(
-                    ep.service_id, ignore_missing=False
-                )
-                ep.service_name = getattr(service, 'name', '')
-                ep.service_type = service.type
+        data: list[_endpoint.Endpoint]
+        if project_id:
+            data = list(identity_client.project_endpoints(project=project_id))
+        else:
+            data = list(identity_client.endpoints(**kwargs))
+
+        for ep in data:
+            service = identity_client.find_service(
+                ep.service_id, ignore_missing=False
+            )
+            setattr(ep, 'service_name', getattr(service, 'name', ''))
+            setattr(ep, 'service_type', service.type)
 
         return (
             column_headers,
@@ -318,7 +346,7 @@ class ListEndpoint(command.Lister):
 class RemoveProjectFromEndpoint(command.Command):
     _description = _("Dissociate a project from an 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(
             'endpoint',
@@ -337,7 +365,7 @@ class RemoveProjectFromEndpoint(command.Command):
         common.add_project_domain_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.identity
 
         endpoint = utils.find_resource(client.endpoints, parsed_args.endpoint)
@@ -354,7 +382,7 @@ class RemoveProjectFromEndpoint(command.Command):
 class SetEndpoint(command.Command):
     _description = _("Set endpoint 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(
             'endpoint',
@@ -397,13 +425,15 @@ class SetEndpoint(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         endpoint = identity_client.find_endpoint(
             parsed_args.endpoint, ignore_missing=False
         )
 
-        kwargs = {}
+        kwargs: dict[str, object] = {}
 
         if parsed_args.service:
             service = common.find_service_sdk(
@@ -434,7 +464,7 @@ class SetEndpoint(command.Command):
 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',
@@ -446,8 +476,12 @@ class ShowEndpoint(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         endpoint = identity_client.find_endpoint(
             parsed_args.endpoint, ignore_missing=False
         )