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

openstackclient/identity/v3/application_credential.py

@@ -18,24 +18,25 @@
 import datetime
 import json
 import logging
+import typing as ty
 import uuid
 
 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 _
 from openstackclient.identity import common
 
 LOG = logging.getLogger(__name__)
 
 
-class RolesColumn(cliff_columns.FormattableColumn):
+class RolesColumn(cliff_columns.FormattableColumn[ty.Any]):
     """Generate a formatted string of role names."""
 
     def human_readable(self):
-        return utils.format_list(r['name'] for r in self._value)
+        return utils.format_list(list(r['name'] for r in self._value))
 
 
 def _format_application_credential(
@@ -148,6 +149,7 @@ class CreateApplicationCredential(command.ShowOne):
         parser.add_argument(
             '--role',
             metavar='<role>',
+            dest='roles',
             action='append',
             default=[],
             help=_(
@@ -204,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:
@@ -272,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
@@ -325,7 +337,11 @@ class ListApplicationCredential(command.Lister):
             )
         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)
 
         application_credentials = identity_client.application_credentials(
             user=user_id
@@ -349,10 +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)
+        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
+            user_id, parsed_args.application_credential, ignore_missing=False
         )
 
         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
 
@@ -107,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
@@ -238,7 +240,9 @@ 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
@@ -266,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)

openstackclient/identity/v3/identity_provider.py

@@ -16,10 +16,10 @@
 import logging
 
 from osc_lib.cli import format_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 _
 from openstackclient.identity import common
 
