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

openstackclient/identity/v3/endpoint_group.py

@@ -13,8 +13,11 @@
 
 """Identity v3 Endpoint Group action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import json
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -30,7 +33,7 @@ LOG = logging.getLogger(__name__)
 class _FiltersReader:
     _description = _("Helper class capable of reading filters from files")
 
-    def _read_filters(self, path):
+    def _read_filters(self, path: str) -> Any:
         """Read and parse rules from path
 
         Expect the file to contain a valid JSON structure.
@@ -62,7 +65,7 @@ class _FiltersReader:
 class AddProjectToEndpointGroup(command.Command):
     _description = _("Add a project to an endpoint group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'endpointgroup',
@@ -77,7 +80,7 @@ class AddProjectToEndpointGroup(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
 
         endpointgroup = utils.find_resource(
@@ -96,7 +99,7 @@ class AddProjectToEndpointGroup(command.Command):
 class CreateEndpointGroup(command.ShowOne, _FiltersReader):
     _description = _("Create new endpoint group")
 
-    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',
@@ -114,7 +117,9 @@ class CreateEndpointGroup(command.ShowOne, _FiltersReader):
         )
         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
 
         filters = None
@@ -130,13 +135,14 @@ class CreateEndpointGroup(command.ShowOne, _FiltersReader):
         info = {}
         endpoint_group._info.pop('links')
         info.update(endpoint_group._info)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class DeleteEndpointGroup(command.Command):
     _description = _("Delete endpoint group(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(
             'endpointgroup',
@@ -146,7 +152,7 @@ class DeleteEndpointGroup(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
         for i in parsed_args.endpointgroup:
@@ -176,7 +182,7 @@ class DeleteEndpointGroup(command.Command):
 class ListEndpointGroup(command.Lister):
     _description = _("List endpoint groups")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         list_group = parser.add_mutually_exclusive_group()
         list_group.add_argument(
@@ -196,7 +202,9 @@ class ListEndpointGroup(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         client = self.app.client_manager.identity
 
         endpointgroup = None
@@ -241,7 +249,7 @@ class ListEndpointGroup(command.Lister):
 class RemoveProjectFromEndpointGroup(command.Command):
     _description = _("Remove project from endpoint group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'endpointgroup',
@@ -256,7 +264,7 @@ class RemoveProjectFromEndpointGroup(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
 
         endpointgroup = utils.find_resource(
@@ -275,7 +283,7 @@ class RemoveProjectFromEndpointGroup(command.Command):
 class SetEndpointGroup(command.Command, _FiltersReader):
     _description = _("Set endpoint group 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(
             'endpointgroup',
@@ -300,7 +308,7 @@ class SetEndpointGroup(command.Command, _FiltersReader):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
         endpointgroup = utils.find_resource(
             identity_client.endpoint_groups, parsed_args.endpointgroup
@@ -321,7 +329,7 @@ class SetEndpointGroup(command.Command, _FiltersReader):
 class ShowEndpointGroup(command.ShowOne):
     _description = _("Display endpoint group 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(
             'endpointgroup',
@@ -330,7 +338,9 @@ class ShowEndpointGroup(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
         endpoint_group = utils.find_resource(
             identity_client.endpoint_groups, parsed_args.endpointgroup
@@ -339,4 +349,5 @@ class ShowEndpointGroup(command.ShowOne):
         info = {}
         endpoint_group._info.pop('links')
         info.update(endpoint_group._info)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data

openstackclient/identity/v3/federation_protocol.py

@@ -14,19 +14,25 @@
 
 """Identity v3 Protocols actions implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack.identity.v3 import federation_protocol as _federation_protocol
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _format_protocol(protocol):
+def _format_protocol(
+    protocol: _federation_protocol.FederationProtocol,
+) -> tuple[tuple[str, ...], tuple[Any, ...]]:
     columns = ('name', 'idp_id', 'mapping_id')
     column_headers = ('id', 'identity_provider', 'mapping')
     return (
@@ -38,7 +44,7 @@ def _format_protocol(protocol):
 class CreateProtocol(command.ShowOne):
     _description = _("Create new federation protocol")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'federation_protocol',
@@ -66,12 +72,16 @@ class CreateProtocol(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'
+        )
 
         protocol = identity_client.create_federation_protocol(
             name=parsed_args.federation_protocol,
-            idp_id=parsed_args.identity_provider,
+            idp=parsed_args.identity_provider,
             mapping_id=parsed_args.mapping,
         )
 
@@ -81,7 +91,7 @@ class CreateProtocol(command.ShowOne):
 class DeleteProtocol(command.Command):
     _description = _("Delete federation protocol(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(
             'federation_protocol',
@@ -101,14 +111,16 @@ class DeleteProtocol(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.federation_protocol:
             try:
                 identity_client.delete_federation_protocol(
-                    idp_id=parsed_args.identity_provider,
+                    idp=parsed_args.identity_provider,
                     protocol=i,
                     ignore_missing=False,
                 )
@@ -134,7 +146,7 @@ class DeleteProtocol(command.Command):
 class ListProtocols(command.Lister):
     _description = _("List federation protocols")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--identity-provider',
@@ -145,8 +157,12 @@ class ListProtocols(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'
+        )
 
         protocols = identity_client.federation_protocols(
             parsed_args.identity_provider
@@ -163,7 +179,7 @@ class ListProtocols(command.Lister):
 class SetProtocol(command.Command):
     _description = _("Set federation protocol 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(
             'federation_protocol',
@@ -186,8 +202,12 @@ class SetProtocol(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
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {'idp_id': parsed_args.identity_provider}
         if parsed_args.federation_protocol:
@@ -202,7 +222,7 @@ class SetProtocol(command.Command):
 class ShowProtocol(command.ShowOne):
     _description = _("Display federation protocol 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(
             'federation_protocol',
@@ -220,11 +240,15 @@ class ShowProtocol(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'
+        )
 
         protocol = identity_client.get_federation_protocol(
-            idp_id=parsed_args.identity_provider,
+            idp=parsed_args.identity_provider,
             protocol=parsed_args.federation_protocol,
         )
         return _format_protocol(protocol)

openstackclient/identity/v3/group.py

@@ -15,9 +15,14 @@
 
 """Group action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from openstack import exceptions as sdk_exc
+from openstack.identity.v3 import group as _group
+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_group(group):
+def _format_group(
+    group: _group.Group,
+) -> tuple[tuple[str, ...], Iterable[Any]]:
     columns = (
         'description',
         'domain_id',
@@ -51,7 +57,7 @@ def _format_group(group):
 class AddUserToGroup(command.Command):
     _description = _("Add user to group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'group',
@@ -71,8 +77,10 @@ class AddUserToGroup(command.Command):
         common.add_user_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) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         group_id = common.find_group_id_sdk(
             identity_client, parsed_args.group, parsed_args.group_domain
@@ -111,7 +119,7 @@ class AddUserToGroup(command.Command):
 class CheckUserInGroup(command.Command):
     _description = _("Check user membership in group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'group',
@@ -127,8 +135,10 @@ class CheckUserInGroup(command.Command):
         common.add_user_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) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         user_id = common.find_user_id_sdk(
             identity_client,
@@ -168,7 +178,7 @@ class CheckUserInGroup(command.Command):
 class CreateGroup(command.ShowOne):
     _description = _("Create new group")
 
-    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',
@@ -192,8 +202,12 @@ class CreateGroup(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'
+        )
 
         kwargs = {}
         if parsed_args.name:
@@ -230,7 +244,7 @@ class CreateGroup(command.ShowOne):
 class DeleteGroup(command.Command):
     _description = _("Delete group(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(
             'groups',
@@ -245,8 +259,10 @@ class DeleteGroup(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'
+        )
 
         errors = 0
         for group in parsed_args.groups:
@@ -277,7 +293,7 @@ class DeleteGroup(command.Command):
 class ListGroup(command.Lister):
     _description = _("List groups")
 
-    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',
@@ -298,8 +314,12 @@ class ListGroup(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'
+        )
 
         domain = None
         if parsed_args.domain:
@@ -307,25 +327,21 @@ class ListGroup(command.Lister):
                 identity_client, parsed_args.domain
             )
 
-        data = []
-        if parsed_args.user:
+        if not parsed_args.user:
+            if domain:
+                data = list(identity_client.groups(domain_id=domain))
+            else:
+                data = list(identity_client.groups())
+        else:
             user = common.find_user_id_sdk(
                 identity_client,
                 parsed_args.user,
                 parsed_args.user_domain,
             )
-            if domain:
-                # NOTE(0weng): The API doesn't actually support filtering
-                # additionally by domain_id, so this doesn't really do
-                # anything.
-                data = identity_client.user_groups(user, domain_id=domain)
-            else:
-                data = identity_client.user_groups(user)
-        else:
-            if domain:
-                data = identity_client.groups(domain_id=domain)
-            else:
-                data = identity_client.groups()
+            # NOTE(0weng): The API doesn't actually support filtering
+            # additionally by domain_id, so this doesn't really do
+            # anything.
+            data = list(identity_client.user_groups(user))
 
         # List groups
         columns: tuple[str, ...] = ('ID', 'Name')
@@ -348,7 +364,7 @@ class ListGroup(command.Lister):
 class RemoveUserFromGroup(command.Command):
     _description = _("Remove user from group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'group',
@@ -368,8 +384,10 @@ class RemoveUserFromGroup(command.Command):
         common.add_user_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) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         group_id = common.find_group_id_sdk(
             identity_client, parsed_args.group, parsed_args.group_domain
@@ -408,7 +426,7 @@ class RemoveUserFromGroup(command.Command):
 class SetGroup(command.Command):
     _description = _("Set group 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(
             'group',
@@ -432,8 +450,10 @@ class SetGroup(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'
+        )
         group = common.find_group_id_sdk(
             identity_client, parsed_args.group, parsed_args.domain
         )
@@ -449,7 +469,7 @@ class SetGroup(command.Command):
 class ShowGroup(command.ShowOne):
     _description = _("Display group 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(
             'group',
@@ -463,8 +483,12 @@ class ShowGroup(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'
+        )
 
         if parsed_args.domain:
             domain = common.find_domain_id_sdk(