python-openstackclient 7.1.2__py3-none-any.whl → 7.2.0__py3-none-any.whl

openstackclient/identity/v2_0/role_assignment.py

@@ -11,7 +11,7 @@
 #   under the License.
 #
 
-"""Identity v2 Assignment action implementations """
+"""Identity v2 Assignment action implementations"""
 
 from osc_lib.command import command
 from osc_lib import exceptions

openstackclient/identity/v2_0/user.py

@@ -250,9 +250,9 @@ class ListUser(command.Lister):
             try:
                 for p in identity_client.tenants.list():
                     project_cache[p.id] = p
-            except Exception:
+            except Exception:  # noqa: S110
                 # Just forget it if there's any trouble
-                pass  # nosec: B110
+                pass
             formatters['tenantId'] = functools.partial(
                 ProjectColumn, project_cache=project_cache
             )

openstackclient/identity/v3/access_rule.py

@@ -42,15 +42,15 @@ class DeleteAccessRule(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        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)
 
         errors = 0
         for ac in parsed_args.access_rule:
             try:
-                access_rule = common.get_resource_by_id(
-                    identity_client.access_rules, ac
-                )
-                identity_client.access_rules.delete(access_rule.id)
+                access_rule = identity_client.get_access_rule(user_id, ac)
+                identity_client.delete_access_rule(user_id, access_rule.id)
             except Exception as e:
                 errors += 1
                 LOG.error(
@@ -83,16 +83,17 @@ class ListAccessRule(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
         if parsed_args.user:
             user_id = common.find_user(
                 identity_client, parsed_args.user, parsed_args.user_domain
             ).id
         else:
-            user_id = None
+            conn = self.app.client_manager.sdk_connection
+            user_id = conn.config.get_auth().get_user_id(conn.identity)
 
         columns = ('ID', 'Service', 'Method', 'Path')
-        data = identity_client.access_rules.list(user=user_id)
+        data = identity_client.access_rules(user=user_id)
         return (
             columns,
             (
@@ -119,11 +120,22 @@ class ShowAccessRule(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        access_rule = common.get_resource_by_id(
-            identity_client.access_rules, parsed_args.access_rule
-        )
+        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)
 
-        access_rule._info.pop('links', None)
+        access_rule = identity_client.get_access_rule(
+            user_id, parsed_args.access_rule
+        )
 
-        return zip(*sorted(access_rule._info.items()))
+        columns = ('ID', 'Method', 'Path', 'Service')
+        return (
+            columns,
+            (
+                utils.get_item_properties(
+                    access_rule,
+                    columns,
+                    formatters={},
+                )
+            ),
+        )

openstackclient/identity/v3/identity_provider.py

@@ -133,7 +133,7 @@ class CreateIdentityProvider(command.ShowOne):
             description=parsed_args.description,
             domain_id=domain_id,
             enabled=parsed_args.enabled,
-            **kwargs
+            **kwargs,
         )
 
         idp._info.pop('links', None)

openstackclient/identity/v3/project.py

@@ -125,7 +125,7 @@ class CreateProject(command.ShowOne):
                 description=parsed_args.description,
                 enabled=enabled,
                 options=options,
-                **kwargs
+                **kwargs,
             )
         except ks_exc.Conflict:
             if parsed_args.or_show:

openstackclient/identity/v3/role_assignment.py

@@ -146,12 +146,19 @@ class ListRoleAssignment(command.Lister):
                 domain_id=role_domain_id,
             )
 
+        user_domain_id = None
+        if parsed_args.user_domain:
+            project_domain_id = _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(
                 identity_client.find_user,
                 name_or_id=parsed_args.user,
-                domain_id=parsed_args.user_domain,
+                domain_id=user_domain_id,
             )
         elif parsed_args.authuser:
             if auth_ref:
@@ -171,6 +178,13 @@ class ListRoleAssignment(command.Lister):
                 name_or_id=parsed_args.domain,
             )
 
+        project_domain_id = None
+        if parsed_args.project_domain:
+            project_domain_id = _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(
@@ -178,7 +192,7 @@ class ListRoleAssignment(command.Lister):
                 name_or_id=common._get_token_resource(
                     identity_client, 'project', parsed_args.project
                 ),
-                domain_id=parsed_args.project_domain,
+                domain_id=project_domain_id,
             )
         elif parsed_args.authproject:
             if auth_ref:
@@ -187,12 +201,19 @@ class ListRoleAssignment(command.Lister):
                     name_or_id=auth_ref.project_id,
                 )
 
