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

openstackclient/identity/v3/access_rule.py

@@ -15,8 +15,12 @@
 
 """Identity v3 Access Rule 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
 
@@ -31,7 +35,7 @@ LOG = logging.getLogger(__name__)
 class DeleteAccessRule(command.Command):
     _description = _("Delete access rule(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(
             'access_rule',
@@ -41,14 +45,19 @@ class DeleteAccessRule(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'
+        )
         conn = self.app.client_manager.sdk_connection
         auth = conn.config.get_auth()
         if auth is None:
             # this will never happen
             raise exceptions.CommandError('invalid authentication info')
-        user_id = auth.get_user_id(conn.identity)
+        user_id = auth.get_user_id(conn.session)
+        if user_id is None:
+            # this will never happen
+            raise exceptions.CommandError('invalid authentication info')
 
         errors = 0
         for ac in parsed_args.access_rule:
@@ -73,7 +82,7 @@ class DeleteAccessRule(command.Command):
 class ListAccessRule(command.Lister):
     _description = _("List access rules")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--user',
@@ -83,8 +92,12 @@ class ListAccessRule(command.Lister):
         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
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         if parsed_args.user:
             user_id = common.find_user(
                 identity_client, parsed_args.user, parsed_args.user_domain
@@ -95,7 +108,7 @@ class ListAccessRule(command.Lister):
             if auth is None:
                 # this will never happen
                 raise exceptions.CommandError('invalid authentication info')
-            user_id = auth.get_user_id(conn.identity)
+            user_id = auth.get_user_id(conn.session)
 
         columns = ('ID', 'Service', 'Method', 'Path')
         data = identity_client.access_rules(user=user_id)
@@ -115,7 +128,7 @@ class ListAccessRule(command.Lister):
 class ShowAccessRule(command.ShowOne):
     _description = _("Display access rule details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'access_rule',
@@ -124,14 +137,21 @@ class ShowAccessRule(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'
+        )
         conn = self.app.client_manager.sdk_connection
         auth = conn.config.get_auth()
         if auth is None:
             # this will never happen
             raise exceptions.CommandError('invalid authentication info')
-        user_id = auth.get_user_id(conn.identity)
+        user_id = auth.get_user_id(conn.session)
+        if user_id is None:
+            # this will never happen
+            raise exceptions.CommandError('invalid authentication info')
 
         access_rule = identity_client.get_access_rule(
             user_id, parsed_args.access_rule

openstackclient/identity/v3/application_credential.py

@@ -15,13 +15,19 @@
 
 """Identity v3 Application Credential action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import datetime
 import json
 import logging
-import typing as ty
+from typing import Any
 import uuid
 
 from cliff import columns as cliff_columns
+from openstack.identity.v3 import (
+    application_credential as _application_credential,
+)
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -32,16 +38,18 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
-class RolesColumn(cliff_columns.FormattableColumn[ty.Any]):
+class RolesColumn(cliff_columns.FormattableColumn[Any]):
     """Generate a formatted string of role names."""
 
