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

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
@@ -59,16 +59,21 @@ class CreateProject(command.ShowOne):
         enable_group.add_argument(
             '--enable',
             action='store_true',
+            dest='enabled',
+            default=True,
             help=_('Enable project'),
         )
         enable_group.add_argument(
             '--disable',
-            action='store_true',
+            action='store_false',
+            dest='enabled',
+            default=True,
             help=_('Disable project'),
         )
         parser.add_argument(
             '--property',
             metavar='<key=value>',
+            dest='properties',
             action=parseractions.KeyValueAction,
             help=_(
                 'Add a property to <name> '
@@ -98,15 +103,9 @@ class CreateProject(command.ShowOne):
                 parsed_args.parent,
             ).id
 
-        enabled = True
-        if parsed_args.disable:
-            enabled = False
-
-        options = common.get_immutable_options(parsed_args)
-
         kwargs = {}
-        if parsed_args.property:
-            kwargs = parsed_args.property.copy()
+        if parsed_args.properties:
+            kwargs = parsed_args.properties.copy()
         if 'is_domain' in kwargs.keys():
             if kwargs['is_domain'].lower() == "true":
                 kwargs['is_domain'] = True
@@ -117,13 +116,17 @@ class CreateProject(command.ShowOne):
 
         kwargs['tags'] = list(set(parsed_args.tags))
 
+        options = {}
+        if parsed_args.immutable is not None:
+            options['immutable'] = parsed_args.immutable
+
         try:
             project = identity_client.projects.create(
                 name=parsed_args.name,
                 domain=domain,
                 parent=parent,
                 description=parsed_args.description,
-                enabled=enabled,
+                enabled=parsed_args.enabled,
                 options=options,
                 **kwargs,
             )
@@ -143,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)
@@ -356,16 +366,21 @@ class SetProject(command.Command):
         enable_group.add_argument(
             '--enable',
             action='store_true',
+            dest='enabled',
+            default=None,
             help=_('Enable project'),
         )
         enable_group.add_argument(
             '--disable',
-            action='store_true',
+            action='store_false',
+            dest='enabled',
+            default=None,
             help=_('Disable project'),
         )
         parser.add_argument(
             '--property',
             metavar='<key=value>',
+            dest='properties',
             action=parseractions.KeyValueAction,
             help=_(
                 'Set a property on <project> '
@@ -388,15 +403,12 @@ class SetProject(command.Command):
             kwargs['name'] = parsed_args.name
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
-        if parsed_args.enable:
-            kwargs['enabled'] = True
-        if parsed_args.disable:
-            kwargs['enabled'] = False
-        options = common.get_immutable_options(parsed_args)
-        if options:
-            kwargs['options'] = options
-        if parsed_args.property:
-            kwargs.update(parsed_args.property)
+        if parsed_args.enabled is not None:
+            kwargs['enabled'] = parsed_args.enabled
+        if parsed_args.immutable is not None:
+            kwargs['options'] = {'immutable': parsed_args.immutable}
+        if parsed_args.properties:
+            kwargs.update(parsed_args.properties)
         tag.update_tags_in_args(parsed_args, project, kwargs)
 
         identity_client.projects.update(project.id, **kwargs)

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'
             ),
         )

openstackclient/identity/v3/role.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
 
@@ -82,32 +82,12 @@ def _add_identity_and_resource_options_to_parser(parser):
     common.add_inherited_option_to_parser(parser)
 
 
