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

openstackclient/identity/v3/registered_limit.py

@@ -13,8 +13,12 @@
 
 """Registered limits 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
 
@@ -25,10 +29,35 @@ from openstackclient.identity import common as common_utils
 LOG = logging.getLogger(__name__)
 
 
+def _format_registered_limit(
+    registered_limit: Any,
+) -> tuple[tuple[str, ...], Any]:
+    columns = (
+        'default_limit',
+        'description',
+        'id',
+        'region_id',
+        'resource_name',
+        'service_id',
+    )
+    column_headers = (
+        'default_limit',
+        'description',
+        'id',
+        'region_id',
+        'resource_name',
+        'service_id',
+    )
+    return (
+        column_headers,
+        utils.get_item_properties(registered_limit, columns),
+    )
+
+
 class CreateRegisteredLimit(command.ShowOne):
     _description = _("Create a registered limit")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--description',
@@ -63,66 +92,62 @@ class CreateRegisteredLimit(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-
-        service = utils.find_resource(
-            identity_client.services, parsed_args.service
+    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'
         )
-        region = None
+
+        kwargs = {}
+
+        if parsed_args.description:
+            kwargs["description"] = parsed_args.description
+
+        kwargs["service_id"] = common_utils.find_service_sdk(
+            identity_client, parsed_args.service
+        ).id
+
         if parsed_args.region:
-            if 'None' not in parsed_args.region:
-                # 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 try to fall back to list all the
-                # resource if requested resource cannot be get via name. Which
-                # ends up with NoUniqueMatch error.
-                # So osc_lib.utils.find_resource() function cannot be used for
-                # 'regions', using common_utils.get_resource() instead.
-                region = common_utils.get_resource(
-                    identity_client.regions, parsed_args.region
-                )
-            else:
-                self.log.warning(
-                    _(
-                        "Passing 'None' to indicate no region is deprecated. "
-                        "Instead, don't pass --region."
-                    )
-                )
+            kwargs["region_id"] = identity_client.get_region(
+                parsed_args.region
+            ).id
 
-        registered_limit = identity_client.registered_limits.create(
-            service,
-            parsed_args.resource_name,
-            parsed_args.default_limit,
-            description=parsed_args.description,
-            region=region,
-        )
+        kwargs["resource_name"] = parsed_args.resource_name
+        kwargs["default_limit"] = parsed_args.default_limit
+
+        registered_limit = identity_client.create_registered_limit(**kwargs)
 
-        registered_limit._info.pop('links', None)
-        return zip(*sorted(registered_limit._info.items()))
+        return _format_registered_limit(registered_limit)
 
 
 class DeleteRegisteredLimit(command.Command):
     _description = _("Delete a registered limit")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'registered_limits',
             metavar='<registered-limits>',
             nargs="+",
-            help=_('Registered limit(s) to delete (ID)'),
+            help=_(
+                'Registered limit(s) to delete (ID) '
+                '(repeat option to remove multiple registered limits)'
+            ),
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.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 registered_limit_id in parsed_args.registered_limits:
             try:
-                identity_client.registered_limits.delete(registered_limit_id)
+                identity_client.delete_registered_limit(
+                    registered_limit_id, ignore_missing=False
+                )
             except Exception as e:
                 errors += 1
                 from pprint import pprint
@@ -147,7 +172,7 @@ class DeleteRegisteredLimit(command.Command):
 class ListRegisteredLimit(command.Lister):
     _description = _("List registered limits")
 
-    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',
@@ -169,41 +194,27 @@ class ListRegisteredLimit(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.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'
+        )
 
-        service = None
+        kwargs = {}
         if parsed_args.service:
-            service = common_utils.find_service(
+            kwargs["service_id"] = common_utils.find_service_sdk(
                 identity_client, parsed_args.service
-            )
-        region = None
+            ).id
         if parsed_args.region:
-            if 'None' not in parsed_args.region:
-                # 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 try to fall back to list all the
-                # resource if requested resource cannot be get via name. Which
-                # ends up with NoUniqueMatch error.
-                # So osc_lib.utils.find_resource() function cannot be used for
-                # 'regions', using common_utils.get_resource() instead.
-                region = common_utils.get_resource(
-                    identity_client.regions, parsed_args.region
-                )
-            else:
-                self.log.warning(
-                    _(
-                        "Passing 'None' to indicate no region is deprecated. "
-                        "Instead, don't pass --region."
-                    )
-                )
+            kwargs["region_id"] = identity_client.get_region(
+                parsed_args.region
+            ).id
 
-        registered_limits = identity_client.registered_limits.list(
-            service=service,
-            resource_name=parsed_args.resource_name,
-            region=region,
-        )
+        if parsed_args.resource_name:
+            kwargs["resource_name"] = parsed_args.resource_name
+
+        registered_limits = identity_client.registered_limits(**kwargs)
 
         columns = (
             'ID',
@@ -222,7 +233,7 @@ class ListRegisteredLimit(command.Lister):
 class SetRegisteredLimit(command.ShowOne):
     _description = _("Update information about a registered limit")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'registered_limit_id',
@@ -272,51 +283,44 @@ class SetRegisteredLimit(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.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 = None
+        kwargs = {}
         if parsed_args.service:
-            service = common_utils.find_service(
+            kwargs["service_id"] = common_utils.find_service_sdk(
                 identity_client, parsed_args.service
-            )
+            ).id
+
+        if parsed_args.resource_name:
+            kwargs["resource_name"] = parsed_args.resource_name
+
+        if parsed_args.default_limit:
+            kwargs["default_limit"] = parsed_args.default_limit
+
+        if parsed_args.description:
+            kwargs["description"] = parsed_args.description
 
-        region = None
         if parsed_args.region:
-            if 'None' not in parsed_args.region:
-                # 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 try to fall back to list all the
-                # resource if requested resource cannot be get via name. Which
-                # ends up with NoUniqueMatch error.
-                # So osc_lib.utils.find_resource() function cannot be used for
-                # 'regions', using common_utils.get_resource() instead.
-                region = common_utils.get_resource(
-                    identity_client.regions, parsed_args.region
-                )
-            else:
-                self.log.warning(
-                    _("Passing 'None' to indicate no region is deprecated.")
-                )
+            kwargs["region_id"] = identity_client.get_region(
+                parsed_args.region
+            ).id
 
-        registered_limit = identity_client.registered_limits.update(
-            parsed_args.registered_limit_id,
-            service=service,
-            resource_name=parsed_args.resource_name,
-            default_limit=parsed_args.default_limit,
-            description=parsed_args.description,
-            region=region,
+        registered_limit = identity_client.update_registered_limit(
+            parsed_args.registered_limit_id, **kwargs
         )
 
-        registered_limit._info.pop('links', None)
-        return zip(*sorted(registered_limit._info.items()))
+        return _format_registered_limit(registered_limit)
 
 
 class ShowRegisteredLimit(command.ShowOne):
     _description = _("Display registered limit 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(
             'registered_limit_id',
@@ -325,10 +329,13 @@ class ShowRegisteredLimit(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        registered_limit = identity_client.registered_limits.get(
+    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'
+        )
+        registered_limit = identity_client.get_registered_limit(
             parsed_args.registered_limit_id
         )
-        registered_limit._info.pop('links', None)
-        return zip(*sorted(registered_limit._info.items()))
+        return _format_registered_limit(registered_limit)

openstackclient/identity/v3/role.py

@@ -15,9 +15,13 @@
 
 """Identity v3 Role 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 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_role(role):
