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

openstackclient/identity/v2_0/user.py

@@ -20,17 +20,17 @@ import logging
 
 from cliff import columns as cliff_columns
 from keystoneauth1 import exceptions as ks_exc
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 
 LOG = logging.getLogger(__name__)
 
 
-class ProjectColumn(cliff_columns.FormattableColumn):
+class ProjectColumn(cliff_columns.FormattableColumn[str]):
     """Formattable column for project column.
 
     Unlike the parent FormattableColumn class, the initializer of the

openstackclient/identity/v3/access_rule.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
@@ -44,7 +44,11 @@ class DeleteAccessRule(command.Command):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
         conn = self.app.client_manager.sdk_connection
-        user_id = conn.config.get_auth().get_user_id(conn.identity)
+        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)
 
         errors = 0
         for ac in parsed_args.access_rule:
@@ -87,7 +91,11 @@ class ListAccessRule(command.Lister):
             ).id
         else:
             conn = self.app.client_manager.sdk_connection
-            user_id = conn.config.get_auth().get_user_id(conn.identity)
+            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)
 
         columns = ('ID', 'Service', 'Method', 'Path')
         data = identity_client.access_rules(user=user_id)
@@ -119,7 +127,11 @@ class ShowAccessRule(command.ShowOne):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
         conn = self.app.client_manager.sdk_connection
-        user_id = conn.config.get_auth().get_user_id(conn.identity)
+        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)
 
         access_rule = identity_client.get_access_rule(
             user_id, parsed_args.access_rule

openstackclient/identity/v3/application_credential.py

@@ -18,19 +18,95 @@
 import datetime
 import json
 import logging
+import typing as ty
 import uuid
 
-from osc_lib.command import command
+from cliff import columns as cliff_columns
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
-
 LOG = logging.getLogger(__name__)
 
 
+class RolesColumn(cliff_columns.FormattableColumn[ty.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 _format_application_credential(
+    application_credential, *, include_secret=False
+):
+    column_headers: tuple[str, ...] = (
+        'ID',
+        'Name',
+        'Description',
+        'Project ID',
+        'Roles',
+        'Unrestricted',
+        'Access Rules',
+        'Expires At',
+    )
+    columns: tuple[str, ...] = (
+        'id',
+        'name',
+        'description',
+        'project_id',
+        'roles',
+        'unrestricted',
+        'access_rules',
+        'expires_at',
+    )
+    if include_secret:
+        column_headers += ('Secret',)
+        columns += ('secret',)
+
+    return (
+        column_headers,
+        utils.get_item_properties(
+            application_credential, columns, formatters={'roles': RolesColumn}
+        ),
+    )
+
+
+def _format_application_credentials(application_credentials):
+    column_headers = (
+        'ID',
+        'Name',
+        'Description',
+        'Project ID',
+        'Roles',
+        'Unrestricted',
+        'Access Rules',
+        'Expires At',
+    )
+    columns = (
+        'id',
+        'name',
+        'description',
+        'project_id',
+        'roles',
+        'unrestricted',
+        'access_rules',
+        'expires_at',
+    )
+
+    return (
+        column_headers,
+        (
+            utils.get_item_properties(
+                x, columns, formatters={'roles': RolesColumn}
+            )
+            for x in application_credentials
+        ),
+    )
+
+
 # TODO(stephenfin): Move this to osc_lib since it's useful elsewhere
 def is_uuid_like(value) -> bool:
     """Returns validation of a value as a UUID.
@@ -38,9 +114,6 @@ def is_uuid_like(value) -> bool:
     :param val: Value to verify
     :type val: string
     :returns: bool