-def _find_sdk_id(
-    find_command, name_or_id, validate_actor_existence=True, **kwargs
-):
-    try:
-        resource = find_command(
-            name_or_id=name_or_id, ignore_missing=False, **kwargs
-        )
-
-    # Mimic the behavior of
-    # openstackclient.identity.common._find_identity_resource()
-    # and ignore if we don't have permission to find a resource.
-    except sdk_exc.ForbiddenException:
-        return name_or_id
-    except sdk_exc.ResourceNotFound as exc:
-        if not validate_actor_existence:
-            return name_or_id
-        raise exceptions.CommandError from exc
-    return resource.id
-
-
 def _process_identity_and_resource_options(
     parsed_args, identity_client, validate_actor_existence=True
 ):
     def _find_user():
         domain_id = (
-            _find_sdk_id(
+            common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.user_domain,
                 validate_actor_existence=validate_actor_existence,
@@ -115,7 +95,7 @@ def _process_identity_and_resource_options(
             if parsed_args.user_domain
             else None
         )
-        return _find_sdk_id(
+        return common._find_sdk_id(
             identity_client.find_user,
             name_or_id=parsed_args.user,
             validate_actor_existence=validate_actor_existence,
@@ -124,7 +104,7 @@ def _process_identity_and_resource_options(
 
     def _find_group():
         domain_id = (
-            _find_sdk_id(
+            common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.group_domain,
                 validate_actor_existence=validate_actor_existence,
@@ -132,7 +112,7 @@ def _process_identity_and_resource_options(
             if parsed_args.group_domain
             else None
         )
-        return _find_sdk_id(
+        return common._find_sdk_id(
             identity_client.find_group,
             name_or_id=parsed_args.group,
             validate_actor_existence=validate_actor_existence,
@@ -141,7 +121,7 @@ def _process_identity_and_resource_options(
 
     def _find_project():
         domain_id = (
-            _find_sdk_id(
+            common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.project_domain,
                 validate_actor_existence=validate_actor_existence,
@@ -149,7 +129,7 @@ def _process_identity_and_resource_options(
             if parsed_args.project_domain
             else None
         )
-        return _find_sdk_id(
+        return common._find_sdk_id(
             identity_client.find_project,
             name_or_id=parsed_args.project,
             validate_actor_existence=validate_actor_existence,
@@ -162,7 +142,7 @@ def _process_identity_and_resource_options(
         kwargs['system'] = parsed_args.system
     elif parsed_args.user and parsed_args.domain:
         kwargs['user'] = _find_user()
-        kwargs['domain'] = _find_sdk_id(
+        kwargs['domain'] = common._find_sdk_id(
             identity_client.find_domain,
             name_or_id=parsed_args.domain,
             validate_actor_existence=validate_actor_existence,
@@ -175,7 +155,7 @@ def _process_identity_and_resource_options(
         kwargs['system'] = parsed_args.system
     elif parsed_args.group and parsed_args.domain:
         kwargs['group'] = _find_group()
-        kwargs['domain'] = _find_sdk_id(
+        kwargs['domain'] = common._find_sdk_id(
             identity_client.find_domain,
             name_or_id=parsed_args.domain,
             validate_actor_existence=validate_actor_existence,
@@ -228,10 +208,10 @@ class AddRole(command.Command):
 
         domain_id = None
         if parsed_args.role_domain:
-            domain_id = _find_sdk_id(
+            domain_id = common._find_sdk_id(
                 identity_client.find_domain, name_or_id=parsed_args.role_domain
             )
-        role = _find_sdk_id(
+        role = common._find_sdk_id(
             identity_client.find_role,
             name_or_id=parsed_args.role,
             domain_id=domain_id,
@@ -328,15 +308,18 @@ class CreateRole(command.ShowOne):
 
         create_kwargs = {}
         if parsed_args.domain:
-            create_kwargs['domain_id'] = _find_sdk_id(
+            create_kwargs['domain_id'] = common._find_sdk_id(
                 identity_client.find_domain, name_or_id=parsed_args.domain
             )
 
         if parsed_args.name:
             create_kwargs['name'] = parsed_args.name
+
         if parsed_args.description:
             create_kwargs['description'] = parsed_args.description
-        create_kwargs['options'] = common.get_immutable_options(parsed_args)
+
+        if parsed_args.immutable is not None:
+            create_kwargs['options'] = {"immutable": parsed_args.immutable}
 
         try:
             role = identity_client.create_role(**create_kwargs)
@@ -378,13 +361,13 @@ class DeleteRole(command.Command):
 
         domain_id = None
         if parsed_args.domain:
-            domain_id = _find_sdk_id(
+            domain_id = common._find_sdk_id(
                 identity_client.find_domain, parsed_args.domain
             )
         errors = 0
         for role in parsed_args.roles:
             try:
-                role_id = _find_sdk_id(
+                role_id = common._find_sdk_id(
                     identity_client.find_role,
                     name_or_id=role,
                     domain_id=domain_id,
@@ -427,6 +410,7 @@ class ListRole(command.Lister):
         if parsed_args.domain:
             domain = identity_client.find_domain(
                 name_or_id=parsed_args.domain,
+                ignore_missing=False,
             )
             data = identity_client.roles(domain_id=domain.id)
             return (
@@ -479,11 +463,11 @@ class RemoveRole(command.Command):
 
         domain_id = None
         if parsed_args.role_domain:
-            domain_id = _find_sdk_id(
+            domain_id = common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.role_domain,
             )
-        role = _find_sdk_id(
+        role = common._find_sdk_id(
             identity_client.find_role,
             name_or_id=parsed_args.role,
             domain_id=domain_id,
@@ -579,14 +563,16 @@ class SetRole(command.Command):
 
         domain_id = None
         if parsed_args.domain:
-            domain_id = _find_sdk_id(
+            domain_id = common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.domain,
             )
             update_kwargs["domain_id"] = domain_id
 
-        update_kwargs["options"] = common.get_immutable_options(parsed_args)
-        role = _find_sdk_id(
+        if parsed_args.immutable is not None:
+            update_kwargs["options"] = {"immutable": parsed_args.immutable}
+
+        role = common._find_sdk_id(
             identity_client.find_role,
             name_or_id=parsed_args.role,
             domain_id=domain_id,
@@ -618,7 +604,7 @@ class ShowRole(command.ShowOne):
 
         domain_id = None
         if parsed_args.domain:
-            domain_id = _find_sdk_id(
+            domain_id = common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.domain,
             )

openstackclient/identity/v3/role_assignment.py

@@ -13,9 +13,7 @@
 
 """Identity v3 Assignment action implementations"""
 
-from openstack import exceptions as sdk_exceptions
-from osc_lib.command import command
-
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
@@ -51,15 +49,6 @@ def _format_role_assignment_(assignment, include_names):
     )
 
 
-def _find_sdk_id(find_command, name_or_id, **kwargs):
-    try:
-        return find_command(
-            name_or_id=name_or_id, ignore_missing=False, **kwargs
-        ).id
-    except sdk_exceptions.ForbiddenException:
-        return name_or_id
-
-
 class ListRoleAssignment(command.Lister):
     _description = _("List role assignments")
 
@@ -135,12 +124,12 @@ class ListRoleAssignment(command.Lister):
         role_id = None
         role_domain_id = None
         if parsed_args.role_domain:
-            role_domain_id = _find_sdk_id(
+            role_domain_id = common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.role_domain,
             )
         if parsed_args.role:
-            role_id = _find_sdk_id(
+            role_id = common._find_sdk_id(
                 identity_client.find_role,
                 name_or_id=parsed_args.role,
                 domain_id=role_domain_id,
@@ -148,21 +137,21 @@ class ListRoleAssignment(command.Lister):
 
         user_domain_id = None
         if parsed_args.user_domain:
-            user_domain_id = _find_sdk_id(
+            user_domain_id = common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.user_domain,
             )
 
         user_id = None
         if parsed_args.user:
-            user_id = _find_sdk_id(
+            user_id = common._find_sdk_id(
                 identity_client.find_user,
                 name_or_id=parsed_args.user,
                 domain_id=user_domain_id,
             )
         elif parsed_args.authuser:
             if auth_ref:
-                user_id = _find_sdk_id(
+                user_id = common._find_sdk_id(
                     identity_client.find_user,
                     name_or_id=auth_ref.user_id,
                 )
@@ -173,21 +162,21 @@ class ListRoleAssignment(command.Lister):
 
         domain_id = None
         if parsed_args.domain:
-            domain_id = _find_sdk_id(
+            domain_id = common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.domain,
             )
 
         project_domain_id = None
         if parsed_args.project_domain:
-            project_domain_id = _find_sdk_id(
+            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_id = _find_sdk_id(
+            project_id = common._find_sdk_id(
                 identity_client.find_project,
                 name_or_id=common._get_token_resource(
                     identity_client, 'project', parsed_args.project
@@ -196,21 +185,21 @@ class ListRoleAssignment(command.Lister):
             )
         elif parsed_args.authproject:
             if auth_ref:
-                project_id = _find_sdk_id(
+                project_id = common._find_sdk_id(
                     identity_client.find_project,
                     name_or_id=auth_ref.project_id,
                 )
 
         group_domain_id = None
         if parsed_args.group_domain:
-            group_domain_id = _find_sdk_id(
+            group_domain_id = common._find_sdk_id(
                 identity_client.find_domain,
                 name_or_id=parsed_args.group_domain,
             )
 
         group_id = None
         if parsed_args.group:
-            group_id = _find_sdk_id(
+            group_id = common._find_sdk_id(
                 identity_client.find_group,
                 name_or_id=parsed_args.group,
                 domain_id=group_domain_id,

openstackclient/identity/v3/service.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