+        group_domain_id = None
+        if parsed_args.group_domain:
+            group_domain_id = _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(
                 identity_client.find_group,
                 name_or_id=parsed_args.group,
-                domain_id=parsed_args.group_domain,
+                domain_id=group_domain_id,
             )
 
         include_names = True if parsed_args.names else None

openstackclient/identity/v3/service.py

@@ -225,7 +225,8 @@ class SetService(command.Command):
             kwargs['name'] = parsed_args.name
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
-        kwargs['is_enabled'] = parsed_args.is_enabled
+        if parsed_args.is_enabled is not None:
+            kwargs['is_enabled'] = parsed_args.is_enabled
 
         identity_client.update_service(service.id, **kwargs)
 

openstackclient/identity/v3/user.py

@@ -249,26 +249,44 @@ class CreateUser(command.ShowOne):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
 
+        kwargs = {}
+
         domain_id = None
         if parsed_args.domain:
             domain_id = identity_client.find_domain(
-                name_or_id=parsed_args.domain,
+                parsed_args.domain,
                 ignore_missing=False,
             ).id
+            kwargs['domain_id'] = domain_id
 
-        project_id = None
         if parsed_args.project:
-            project_id = identity_client.find_project(
-                name_or_id=parsed_args.project,
+            project_domain_id = None
+            if parsed_args.project_domain:
+                project_domain_id = identity_client.find_domain(
+                    parsed_args.project_domain,
+                    ignore_missing=False,
+                ).id
+            kwargs['default_project_id'] = identity_client.find_project(
+                parsed_args.project,
                 ignore_missing=False,
-                domain_id=domain_id,
+                domain_id=project_domain_id,
             ).id
 
+        if parsed_args.description:
+            kwargs['description'] = parsed_args.description
+
+        if parsed_args.email:
+            kwargs['email'] = parsed_args.email
+
         is_enabled = True
         if parsed_args.disable:
             is_enabled = False
-        if parsed_args.password_prompt:
-            parsed_args.password = utils.get_password(self.app.stdin)
+
+        password = None
+        if parsed_args.password:
+            password = parsed_args.password
+        elif parsed_args.password_prompt:
+            password = utils.get_password(self.app.stdin)
 
         if not parsed_args.password:
             LOG.warning(
@@ -278,24 +296,26 @@ class CreateUser(command.ShowOne):
                 )
             )
         options = _get_options_for_user(identity_client, parsed_args)
+        if options:
+            kwargs['options'] = options
 
         try:
             user = identity_client.create_user(
-                default_project_id=project_id,
-                description=parsed_args.description,
-                domain_id=domain_id,
-                email=parsed_args.email,
                 is_enabled=is_enabled,
                 name=parsed_args.name,
-                password=parsed_args.password,
-                options=options,
+                password=password,
+                **kwargs,
             )
         except sdk_exc.ConflictException:
             if parsed_args.or_show:
+                kwargs = {}
+                if domain_id:
+                    kwargs['domain_id'] = domain_id
+
                 user = identity_client.find_user(
-                    name_or_id=parsed_args.name,
-                    domain_id=domain_id,
+                    parsed_args.name,
                     ignore_missing=False,
+                    **kwargs,
                 )
                 LOG.info(_('Returning existing user %s'), user.name)
             else:

openstackclient/image/v2/image.py

@@ -421,8 +421,8 @@ class CreateImage(command.ShowOne):
         identity_common.add_project_domain_option_to_parser(parser)
         for deadopt in self.deadopts:
             parser.add_argument(
-                "--%s" % deadopt,
-                metavar="<%s>" % deadopt,
+                f"--{deadopt}",
+                metavar=f"<{deadopt}>",
                 dest=deadopt.replace('-', '_'),
                 help=argparse.SUPPRESS,
             )
@@ -488,7 +488,7 @@ class CreateImage(command.ShowOne):
                 fp = open(parsed_args.filename, 'rb')
             except FileNotFoundError:
                 raise exceptions.CommandError(
-                    '%r is not a valid file' % parsed_args.filename,
+                    f'{parsed_args.filename!r} is not a valid file',
                 )
         else:
             fp = get_data_from_stdin()
@@ -1209,8 +1209,8 @@ class SetImage(command.Command):
         identity_common.add_project_domain_option_to_parser(parser)
         for deadopt in self.deadopts:
             parser.add_argument(
-                "--%s" % deadopt,
-                metavar="<%s>" % deadopt,
+                f"--{deadopt}",
+                metavar=f"<{deadopt}>",
                 dest=f"dead_{deadopt.replace('-', '_')}",
                 help=argparse.SUPPRESS,
             )
