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

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,7 +308,7 @@ 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
             )
 
@@ -381,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,
@@ -430,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 (
@@ -482,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,
@@ -582,7 +563,7 @@ 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,
             )
@@ -591,7 +572,7 @@ class SetRole(command.Command):
         if parsed_args.immutable is not None:
             update_kwargs["options"] = {"immutable": parsed_args.immutable}
 
-        role = _find_sdk_id(
+        role = common._find_sdk_id(
             identity_client.find_role,
             name_or_id=parsed_args.role,
             domain_id=domain_id,
@@ -623,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
 

openstackclient/identity/v3/service_provider.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/tag.py

@@ -114,6 +114,7 @@ def add_tag_option_to_parser_for_set(parser, resource_name):
     parser.add_argument(
         '--remove-tag',
         action='append',
+        dest='remove_tags',
         metavar='<tag>',
         default=[],
         help=_(
@@ -128,8 +129,8 @@ def update_tags_in_args(parsed_args, obj, args):
     if parsed_args.clear_tags:
         args['tags'] = []
         obj.tags = []
-    if parsed_args.remove_tag:
-        args['tags'] = sorted(set(obj.tags) - set(parsed_args.remove_tag))
+    if parsed_args.remove_tags:
+        args['tags'] = sorted(set(obj.tags) - set(parsed_args.remove_tags))
         return
     if parsed_args.tags:
         args['tags'] = sorted(set(obj.tags).union(set(parsed_args.tags)))

openstackclient/identity/v3/token.py

@@ -15,10 +15,10 @@
 
 """Identity v3 Token action implementations"""
 
-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
 
@@ -37,6 +37,7 @@ class AuthorizeRequestToken(command.ShowOne):
         parser.add_argument(
             '--role',
             metavar='<role>',
+            dest='roles',
             action='append',
             default=[],
             required=True,
@@ -52,7 +53,7 @@ class AuthorizeRequestToken(command.ShowOne):
 
         # NOTE(stevemar): We want a list of role ids
         roles = []
-        for role in parsed_args.role:
+        for role in parsed_args.roles:
             role_id = utils.find_resource(
                 identity_client.roles,
                 role,

openstackclient/identity/v3/trust.py

@@ -18,10 +18,10 @@ import itertools
 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
 
@@ -179,7 +179,9 @@ class CreateTrust(command.ShowOne):
         roles = []
         for role in parsed_args.roles:
             try:
-                role_id = identity_client.find_role(role).id
+                role_id = identity_client.find_role(
+                    role, ignore_missing=False
+                ).id
             except sdk_exceptions.ForbiddenException:
                 role_id = role
             roles.append({"id": role_id})

openstackclient/identity/v3/unscoped_saml.py

@@ -17,9 +17,9 @@ The first step of federated auth is to fetch an unscoped token. From there,
 the user can list domains and projects they are allowed to access, and request
 a scoped token."""
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/identity/v3/user.py

@@ -20,10 +20,10 @@ import logging
 import typing as ty
 
 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,9 +82,9 @@ def _get_options_for_user(identity_client, parsed_args):
         options['multi_factor_auth_enabled'] = True
     if parsed_args.disable_multi_factor_auth:
         options['multi_factor_auth_enabled'] = False
-    if parsed_args.multi_factor_auth_rule:
+    if parsed_args.multi_factor_auth_rules:
         auth_rules = [
-            rule.split(",") for rule in parsed_args.multi_factor_auth_rule
+            rule.split(",") for rule in parsed_args.multi_factor_auth_rules
         ]
         if auth_rules:
             options['multi_factor_auth_rules'] = auth_rules
@@ -175,7 +175,8 @@ def _add_user_options(parser):
     parser.add_argument(
         '--multi-factor-auth-rule',
         metavar='<rule>',
-        action="append",
+        dest='multi_factor_auth_rules',
+        action='append',
         default=[],
         help=_(
             'Set multi-factor auth rules. For example, to set a rule '
@@ -298,6 +299,9 @@ class CreateUser(command.ShowOne):
                     "when a user does not have a password."
                 )
             )
+        else:
+            kwargs['password'] = password
+
         options = _get_options_for_user(identity_client, parsed_args)
         if options:
             kwargs['options'] = options
@@ -306,7 +310,6 @@ class CreateUser(command.ShowOne):
             user = identity_client.create_user(
                 is_enabled=is_enabled,
                 name=parsed_args.name,
-                password=password,
                 **kwargs,
             )
         except sdk_exc.ConflictException:
@@ -420,7 +423,8 @@ class ListUser(command.Lister):
             dest='is_enabled',
             default=None,
             help=_(
-                'List only enabled users, does nothing with --project and --group'
+                'List only enabled users, does nothing with '
+                '--project and --group'
             ),
         )
         parser.add_argument(
@@ -429,7 +433,8 @@ class ListUser(command.Lister):
             dest='is_enabled',
             default=None,
             help=_(
-                'List only disabled users, does nothing with --project and --group'
+                'List only disabled users, does nothing with '
+                '--project and --group'
             ),
         )
         return parser
@@ -441,6 +446,7 @@ class ListUser(command.Lister):
         if parsed_args.domain:
             domain = identity_client.find_domain(
                 name_or_id=parsed_args.domain,
+                ignore_missing=False,
             ).id
 
         group = None
@@ -467,15 +473,13 @@ class ListUser(command.Lister):
                     ignore_missing=False,
                 ).id
 
-            assignments = identity_client.role_assignments_filter(
-                project=project
-            )
-
             # NOTE(stevemar): If a user has more than one role on a project
             # then they will have two entries in the returned data. Since we
             # are looking for any role, let's just track unique user IDs.
             user_ids = set()
-            for assignment in assignments:
+            for assignment in identity_client.role_assignments(
+                scope_project_id=project
+            ):
                 if assignment.user:
                     user_ids.add(assignment.user['id'])
 
@@ -689,7 +693,12 @@ class SetPasswordUser(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)
 
         # FIXME(gyee): there are two scenarios:
         #

openstackclient/image/v1/image.py

@@ -19,15 +19,16 @@ import argparse
 import logging
 import os
 import sys
+import typing as ty
 
 from cliff import columns as cliff_columns
 from osc_lib.api import utils as api_utils
 from osc_lib.cli import format_columns
 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 _
 
 CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"]
@@ -67,10 +68,7 @@ def _get_columns(item):
     )
 
 
-_formatters = {}
-
-
-class HumanReadableSizeColumn(cliff_columns.FormattableColumn):
+class HumanReadableSizeColumn(cliff_columns.FormattableColumn[int]):
     def human_readable(self):
         """Return a formatted visibility string
 
@@ -84,7 +82,7 @@ class HumanReadableSizeColumn(cliff_columns.FormattableColumn):
             return ''
 
 
-class VisibilityColumn(cliff_columns.FormattableColumn):
+class VisibilityColumn(cliff_columns.FormattableColumn[bool]):
     def human_readable(self):
         """Return a formatted visibility string
 
@@ -340,9 +338,12 @@ class CreateImage(command.ShowOne):
 
         if image:
             display_columns, columns = _get_columns(image)
-            _formatters['properties'] = format_columns.DictColumn
             data = utils.get_item_properties(
-                image, columns, formatters=_formatters
+                image,
+                columns,
+                formatters={
+                    'properties': format_columns.DictColumn,
+                },
             )
             return (display_columns, data)
         elif info:
@@ -493,19 +494,19 @@ class ListImage(command.Lister):
             column_headers = columns
 
         # List of image data received
-        data = list(image_client.images(**kwargs))
+        images = list(image_client.images(**kwargs))
 
         if parsed_args.property:
             # NOTE(dtroyer): coerce to a list to subscript it in py3
             attr, value = list(parsed_args.property.items())[0]
             api_utils.simple_filter(
-                data,
+                images,
                 attr=attr,
                 value=value,
                 property_field='properties',
             )
 
-        data = utils.sort_items(data, parsed_args.sort)
+        data = utils.sort_items(images, parsed_args.sort)
 
         return (
             column_headers,
@@ -839,11 +840,13 @@ class ShowImage(command.ShowOne):
             parsed_args.image, ignore_missing=False
         )
 
+        formatters: dict[
+            str, type[cliff_columns.FormattableColumn[ty.Any]]
+        ] = {
+            'properties': format_columns.DictColumn,
+        }
         if parsed_args.human_readable:
-            _formatters['size'] = HumanReadableSizeColumn
+            formatters['size'] = HumanReadableSizeColumn
         display_columns, columns = _get_columns(image)
-        _formatters['properties'] = format_columns.DictColumn
-        data = utils.get_item_properties(
-            image, columns, formatters=_formatters
-        )
+        data = utils.get_item_properties(image, columns, formatters=formatters)
         return (display_columns, data)

openstackclient/image/v2/cache.py

@@ -17,10 +17,10 @@ import copy
 import datetime
 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 _