+def _format_role(role: Any) -> tuple[tuple[str, ...], Any]:
     columns = (
         "id",
         "name",
@@ -48,7 +52,9 @@ def _format_role(role):
     )
 
 
-def _add_identity_and_resource_options_to_parser(parser):
+def _add_identity_and_resource_options_to_parser(
+    parser: argparse.ArgumentParser,
+) -> None:
     system_or_domain_or_project = parser.add_mutually_exclusive_group()
     system_or_domain_or_project.add_argument(
         '--system',
@@ -83,9 +89,11 @@ def _add_identity_and_resource_options_to_parser(parser):
 
 
 def _process_identity_and_resource_options(
-    parsed_args, identity_client, validate_actor_existence=True
-):
-    def _find_user():
+    parsed_args: argparse.Namespace,
+    identity_client: Any,
+    validate_actor_existence: bool = True,
+) -> dict[str, Any]:
+    def _find_user() -> Any:
         domain_id = (
             common._find_sdk_id(
                 identity_client.find_domain,
@@ -102,7 +110,7 @@ def _process_identity_and_resource_options(
             domain_id=domain_id,
         )
 
-    def _find_group():
+    def _find_group() -> Any:
         domain_id = (
             common._find_sdk_id(
                 identity_client.find_domain,
@@ -119,7 +127,7 @@ def _process_identity_and_resource_options(
             domain_id=domain_id,
         )
 
-    def _find_project():
+    def _find_project() -> Any:
         domain_id = (
             common._find_sdk_id(
                 identity_client.find_domain,
@@ -180,7 +188,7 @@ class AddRole(command.Command):
         "system, a domain, or a 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(
             'role',
@@ -191,8 +199,10 @@ class AddRole(command.Command):
         common.add_role_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'
+        )
 
         if (
             not parsed_args.user
@@ -278,7 +288,7 @@ class AddRole(command.Command):
 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(
             'name',
@@ -303,10 +313,14 @@ class CreateRole(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'
+        )
 
-        create_kwargs = {}
+        create_kwargs: dict[str, Any] = {}
         if parsed_args.domain:
             create_kwargs['domain_id'] = common._find_sdk_id(
                 identity_client.find_domain, name_or_id=parsed_args.domain
@@ -341,7 +355,7 @@ class CreateRole(command.ShowOne):
 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',
@@ -356,8 +370,10 @@ class DeleteRole(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'
+        )
 
         domain_id = None
         if parsed_args.domain:
@@ -395,7 +411,7 @@ class DeleteRole(command.Command):
 class ListRole(command.Lister):
     _description = _("List roles")
 
-    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',
@@ -404,8 +420,12 @@ class ListRole(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'
+        )
 
         if parsed_args.domain:
             domain = identity_client.find_domain(
@@ -416,8 +436,10 @@ class ListRole(command.Lister):
             return (
                 ('ID', 'Name', 'Domain'),
                 (
-                    utils.get_item_properties(s, ('id', 'name'))
-                    + (domain.name,)
+                    (
+                        *utils.get_item_properties(s, ('id', 'name')),
+                        domain.name,
+                    )
                     for s in data
                 ),
             )
@@ -435,7 +457,7 @@ class RemoveRole(command.Command):
         "Removes a role assignment from system/domain/project : user/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(
             'role',
@@ -447,8 +469,10 @@ class RemoveRole(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'
+        )
         if (
             not parsed_args.user
             and not parsed_args.domain
@@ -527,7 +551,7 @@ class RemoveRole(command.Command):
 class SetRole(command.Command):
     _description = _("Set role 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(
             'role',
@@ -552,8 +576,10 @@ class SetRole(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'
+        )
 
         update_kwargs = {}
         if parsed_args.description:
@@ -585,7 +611,7 @@ class SetRole(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',
@@ -599,8 +625,12 @@ class ShowRole(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_id = None
         if parsed_args.domain:

openstackclient/identity/v3/role_assignment.py

@@ -13,13 +13,22 @@
 
 """Identity v3 Assignment action implementations"""
 
+import argparse
+from collections.abc import Iterable
+from typing import Any
+
+from openstack import utils as sdk_utils
+from osc_lib import exceptions
+
 from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
 
-def _format_role_assignment_(assignment, include_names):
-    def _get_names(attr):
+def _format_role_assignment_(
+    assignment: Any, include_names: Any
+) -> tuple[Any, ...]:
+    def _get_names(attr: Any) -> str:
         return (
             (
                 attr['name']
@@ -34,7 +43,7 @@ def _format_role_assignment_(assignment, include_names):
             else ''
         )
 
-    def _get_ids(attr):
+    def _get_ids(attr: Any) -> str:
         return attr['id'] or '' if attr else ''
 
     func = _get_names if include_names else _get_ids
@@ -52,7 +61,7 @@ def _format_role_assignment_(assignment, include_names):
 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(
             '--effective',
@@ -117,8 +126,12 @@ class ListRoleAssignment(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'
+        )
         auth_ref = self.app.client_manager.auth_ref
 
         role_id = None
@@ -151,6 +164,8 @@ class ListRoleAssignment(command.Lister):
             )
         elif parsed_args.authuser:
             if auth_ref:
+                if auth_ref.user_id is None:
+                    raise exceptions.CommandError('missing auth info')
                 user_id = common._find_sdk_id(
                     identity_client.find_user,
                     name_or_id=auth_ref.user_id,
@@ -185,6 +200,8 @@ class ListRoleAssignment(command.Lister):
             )
         elif parsed_args.authproject:
             if auth_ref:
+                if auth_ref.project_id is None:
+                    raise exceptions.CommandError('missing auth info')
                 project_id = common._find_sdk_id(
                     identity_client.find_project,
                     name_or_id=auth_ref.project_id,