@@ -1575,7 +1575,7 @@ class StageImage(command.Command):
                 fp = open(parsed_args.filename, 'rb')
             except FileNotFoundError:
                 raise exceptions.CommandError(
-                    '%r is not a valid file' % parsed_args.filename,
+                    f'{parsed_args.filename!r} is not a valid file',
                 )
         else:
             fp = get_data_from_stdin()
@@ -1614,8 +1614,6 @@ class ImportImage(command.ShowOne):
             metavar='<image>',
             help=_('Image to initiate import process for (name or ID)'),
         )
-        # TODO(stephenfin): Uncomment help text when we have this command
-        # implemented
         parser.add_argument(
             '--method',
             metavar='<method>',
@@ -1630,8 +1628,6 @@ class ImportImage(command.ShowOne):
             help=_(
                 "Import method used for image import process. "
                 "Not all deployments will support all methods. "
-                # "Valid values can be retrieved with the 'image import "
-                # "methods' command. "
                 "The 'glance-direct' method (default) requires images be "
                 "first staged using the 'image-stage' command."
             ),
@@ -1734,11 +1730,15 @@ class ImportImage(command.ShowOne):
 
         if parsed_args.import_method not in import_methods:
             msg = _(
-                "The '%s' import method is not supported by this deployment. "
-                "Supported: %s"
+                "The '%(method)s' import method is not supported by this "
+                "deployment. Supported: %(supported)s"
             )
             raise exceptions.CommandError(
-                msg % (parsed_args.import_method, ', '.join(import_methods)),
+                msg
+                % {
+                    'method': parsed_args.import_method,
+                    'supported': ', '.join(import_methods),
+                },
             )
 
         if parsed_args.import_method == 'web-download':

openstackclient/image/v2/metadef_objects.py

@@ -260,10 +260,12 @@ class ShowMetadefObjectProperty(command.ShowOne):
             prop['name'] = parsed_args.property
 
         except KeyError:
-            msg = _('Property %s not found in object %s.') % (
-                parsed_args.property,
-                parsed_args.object,
-            )
+            msg = _(
+                'Property %(property)s not found in object %(object)s.'
+            ) % {
+                'property': parsed_args.property,
+                'object': parsed_args.object,
+            }
             raise exceptions.CommandError(msg)
 
         return zip(*sorted(prop.items()))

openstackclient/network/common.py

@@ -120,13 +120,14 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
     @staticmethod
     def split_help(network_help, compute_help):
         return (
-            "*%(network_qualifier)s:*\n  %(network_help)s\n\n"
-            "*%(compute_qualifier)s:*\n  %(compute_help)s"
-            % dict(
-                network_qualifier=_("Network version 2"),
-                network_help=network_help,
-                compute_qualifier=_("Compute version 2"),
-                compute_help=compute_help,
+            "*{network_qualifier}:*\n  {network_help}\n\n"
+            "*{compute_qualifier}:*\n  {compute_help}".format(
+                **dict(
+                    network_qualifier=_("Network version 2"),
+                    network_help=network_help,
+                    compute_qualifier=_("Compute version 2"),
+                    compute_help=compute_help,
+                )
             )
         )
 

openstackclient/network/v2/floating_ip.py

@@ -12,6 +12,7 @@
 
 """IP Floating action implementations"""
 
+from openstack import exceptions as sdk_exceptions
 from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
@@ -390,7 +391,10 @@ class ListFloatingIP(common.NetworkAndComputeLister):
 
         _tag.get_tag_filtering_args(parsed_args, query)
 
-        data = client.ips(**query)
+        try:
+            data = list(client.ips(**query))
+        except sdk_exceptions.NotFoundException:
+            data = []
 
         return (
             headers,
@@ -448,7 +452,7 @@ class SetFloatingIP(common.NeutronCommandWithExtraArgs):
             '--port',
             metavar='<port>',
             help=_("Associate the floating IP with port (name or ID)"),
-        ),
+        )
         parser.add_argument(
             '--fixed-ip-address',
             metavar='<ip-address>',

openstackclient/network/v2/floating_ip_port_forwarding.py

@@ -144,7 +144,7 @@ class CreateFloatingIPPortForwarding(
                 "The protocol used in the floating IP "
                 "port forwarding, for instance: TCP, UDP"
             ),
-        ),
+        )
         parser.add_argument(
             '--description',
             metavar='<description>',
@@ -404,7 +404,7 @@ class SetFloatingIPPortForwarding(common.NeutronCommandWithExtraArgs):
             metavar='<protocol>',
             choices=['tcp', 'udp'],
             help=_("The IP protocol used in the floating IP port forwarding"),
-        ),
+        )
         parser.add_argument(
             '--description',
             metavar='<description>',

openstackclient/network/v2/l3_conntrack_helper.py

@@ -245,7 +245,7 @@ class SetConntrackHelper(command.Command):
             client.update_conntrack_helper(
                 parsed_args.conntrack_helper_id,
                 attrs.pop('router_id'),
-                **attrs
+                **attrs,
             )
 
 

openstackclient/network/v2/ndp_proxy.py

@@ -14,6 +14,7 @@
 #    under the License.
 
 """Router NDP proxy action implementations"""
+
 import logging
 
 from osc_lib.command import command

openstackclient/network/v2/network_agent.py

@@ -89,9 +89,7 @@ class AddNetworkToAgent(command.Command):
             try:
                 client.add_dhcp_agent_to_network(agent, network)
             except Exception:
-                msg = 'Failed to add {} to {}'.format(
-                    network.name, agent.agent_type
-                )
+                msg = f'Failed to add {network.name} to {agent.agent_type}'
                 exceptions.CommandError(msg)
 
 
@@ -321,9 +319,7 @@ class RemoveNetworkFromAgent(command.Command):
             try:
                 client.remove_dhcp_agent_from_network(agent, network)
             except Exception:
-                msg = 'Failed to remove {} to {}'.format(
-                    network.name, agent.agent_type
-                )
+                msg = f'Failed to remove {network.name} to {agent.agent_type}'
                 exceptions.CommandError(msg)
 
 

openstackclient/network/v2/network_qos_rule.py

@@ -159,10 +159,7 @@ def _get_item_properties(item, fields):
 
 def _rule_action_call(client, action, rule_type):
     rule_type = rule_type.replace('-', '_')
-    func_name = '{action}_qos_{rule_type}_rule'.format(
-        action=action,
-        rule_type=rule_type,
-    )
+    func_name = f'{action}_qos_{rule_type}_rule'
     return getattr(client, func_name)
 
 
@@ -311,7 +308,7 @@ class DeleteNetworkQosRule(command.Command):
             )
             rule_type = _find_rule_type(qos, rule_id)
             if not rule_type:
-                raise Exception('Rule %s not found' % rule_id)
+                raise Exception(f'Rule {rule_id} not found')
             _rule_action_call(network_client, ACTION_DELETE, rule_type)(
                 rule_id, qos.id
             )

openstackclient/network/v2/network_trunk.py

@@ -15,6 +15,7 @@
 #
 
 """Network trunk and subports action implementations"""
+
 import logging
 
 from cliff import columns as cliff_columns
@@ -67,8 +68,8 @@ class CreateNetworkTrunk(command.ShowOne):
             required_keys=['port'],
             help=_(
                 "Subport to add. Subport is of form "
-                "\'port=<name or ID>,segmentation-type=<segmentation-type>,"
-                "segmentation-id=<segmentation-ID>\' (--subport) option "
+                "'port=<name or ID>,segmentation-type=<segmentation-type>,"
+                "segmentation-id=<segmentation-ID>' (--subport) option "
                 "can be repeated"
             ),
         )
@@ -198,8 +199,8 @@ class SetNetworkTrunk(command.Command):
             required_keys=['port'],
             help=_(
                 "Subport to add. Subport is of form "
-                "\'port=<name or ID>,segmentation-type=<segmentation-type>"
-                ",segmentation-id=<segmentation-ID>\' (--subport) option "
+                "'port=<name or ID>,segmentation-type=<segmentation-type>"
+                ",segmentation-id=<segmentation-ID>' (--subport) option "
                 "can be repeated"
             ),
         )

openstackclient/network/v2/port.py

@@ -274,13 +274,13 @@ def _prepare_filter_fixed_ips(client_manager, parsed_args):
                 _subnet = client.find_subnet(
                     subnet_name_id, ignore_missing=False
                 )
-                ips.append('subnet_id=%s' % _subnet.id)
+                ips.append(f'subnet_id={_subnet.id}')
 
         if 'ip-address' in ip_spec:
-            ips.append('ip_address=%s' % ip_spec['ip-address'])
+            ips.append('ip_address={}'.format(ip_spec['ip-address']))
 
         if 'ip-substring' in ip_spec:
-            ips.append('ip_address_substr=%s' % ip_spec['ip-substring'])
+            ips.append('ip_address_substr={}'.format(ip_spec['ip-substring']))
     return ips
 
 
@@ -792,6 +792,19 @@ class ListPort(command.Lister):
             metavar='<security-group>',
             help=_("List only ports associated with this security group"),
         )
+        # the API sadly reports these in upper case and while it would be
+        # wonderful to plaster over this ugliness client-side, there are
+        # already users in the wild doing this in upper case that we need to
+        # support
+        parser.add_argument(
+            '--status',
+            metavar='<status>',
+            choices=('ACTIVE', 'BUILD', 'DOWN', 'ERROR'),
+            help=_(
+                "List ports according to their status "
+                "('ACTIVE', 'BUILD', 'DOWN', 'ERROR')"
+            ),
+        )
         identity_common.add_project_domain_option_to_parser(parser)
         parser.add_argument(
             '--fixed-ip',
@@ -859,6 +872,8 @@ class ListPort(command.Lister):
             filters['network_id'] = network.id
         if parsed_args.mac_address:
             filters['mac_address'] = parsed_args.mac_address
+        if parsed_args.status:
+            filters['status'] = parsed_args.status
         if parsed_args.project:
             project_id = identity_common.find_project(
                 identity_client,

openstackclient/network/v2/router.py

@@ -164,10 +164,13 @@ def _get_external_gateway_attrs(client_manager, parsed_args):
                     'subnet_id' in ip_spec
                     and ip_net_id not in external_gateways
                 ):
-                    msg = _(
-                        'Subnet %s does not belong to any of the networks '
-                        'provided for --external-gateway.'
-                    ) % (ip_spec['subnet_id'])
+                    msg = (
+                        _(
+                            'Subnet %s does not belong to any of the networks '
+                            'provided for --external-gateway.'
+                        )
+                        % (ip_spec['subnet_id'])
+                    )
                     raise exceptions.CommandError(msg)
                 for gw_info in external_gateways[ip_net_id]:
                     if 'external_fixed_ips' not in gw_info:

openstackclient/network/v2/subnet_pool.py

@@ -201,7 +201,7 @@ class CreateSubnetPool(command.ShowOne, common.NeutronCommandWithExtraArgs):
                 "as the number of IP addresses that can be allocated "
                 "from the subnet pool"
             ),
-        ),
+        )
         _tag.add_tag_option_to_parser_for_create(parser, _('subnet pool'))
         return parser
 
@@ -433,7 +433,7 @@ class SetSubnetPool(common.NeutronCommandWithExtraArgs):
                 "as the number of IP addresses that can be allocated "
                 "from the subnet pool"
             ),
-        ),
+        )
         _tag.add_tag_option_to_parser_for_set(parser, _('subnet pool'))
 
         return parser

openstackclient/shell.py

@@ -96,8 +96,9 @@ class OpenStackShell(shell.OpenStackShell):
                             key=lambda s: list(map(int, s.split('.'))),
                         )
                         self.log.warning(
-                            "%s version %s is not in supported versions: %s"
-                            % (api, version_opt, ', '.join(sorted_versions))
+                            "{} version {} is not in supported versions: {}".format(
+                                api, version_opt, ', '.join(sorted_versions)
+                            )
                         )
 
                 # Command groups deal only with major versions

openstackclient/tests/functional/common/test_help.py

@@ -21,7 +21,7 @@ class HelpTests(base.TestCase):
     """Functional tests for openstackclient help output."""
 
     SERVER_COMMANDS = [
-        ('server add security group', 'Add security group to server'),
+        ('server add security group', 'Add security group(s) to server'),
         ('server add volume', 'Add volume to server'),
         ('server backup create', 'Create a server backup image'),
         ('server create', 'Create a new server'),
@@ -60,15 +60,9 @@ class HelpTests(base.TestCase):
         """Check server commands in main help message."""
         raw_output = self.openstack('help')
         for command, description in self.SERVER_COMMANDS:
-            msg = 'Command: {} not found in help output:\n{}'.format(
-                command,
-                raw_output,
-            )
+            msg = f'Command: {command} not found in help output:\n{raw_output}'
             self.assertIn(command, raw_output, msg)
-            msg = 'Description: {} not found in help output:\n{}'.format(
-                description,
-                raw_output,
-            )
+            msg = f'Description: {description} not found in help output:\n{raw_output}'
             self.assertIn(description, raw_output, msg)
 
     def test_server_only_help(self):