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

openstackclient/identity/v3/credential.py

@@ -15,8 +15,12 @@
 
 """Identity v3 Credential action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -28,7 +32,7 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
-def _format_credential(credential):
+def _format_credential(credential: Any) -> tuple[tuple[str, ...], Any]:
     columns = (
         'blob',
         'id',
@@ -48,7 +52,7 @@ def _format_credential(credential):
 class CreateCredential(command.ShowOne):
     _description = _("Create new credential")
 
-    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',
@@ -75,8 +79,12 @@ class CreateCredential(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'
+        )
         user_id = identity_client.find_user(
             parsed_args.user, ignore_missing=False
         ).id
@@ -99,7 +107,7 @@ class CreateCredential(command.ShowOne):
 class DeleteCredential(command.Command):
     _description = _("Delete credential(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(
             'credential',
@@ -109,8 +117,10 @@ class DeleteCredential(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.credential:
             try:
@@ -137,7 +147,7 @@ class DeleteCredential(command.Command):
 class ListCredential(command.Lister):
     _description = _("List 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',
@@ -152,8 +162,12 @@ class ListCredential(command.Lister):
         )
         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'
+        )
 
         kwargs = {}
         if parsed_args.user:
@@ -190,7 +204,7 @@ class ListCredential(command.Lister):
 class SetCredential(command.Command):
     _description = _("Set credential 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(
             'credential',
@@ -224,8 +238,10 @@ class SetCredential(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'
+        )
 
         user_id = identity_client.find_user(
             parsed_args.user, ignore_missing=False
@@ -250,7 +266,7 @@ class SetCredential(command.Command):
 class ShowCredential(command.ShowOne):
     _description = _("Display credential 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(
             'credential',
@@ -259,8 +275,12 @@ class ShowCredential(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'
+        )
         credential = identity_client.get_credential(parsed_args.credential)
 
         return _format_credential(credential)

openstackclient/identity/v3/domain.py

@@ -15,9 +15,13 @@
 
 """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 import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -29,7 +33,7 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
-def _format_domain(domain):
+def _format_domain(domain: Any) -> tuple[tuple[str, ...], Any]:
     columns = (
         'id',
         'name',
@@ -57,7 +61,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 +95,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 +128,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 +138,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 +169,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 +184,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 +198,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 +216,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 +251,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 +274,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 +283,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,12 @@
 
 """Identity v3 Endpoint action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -28,7 +32,9 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
-def _format_endpoint(endpoint, service):
+def _format_endpoint(
+    endpoint: Any, service: Any
+) -> tuple[tuple[str, ...], Any]:
     columns = (
         'is_enabled',
         'id',
@@ -58,7 +64,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 +81,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 +98,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 +137,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 +164,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 +174,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 +207,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 +239,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:
@@ -318,7 +334,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 +353,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 +370,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,8 +413,10 @@ 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
         )
@@ -434,7 +452,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 +464,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
         )