@@ -41,6 +41,7 @@ class CreateIdentityProvider(command.ShowOne):
         identity_remote_id_provider.add_argument(
             '--remote-id',
             metavar='<remote-id>',
+            dest='remote_ids',
             action='append',
             help=_(
                 'Remote IDs to associate with the Identity Provider '
@@ -99,16 +100,15 @@ class CreateIdentityProvider(command.ShowOne):
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.identity
+        remote_ids: list[str] | None = None
         if parsed_args.remote_id_file:
             file_content = utils.read_blob_file_contents(
                 parsed_args.remote_id_file
             )
             remote_ids = file_content.splitlines()
             remote_ids = list(map(str.strip, remote_ids))
-        else:
-            remote_ids = (
-                parsed_args.remote_id if parsed_args.remote_id else None
-            )
+        elif parsed_args.remote_ids:
+            remote_ids = parsed_args.remote_ids
 
         domain_id = None
         if parsed_args.domain:
@@ -137,8 +137,9 @@ class CreateIdentityProvider(command.ShowOne):
         )
 
         idp._info.pop('links', None)
-        remote_ids = format_columns.ListColumn(idp._info.pop('remote_ids', []))
-        idp._info['remote_ids'] = remote_ids
+        idp._info['remote_ids'] = format_columns.ListColumn(
+            idp._info.pop('remote_ids', [])
+        )
         return zip(*sorted(idp._info.items()))
 
 
@@ -240,6 +241,7 @@ class SetIdentityProvider(command.Command):
         identity_remote_id_provider.add_argument(
             '--remote-id',
             metavar='<remote-id>',
+            dest='remote_ids',
             action='append',
             help=_(
                 'Remote IDs to associate with the Identity Provider '
@@ -287,8 +289,8 @@ class SetIdentityProvider(command.Command):
             )
             remote_ids = file_content.splitlines()
             remote_ids = list(map(str.strip, remote_ids))
-        elif parsed_args.remote_id:
-            remote_ids = parsed_args.remote_id
+        elif parsed_args.remote_ids:
+            remote_ids = parsed_args.remote_ids
 
         # Setup keyword args for the client
         kwargs = {}
@@ -298,7 +300,7 @@ class SetIdentityProvider(command.Command):
             kwargs['enabled'] = True
         if parsed_args.disable:
             kwargs['enabled'] = False
-        if parsed_args.remote_id_file or parsed_args.remote_id:
+        if parsed_args.remote_id_file or parsed_args.remote_ids:
             kwargs['remote_ids'] = remote_ids
 
         # TODO(pas-ha) actually check for 3.14 microversion

openstackclient/identity/v3/implied_role.py

@@ -17,8 +17,8 @@
 
 import logging
 
-from osc_lib.command import command
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/identity/v3/limit.py

@@ -15,10 +15,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 as common_utils
 

openstackclient/identity/v3/mapping.py

@@ -18,10 +18,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 _
 
 

openstackclient/identity/v3/policy.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/project.py

@@ -19,10 +19,10 @@ import logging
 
 from keystoneauth1 import exceptions as ks_exc
 from osc_lib.cli import parseractions
-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
 from openstackclient.identity.v3 import tag
@@ -73,8 +73,8 @@ class CreateProject(command.ShowOne):
         parser.add_argument(
             '--property',
             metavar='<key=value>',
-            action=parseractions.KeyValueAction,
             dest='properties',
+            action=parseractions.KeyValueAction,
             help=_(
                 'Add a property to <name> '
                 '(repeat option to set multiple properties)'
@@ -146,7 +146,14 @@ class CreateProject(command.ShowOne):
 
 
 class DeleteProject(command.Command):
-    _description = _("Delete project(s)")
+    _description = _(
+        "Delete project(s). This command will remove specified "
+        "existing project(s) if an active user is authorized to do "
+        "this. If there are resources managed by other services "
+        "(for example, Nova, Neutron, Cinder) associated with "
+        "specified project(s), delete operation will proceed "
+        "regardless."
+    )
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)

openstackclient/identity/v3/region.py

@@ -15,10 +15,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/registered_limit.py

@@ -15,10 +15,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 as common_utils
 
@@ -44,7 +44,10 @@ class CreateRegisteredLimit(command.ShowOne):
             '--service',
             metavar='<service>',
             required=True,
-            help=_('Service responsible for the resource to limit (required)'),
+            help=_(
+                'Service responsible for the resource to limit (required) '
+                '(name or ID)'
+            ),
         )
         parser.add_argument(
             '--default-limit',
@@ -106,10 +109,10 @@ class DeleteRegisteredLimit(command.Command):
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            'registered_limit_id',
-            metavar='<registered-limit-id>',
+            'registered_limits',
+            metavar='<registered-limits>',
             nargs="+",
-            help=_('Registered limit to delete (ID)'),
+            help=_('Registered limit(s) to delete (ID)'),
         )
         return parser
 
@@ -117,7 +120,7 @@ class DeleteRegisteredLimit(command.Command):
         identity_client = self.app.client_manager.identity
 
         errors = 0
-        for registered_limit_id in parsed_args.registered_limit_id:
+        for registered_limit_id in parsed_args.registered_limits:
             try:
                 identity_client.registered_limits.delete(registered_limit_id)
             except Exception as e:
@@ -134,7 +137,7 @@ class DeleteRegisteredLimit(command.Command):
                 )
 
         if errors > 0:
-            total = len(parsed_args.registered_limit_id)
+            total = len(parsed_args.registered_limits)
             msg = _(
                 "%(errors)s of %(total)s registered limits failed to delete."
             ) % {'errors': errors, 'total': total}
@@ -149,7 +152,9 @@ class ListRegisteredLimit(command.Lister):
         parser.add_argument(
             '--service',
             metavar='<service>',
-            help=_('Service responsible for the resource to limit'),
+            help=_(
+                'Service responsible for the resource to limit (name or ID)'
+            ),
         )
         parser.add_argument(
             '--resource-name',
@@ -228,9 +233,9 @@ class SetRegisteredLimit(command.ShowOne):
             '--service',
             metavar='<service>',
             help=_(
-                'Service to be updated responsible for the resource to '
-                'limit. Either --service, --resource-name or --region must '
-                'be different than existing value otherwise it will be '
+                'Service to be updated responsible for the resource to limit '
+                '(name or ID). Either --service, --resource-name or --region '
+                'must be different than existing value otherwise it will be '
                 'duplicate entry'
             ),
         )