-
-    .. versionchanged:: 1.1.1
-       Support non-lowercase UUIDs.
     """
     try:
         formatted_value = (
@@ -76,6 +149,7 @@ class CreateApplicationCredential(command.ShowOne):
         parser.add_argument(
             '--role',
             metavar='<role>',
+            dest='roles',
             action='append',
             default=[],
             help=_(
@@ -132,10 +206,15 @@ class CreateApplicationCredential(command.ShowOne):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
         conn = self.app.client_manager.sdk_connection
-        user_id = conn.config.get_auth().get_user_id(conn.identity)
+        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)
 
         role_ids = []
-        for role in parsed_args.role:
+        for role in parsed_args.roles:
             if is_uuid_like(role):
                 role_ids.append({'id': role})
             else:
@@ -179,31 +258,8 @@ class CreateApplicationCredential(command.ShowOne):
             access_rules=access_rules,
         )
 
-        # Format roles into something sensible
-        if application_credential['roles']:
-            roles = application_credential['roles']
-            msg = ' '.join(r['name'] for r in roles)
-            application_credential['roles'] = msg
-
-        columns = (
-            'id',
-            'name',
-            'description',
-            'project_id',
-            'roles',
-            'unrestricted',
-            'access_rules',
-            'expires_at',
-            'secret',
-        )
-        return (
-            columns,
-            (
-                utils.get_dict_properties(
-                    application_credential,
-                    columns,
-                )
-            ),
+        return _format_application_credential(
+            application_credential, include_secret=True
         )
 
 
@@ -223,13 +279,18 @@ class DeleteApplicationCredential(command.Command):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
         conn = self.app.client_manager.sdk_connection
-        user_id = conn.config.get_auth().get_user_id(conn.identity)
+        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)
 
         errors = 0
         for ac in parsed_args.application_credential:
             try:
                 app_cred = identity_client.find_application_credential(
-                    user_id, ac
+                    user_id, ac, ignore_missing=False
                 )
                 identity_client.delete_application_credential(
                     user_id, app_cred.id
@@ -252,6 +313,8 @@ class DeleteApplicationCredential(command.Command):
             ) % {'errors': errors, 'total': total}
             raise exceptions.CommandError(msg)
 
+        return None
+
 
 class ListApplicationCredential(command.Lister):
     _description = _("List application credentials")
@@ -274,41 +337,18 @@ class ListApplicationCredential(command.Lister):
             )
         else:
             conn = self.app.client_manager.sdk_connection
-            user_id = conn.config.get_auth().get_user_id(conn.identity)
-
-        data = identity_client.application_credentials(user=user_id)
-
-        data_formatted = []
-        for ac in data:
-            # Format roles into something sensible
-            roles = ac['roles']
-            msg = ' '.join(r['name'] for r in roles)
-            ac['roles'] = msg
-
-            data_formatted.append(ac)
-
-        columns = (
-            'ID',
-            'Name',
-            'Description',
-            'Project ID',
-            'Roles',
-            'Unrestricted',
-            'Access Rules',
-            'Expires At',
-        )
-        return (
-            columns,
-            (
-                utils.get_item_properties(
-                    s,
-                    columns,
-                    formatters={},
-                )
-                for s in data_formatted
-            ),
+            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)
+
+        application_credentials = identity_client.application_credentials(
+            user=user_id
         )
 
+        return _format_application_credentials(application_credentials)
+
 
 class ShowApplicationCredential(command.ShowOne):
     _description = _("Display application credential details")
@@ -325,33 +365,14 @@ class ShowApplicationCredential(command.ShowOne):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
         conn = self.app.client_manager.sdk_connection
-        user_id = conn.config.get_auth().get_user_id(conn.identity)
-
-        app_cred = identity_client.find_application_credential(
-            user_id, parsed_args.application_credential
+        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)
+
+        application_credential = identity_client.find_application_credential(
+            user_id, parsed_args.application_credential, ignore_missing=False
         )
 
-        # Format roles into something sensible
-        roles = app_cred['roles']
-        msg = ' '.join(r['name'] for r in roles)
-        app_cred['roles'] = msg
-
-        columns = (
-            'id',
-            'name',
-            'description',
-            'project_id',
-            'roles',
-            'unrestricted',
-            'access_rules',
-            'expires_at',
-        )
-        return (
-            columns,
-            (
-                utils.get_dict_properties(
-                    app_cred,
-                    columns,
-                )
-            ),
-        )
+        return _format_application_credential(application_credential)

openstackclient/identity/v3/catalog.py

@@ -9,24 +9,24 @@
 #   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #   License for the specific language governing permissions and limitations
 #   under the License.
-#
 
 """Identity v3 Service Catalog action implementations"""
 
 import logging
+import typing as ty
 
 from cliff import columns as cliff_columns
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 
 LOG = logging.getLogger(__name__)
 
 
-class EndpointsColumn(cliff_columns.FormattableColumn):
+class EndpointsColumn(cliff_columns.FormattableColumn[ty.Any]):
     def human_readable(self):
         if not self._value:
             return ""

openstackclient/identity/v3/consumer.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/identity/v3/credential.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 

openstackclient/identity/v3/domain.py

@@ -18,10 +18,10 @@
 import logging
 
 from openstack import exceptions as sdk_exceptions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
@@ -94,7 +94,9 @@ class CreateDomain(command.ShowOne):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
 
-        options = common.get_immutable_options(parsed_args)
+        options = {}
+        if parsed_args.immutable is not None:
+            options['immutable'] = parsed_args.immutable
 
         try:
             domain = identity_client.create_domain(
@@ -105,7 +107,9 @@ class CreateDomain(command.ShowOne):
             )
         except sdk_exceptions.ConflictException:
             if parsed_args.or_show:
-                domain = identity_client.find_domain(parsed_args.name)
+                domain = identity_client.find_domain(
+                    parsed_args.name, ignore_missing=False
+                )
                 LOG.info(_('Returning existing domain %s'), domain.name)
             else:
                 raise
@@ -236,19 +240,18 @@ class SetDomain(command.Command):
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
-        domain = identity_client.find_domain(parsed_args.domain)
+        domain = identity_client.find_domain(
+            parsed_args.domain, ignore_missing=False
+        )
         kwargs = {}
         if parsed_args.name:
             kwargs['name'] = parsed_args.name
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
-
         if parsed_args.is_enabled is not None:
             kwargs['is_enabled'] = parsed_args.is_enabled
-
-        options = common.get_immutable_options(parsed_args)
-        if options:
-            kwargs['options'] = options
+        if parsed_args.immutable is not None:
+            kwargs['options'] = {'immutable': parsed_args.immutable}
 
         identity_client.update_domain(domain.id, **kwargs)
 
@@ -267,6 +270,8 @@ class ShowDomain(command.ShowOne):
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
-        domain = identity_client.find_domain(parsed_args.domain)
+        domain = identity_client.find_domain(
+            parsed_args.domain, ignore_missing=False
+        )
 
         return _format_domain(domain)

openstackclient/identity/v3/ec2creds.py

@@ -14,10 +14,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 

openstackclient/identity/v3/endpoint.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
@@ -169,7 +169,9 @@ class DeleteEndpoint(command.Command):
         result = 0
         for i in parsed_args.endpoint:
             try:
-                endpoint_id = identity_client.find_endpoint(i).id
+                endpoint_id = identity_client.find_endpoint(
+                    i, ignore_missing=False
+                ).id
                 identity_client.delete_endpoint(endpoint_id)
             except Exception as e:
                 result += 1
@@ -230,12 +232,25 @@ class ListEndpoint(command.Lister):
 
         endpoint = None
         if parsed_args.endpoint:
-            endpoint = identity_client.find_endpoint(parsed_args.endpoint)
-        project = None
+            endpoint = identity_client.find_endpoint(
+                parsed_args.endpoint, ignore_missing=False
+            )
+
+        project_domain_id = None
+        if parsed_args.project_domain:
+            project_domain_id = common._find_sdk_id(
+                identity_client.find_domain,
+                name_or_id=parsed_args.project_domain,
+            )
+
+        project_id = None
         if parsed_args.project:
-            project = identity_client.find_project(
-                parsed_args.project,
-                parsed_args.project_domain,
+            project_id = common._find_sdk_id(
+                identity_client.find_project,
+                name_or_id=common._get_token_resource(
+                    identity_client, 'project', parsed_args.project
+                ),
+                domain_id=project_domain_id,
             )
 
         if endpoint:
@@ -273,15 +288,17 @@ class ListEndpoint(command.Lister):
                 region = identity_client.get_region(parsed_args.region)
                 kwargs['region_id'] = region.id
 
-            if project:
+            if project_id:
                 data = list(
-                    identity_client.project_endpoints(project=project.id)
+                    identity_client.project_endpoints(project=project_id)
                 )
             else:
                 data = list(identity_client.endpoints(**kwargs))
 
             for ep in data:
-                service = identity_client.find_service(ep.service_id)
+                service = identity_client.find_service(
+                    ep.service_id, ignore_missing=False
+                )
                 ep.service_name = getattr(service, 'name', '')
                 ep.service_type = service.type
 
@@ -382,7 +399,9 @@ class SetEndpoint(command.Command):
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
-        endpoint = identity_client.find_endpoint(parsed_args.endpoint)
+        endpoint = identity_client.find_endpoint(
+            parsed_args.endpoint, ignore_missing=False
+        )
 
         kwargs = {}
 
@@ -429,7 +448,9 @@ class ShowEndpoint(command.ShowOne):
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
-        endpoint = identity_client.find_endpoint(parsed_args.endpoint)
+        endpoint = identity_client.find_endpoint(
+            parsed_args.endpoint, ignore_missing=False
+        )
 
         service = common.find_service_sdk(identity_client, endpoint.service_id)
 

openstackclient/identity/v3/endpoint_group.py

@@ -16,10 +16,10 @@
 import json
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 

openstackclient/identity/v3/federation_protocol.py

@@ -16,10 +16,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/identity/v3/group.py

@@ -18,10 +18,10 @@
 import logging
 
 from openstack import exceptions as sdk_exc
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
@@ -211,10 +211,15 @@ class CreateGroup(command.ShowOne):
             if parsed_args.or_show:
                 if parsed_args.domain:
                     group = identity_client.find_group(
-                        parsed_args.name, domain_id=parsed_args.domain
+                        parsed_args.name,
+                        domain_id=parsed_args.domain,
+                        ignore_missing=False,
                     )
                 else:
-                    group = identity_client.find_group(parsed_args.name)
+                    group = identity_client.find_group(
+                        parsed_args.name,
+                        ignore_missing=False,
+                    )
                 LOG.info(_('Returning existing group %s'), group.name)
             else:
                 raise
@@ -310,8 +315,9 @@ class ListGroup(command.Lister):
                 parsed_args.user_domain,
             )
             if domain:
-                # NOTE(0weng): The API doesn't actually support filtering additionally by domain_id,
-                # so this doesn't really do anything.
+                # NOTE(0weng): The API doesn't actually support filtering
+                # additionally by domain_id, so this doesn't really do
+                # anything.
                 data = identity_client.user_groups(user, domain_id=domain)
             else:
                 data = identity_client.user_groups(user)