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

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,

openstackclient/identity/v3/service.py

@@ -15,8 +15,12 @@
 
 """Identity v3 Service 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_service(service):
+def _format_service(service: Any) -> tuple[tuple[str, ...], Any]:
     columns = (
         'id',
         'name',
@@ -56,7 +60,7 @@ def _format_service(service):
 class CreateService(command.ShowOne):
     _description = _("Create new service")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'type',
@@ -90,8 +94,12 @@ class CreateService(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 = identity_client.create_service(
             name=parsed_args.name,
@@ -106,7 +114,7 @@ class CreateService(command.ShowOne):
 class DeleteService(command.Command):
     _description = _("Delete service(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(
             'service',
@@ -116,8 +124,10 @@ class DeleteService(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.service:
             try:
@@ -145,7 +155,7 @@ class DeleteService(command.Command):
 class ListService(command.Lister):
     _description = _("List services")
 
-    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',
@@ -155,8 +165,12 @@ class ListService(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'
+        )
 
         columns: tuple[str, ...] = ('id', 'name', 'type')
         column_headers: tuple[str, ...] = ('ID', 'Name', 'Type')
@@ -175,7 +189,7 @@ class ListService(command.Lister):
 class SetService(command.Command):
     _description = _("Set service 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(
             'service',
@@ -214,8 +228,10 @@ class SetService(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'
+        )
 
         service = common.find_service_sdk(identity_client, parsed_args.service)
         kwargs = {}
@@ -234,7 +250,7 @@ class SetService(command.Command):
 class ShowService(command.ShowOne):
     _description = _("Display service 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',
@@ -243,8 +259,12 @@ class ShowService(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)
 

openstackclient/identity/v3/service_provider.py

@@ -13,8 +13,12 @@
 
 """Service Provider 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,7 +29,7 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _format_service_provider(sp):
+def _format_service_provider(sp: Any) -> tuple[tuple[str, ...], Any]:
     column_headers = (
         'id',
         'enabled',
@@ -51,7 +55,7 @@ def _format_service_provider(sp):
 class CreateServiceProvider(command.ShowOne):
     _description = _("Create new service provider")
 
-    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_provider_id',
@@ -98,8 +102,12 @@ class CreateServiceProvider(command.ShowOne):
 
         return parser
 
-    def take_action(self, parsed_args):
-        service_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        service_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
 
@@ -125,7 +133,7 @@ class CreateServiceProvider(command.ShowOne):
 class DeleteServiceProvider(command.Command):
     _description = _("Delete service provider(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(
             'service_provider',
@@ -135,8 +143,10 @@ class DeleteServiceProvider(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        service_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        service_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         result = 0
         for i in parsed_args.service_provider:
             try:
@@ -162,8 +172,12 @@ class DeleteServiceProvider(command.Command):
 class ListServiceProvider(command.Lister):
     _description = _("List service providers")
 
-    def take_action(self, parsed_args):
-        service_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        service_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         data = service_client.service_providers()
 
         column_headers = (
@@ -191,7 +205,7 @@ class ListServiceProvider(command.Lister):
 class SetServiceProvider(command.ShowOne):
     _description = _("Set service provider 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(
             'service_provider',
@@ -233,8 +247,12 @@ class SetServiceProvider(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        service_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        service_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
 
@@ -261,7 +279,7 @@ class SetServiceProvider(command.ShowOne):
 class ShowServiceProvider(command.ShowOne):
     _description = _("Display service provider 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_provider',
@@ -270,8 +288,12 @@ class ShowServiceProvider(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        service_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        service_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         service_provider = service_client.find_service_provider(
             parsed_args.service_provider,
             ignore_missing=False,

openstackclient/identity/v3/tag.py

@@ -11,16 +11,27 @@
 #   under the License.
 
 import argparse
+from collections.abc import Sequence
+from typing import Any
 
 from openstackclient.i18n import _
 
 
 class _CommaListAction(argparse.Action):
-    def __call__(self, parser, namespace, values, option_string=None):
-        setattr(namespace, self.dest, values.split(','))
+    def __call__(
+        self,
+        parser: argparse.ArgumentParser,
+        namespace: argparse.Namespace,
+        values: str | Sequence[Any] | None,
+        option_string: str | None = None,
+    ) -> None:
+        values = values.split(',') if isinstance(values, str) else values
+        setattr(namespace, self.dest, values)
 
 
-def add_tag_filtering_option_to_parser(parser, collection_name):
+def add_tag_filtering_option_to_parser(
+    parser: argparse.ArgumentParser, collection_name: str
+) -> None:
     parser.add_argument(
         '--tags',
         metavar='<tag>[,<tag>,...]',
@@ -63,7 +74,9 @@ def add_tag_filtering_option_to_parser(parser, collection_name):
     )
 
 
-def get_tag_filtering_args(parsed_args, args):
+def get_tag_filtering_args(
+    parsed_args: argparse.Namespace, args: dict[str, Any]
+) -> None:
     if parsed_args.tags:
         args['tags'] = ','.join(parsed_args.tags)
     if parsed_args.tags_any:
@@ -74,7 +87,9 @@ def get_tag_filtering_args(parsed_args, args):
         args['not-tags-any'] = ','.join(parsed_args.not_tags_any)
 
 
-def add_tag_option_to_parser_for_create(parser, resource_name):
+def add_tag_option_to_parser_for_create(
+    parser: argparse.ArgumentParser, resource_name: str
+) -> None:
     tag_group = parser.add_mutually_exclusive_group()
     tag_group.add_argument(
         '--tag',
@@ -89,7 +104,9 @@ def add_tag_option_to_parser_for_create(parser, resource_name):
     )
 
 
-def add_tag_option_to_parser_for_set(parser, resource_name):
+def add_tag_option_to_parser_for_set(
+    parser: argparse.ArgumentParser, resource_name: str
+) -> None:
     parser.add_argument(
         '--tag',
         action='append',