-    def human_readable(self):
-        return utils.format_list(list(r['name'] for r in self._value))
+    def human_readable(self) -> str:
+        return utils.format_list(list(r['name'] for r in self._value)) or ""
 
 
 def _format_application_credential(
-    application_credential, *, include_secret=False
-):
+    application_credential: _application_credential.ApplicationCredential,
+    *,
+    include_secret: bool = False,
+) -> tuple[tuple[str, ...], Iterable[Any]]:
     column_headers: tuple[str, ...] = (
         'ID',
         'Name',
@@ -74,7 +82,11 @@ def _format_application_credential(
     )
 
 
-def _format_application_credentials(application_credentials):
+def _format_application_credentials(
+    application_credentials: Iterable[
+        _application_credential.ApplicationCredential
+    ],
+) -> tuple[tuple[str, ...], Any]:
     column_headers = (
         'ID',
         'Name',
@@ -108,7 +120,7 @@ def _format_application_credentials(application_credentials):
 
 
 # TODO(stephenfin): Move this to osc_lib since it's useful elsewhere
-def is_uuid_like(value) -> bool:
+def is_uuid_like(value: str) -> bool:
     """Returns validation of a value as a UUID.
 
     :param val: Value to verify
@@ -131,7 +143,7 @@ def is_uuid_like(value) -> bool:
 class CreateApplicationCredential(command.ShowOne):
     _description = _("Create new application credential")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'name',
@@ -203,15 +215,22 @@ class CreateApplicationCredential(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'
+        )
         conn = self.app.client_manager.sdk_connection
         auth = conn.config.get_auth()
         if auth is None:
             # this will never happen
             raise exceptions.CommandError('invalid authentication info')
 
-        user_id = auth.get_user_id(conn.identity)
+        user_id = auth.get_user_id(conn.session)
+        if user_id is None:
+            msg = _("failed to retrieve auth info for current session")
+            raise exceptions.CommandError(msg)
 
         role_ids = []
         for role in parsed_args.roles:
@@ -266,7 +285,7 @@ class CreateApplicationCredential(command.ShowOne):
 class DeleteApplicationCredential(command.Command):
     _description = _("Delete application credentials(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(
             'application_credential',
@@ -276,15 +295,21 @@ class DeleteApplicationCredential(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'
+        )
+
         conn = self.app.client_manager.sdk_connection
         auth = conn.config.get_auth()
         if auth is None:
             # this will never happen
             raise exceptions.CommandError('invalid authentication info')
 
-        user_id = auth.get_user_id(conn.identity)
+        user_id = auth.get_user_id(conn.session)
+        if user_id is None:
+            msg = _("failed to retrieve auth info for current session")
+            raise exceptions.CommandError(msg)
 
         errors = 0
         for ac in parsed_args.application_credential:
@@ -319,7 +344,7 @@ class DeleteApplicationCredential(command.Command):
 class ListApplicationCredential(command.Lister):
     _description = _("List application credentials")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--user',
@@ -329,8 +354,12 @@ class ListApplicationCredential(command.Lister):
         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
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         if parsed_args.user:
             user_id = common.find_user_id_sdk(
                 identity_client, parsed_args.user, parsed_args.user_domain
@@ -341,7 +370,11 @@ class ListApplicationCredential(command.Lister):
             if auth is None:
                 # this will never happen
                 raise exceptions.CommandError('invalid authentication info')
-            user_id = auth.get_user_id(conn.identity)
+            _user_id = auth.get_user_id(conn.session)
+            if _user_id is None:
+                # this will never happen
+                raise exceptions.CommandError('invalid authentication info')
+            user_id = _user_id
 
         application_credentials = identity_client.application_credentials(
             user=user_id
@@ -353,7 +386,7 @@ class ListApplicationCredential(command.Lister):
 class ShowApplicationCredential(command.ShowOne):
     _description = _("Display application credential details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'application_credential',
@@ -362,14 +395,23 @@ class ShowApplicationCredential(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'
+        )
+
         conn = self.app.client_manager.sdk_connection
         auth = conn.config.get_auth()
         if auth is None:
             # this will never happen
             raise exceptions.CommandError('invalid authentication info')
-        user_id = auth.get_user_id(conn.identity)
+
+        user_id = auth.get_user_id(conn.session)
+        if user_id is None:
+            msg = _("failed to retrieve auth info for current session")
+            raise exceptions.CommandError(msg)
 
         application_credential = identity_client.find_application_credential(
             user_id, parsed_args.application_credential, ignore_missing=False

openstackclient/identity/v3/catalog.py

@@ -12,8 +12,10 @@
 
 """Identity v3 Service Catalog action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
-import typing as ty
+from typing import Any
 
 from cliff import columns as cliff_columns
 from osc_lib import exceptions
@@ -26,8 +28,8 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-class EndpointsColumn(cliff_columns.FormattableColumn[ty.Any]):
-    def human_readable(self):
+class EndpointsColumn(cliff_columns.FormattableColumn[Any]):
+    def human_readable(self) -> str:
         if not self._value:
             return ""
         ret = ''
@@ -41,7 +43,9 @@ class EndpointsColumn(cliff_columns.FormattableColumn[ty.Any]):
 class ListCatalog(command.Lister):
     _description = _("List services in the service catalog")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         # Trigger auth if it has not happened yet
         auth_ref = self.app.client_manager.auth_ref
         if not auth_ref:
@@ -69,7 +73,7 @@ class ListCatalog(command.Lister):
 class ShowCatalog(command.ShowOne):
     _description = _("Display service catalog 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',
@@ -78,7 +82,9 @@ class ShowCatalog(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         # Trigger auth if it has not happened yet
         auth_ref = self.app.client_manager.auth_ref
         if not auth_ref:
@@ -102,4 +108,5 @@ class ShowCatalog(command.ShowOne):
             LOG.error(_('service %s not found\n'), parsed_args.service)
             return ((), ())
 
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data

openstackclient/identity/v3/consumer.py

@@ -15,7 +15,10 @@
 
 """Identity v3 Consumer action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 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 CreateConsumer(command.ShowOne):
     _description = _("Create new consumer")
 
-    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',
@@ -39,19 +42,22 @@ class CreateConsumer(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
         consumer = identity_client.oauth1.consumers.create(
             parsed_args.description
         )
         consumer._info.pop('links', None)
-        return zip(*sorted(consumer._info.items()))
+        col_headers, col_data = zip(*sorted(consumer._info.items()))
+        return col_headers, col_data
 
 
 class DeleteConsumer(command.Command):
     _description = _("Delete consumer(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(
             'consumer',
@@ -61,7 +67,7 @@ class DeleteConsumer(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.consumer:
@@ -92,7 +98,9 @@ class DeleteConsumer(command.Command):
 class ListConsumer(command.Lister):
     _description = _("List consumers")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         columns = ('ID', 'Description')
         data = self.app.client_manager.identity.oauth1.consumers.list()
         return (
@@ -111,7 +119,7 @@ class ListConsumer(command.Lister):
 class SetConsumer(command.Command):
     _description = _("Set consumer 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(
             'consumer',
@@ -125,7 +133,7 @@ class SetConsumer(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
         consumer = utils.find_resource(
             identity_client.oauth1.consumers, parsed_args.consumer
@@ -142,7 +150,7 @@ class SetConsumer(command.Command):
 class ShowConsumer(command.ShowOne):
     _description = _("Display consumer 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(
             'consumer',
@@ -151,11 +159,14 @@ class ShowConsumer(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
         consumer = utils.find_resource(
             identity_client.oauth1.consumers, parsed_args.consumer
         )
 
         consumer._info.pop('links', None)
-        return zip(*sorted(consumer._info.items()))
+        col_headers, col_data = zip(*sorted(consumer._info.items()))
+        return col_headers, col_data

openstackclient/identity/v3/credential.py

@@ -15,8 +15,13 @@
 
 """Identity v3 Credential action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack.identity.v3 import credential as _credential
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -24,11 +29,12 @@ from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _format_credential(credential):
+def _format_credential(
+    credential: _credential.Credential,
+) -> tuple[tuple[str, ...], Iterable[Any]]:
     columns = (
         'blob',
         'id',
@@ -48,7 +54,7 @@ def _format_credential(credential):
 class CreateCredential(command.ShowOne):
     _description = _("Create new credential")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'user',
@@ -75,8 +81,12 @@ class CreateCredential(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         user_id = identity_client.find_user(
             parsed_args.user, ignore_missing=False
         ).id
@@ -99,7 +109,7 @@ class CreateCredential(command.ShowOne):
 class DeleteCredential(command.Command):
     _description = _("Delete credential(s)")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'credential',
@@ -109,8 +119,10 @@ class DeleteCredential(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         result = 0
         for i in parsed_args.credential:
             try:
@@ -137,7 +149,7 @@ class DeleteCredential(command.Command):
 class ListCredential(command.Lister):
     _description = _("List credentials")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--user',
@@ -152,8 +164,12 @@ class ListCredential(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
         if parsed_args.user:
@@ -190,7 +206,7 @@ class ListCredential(command.Lister):
 class SetCredential(command.Command):
     _description = _("Set credential properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'credential',
@@ -224,8 +240,10 @@ class SetCredential(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         user_id = identity_client.find_user(
             parsed_args.user, ignore_missing=False
@@ -250,7 +268,7 @@ class SetCredential(command.Command):
 class ShowCredential(command.ShowOne):
     _description = _("Display credential details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'credential',
@@ -259,8 +277,12 @@ class ShowCredential(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         credential = identity_client.get_credential(parsed_args.credential)
 
         return _format_credential(credential)