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

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',
@@ -123,14 +140,3 @@ def add_tag_option_to_parser_for_set(parser, resource_name):
         )
         % resource_name,
     )
-
-
-def update_tags_in_args(parsed_args, obj, args):
-    if parsed_args.clear_tags:
-        args['tags'] = []
-        obj.tags = []
-    if parsed_args.remove_tags:
-        args['tags'] = sorted(set(obj.tags) - set(parsed_args.remove_tags))
-        return
-    if parsed_args.tags:
-        args['tags'] = sorted(set(obj.tags).union(set(parsed_args.tags)))

openstackclient/identity/v3/token.py

@@ -15,6 +15,10 @@
 
 """Identity v3 Token action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -26,7 +30,7 @@ from openstackclient.identity import common
 class AuthorizeRequestToken(command.ShowOne):
     _description = _("Authorize a request token")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--request-key',
@@ -48,7 +52,9 @@ class AuthorizeRequestToken(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
 
         # NOTE(stevemar): We want a list of role ids
@@ -64,13 +70,14 @@ class AuthorizeRequestToken(command.ShowOne):
             parsed_args.request_key, roles
         )
 
-        return zip(*sorted(verifier_pin._info.items()))
+        col_headers, col_data = zip(*sorted(verifier_pin._info.items()))
+        return col_headers, col_data
 
 
 class CreateAccessToken(command.ShowOne):
     _description = _("Create an access token")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--consumer-key',
@@ -104,7 +111,9 @@ class CreateAccessToken(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         token_client = self.app.client_manager.identity.oauth1.access_tokens
         access_token = token_client.create(
             parsed_args.consumer_key,
@@ -113,13 +122,14 @@ class CreateAccessToken(command.ShowOne):
             parsed_args.request_secret,
             parsed_args.verifier,
         )
-        return zip(*sorted(access_token._info.items()))
+        col_headers, col_data = zip(*sorted(access_token._info.items()))
+        return col_headers, col_data
 
 
 class CreateRequestToken(command.ShowOne):
     _description = _("Create a request token")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--consumer-key',
@@ -148,7 +158,9 @@ class CreateRequestToken(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
 
         if parsed_args.domain:
@@ -168,7 +180,8 @@ class CreateRequestToken(command.ShowOne):
         request_token = token_client.create(
             parsed_args.consumer_key, parsed_args.consumer_secret, project.id
         )
-        return zip(*sorted(request_token._info.items()))
+        col_headers, col_data = zip(*sorted(request_token._info.items()))
+        return col_headers, col_data
 
 
 class IssueToken(command.ShowOne):
@@ -177,11 +190,13 @@ class IssueToken(command.ShowOne):
     # scoped token is optional
     required_scope = False
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         auth_ref = self.app.client_manager.auth_ref
         if not auth_ref:
             raise exceptions.AuthorizationFailure(
@@ -207,13 +222,14 @@ class IssueToken(command.ShowOne):
             # deployment system. When that happens, this will have to relay
             # scope information and IDs like we do for projects and domains.
             data['system'] = 'all'
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class RevokeToken(command.Command):
     _description = _("Revoke existing token")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'token',
@@ -222,7 +238,7 @@ class RevokeToken(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
 
         identity_client.tokens.revoke_token(parsed_args.token)

openstackclient/identity/v3/trust.py

@@ -13,11 +13,15 @@
 
 """Identity v3 Trust action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import datetime
 import itertools
 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_trust(trust):
+def _format_trust(trust: Any) -> tuple[tuple[str, ...], Any]:
     columns = (
         'expires_at',
         'id',
@@ -51,7 +55,7 @@ def _format_trust(trust):
 class CreateTrust(command.ShowOne):
     _description = _("Create new trust")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'trustor',
@@ -112,10 +116,14 @@ class CreateTrust(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 = {}
+        kwargs: dict[str, Any] = {}
 
         # NOTE(stevemar): Find the two users, project and roles that
         # are necessary for making a trust usable, the API dictates that
@@ -203,7 +211,7 @@ class CreateTrust(command.ShowOne):
 class DeleteTrust(command.Command):
     _description = _("Delete trust(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(
             'trust',
@@ -213,8 +221,10 @@ class DeleteTrust(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 trust in parsed_args.trust:
@@ -245,7 +255,7 @@ class DeleteTrust(command.Command):
 class ListTrust(command.Lister):
     _description = _("List trusts")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--trustor',
@@ -275,8 +285,12 @@ class ListTrust(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
 
         if parsed_args.authuser and any(
@@ -395,7 +409,7 @@ class ListTrust(command.Lister):
 class ShowTrust(command.ShowOne):
     _description = _("Display trust 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(
             'trust',
@@ -404,8 +418,12 @@ class ShowTrust(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'
+        )
         trust = identity_client.find_trust(
             parsed_args.trust, ignore_missing=False
         )

openstackclient/identity/v3/unscoped_saml.py

@@ -17,6 +17,10 @@ The first step of federated auth is to fetch an unscoped token. From there,
 the user can list domains and projects they are allowed to access, and request
 a scoped token."""
 
+import argparse
+from collections.abc import Iterable
+from typing import Any
+
 from osc_lib import utils
 
 from openstackclient import command
@@ -26,7 +30,9 @@ from openstackclient.i18n import _
 class ListAccessibleDomains(command.Lister):
     _description = _("List accessible domains")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         columns = ('ID', 'Enabled', 'Name', 'Description')
         identity_client = self.app.client_manager.identity
         data = identity_client.federation.domains.list()
@@ -46,7 +52,9 @@ class ListAccessibleDomains(command.Lister):
 class ListAccessibleProjects(command.Lister):
     _description = _("List accessible projects")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         columns = ('ID', 'Domain ID', 'Enabled', 'Name')
         identity_client = self.app.client_manager.identity
         data = identity_client.federation.projects.list()