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

openstackclient/common/module.py

@@ -61,7 +61,7 @@ class ListCommand(command.Lister):
                 # TODO(bapalm): Fix this when cliff properly supports
                 # handling the detection rather than using the hard-code below.
                 if parsed_args.formatter == 'table':
-                    command_names = utils.format_list(command_names, "\n")
+                    command_names = utils.format_list(command_names, "\n")  # type: ignore
 
                 commands.append((group, command_names))
 

openstackclient/common/quota.py

@@ -272,7 +272,10 @@ class ListQuota(command.Lister):
                 sdk_exceptions.NotFoundException,
             ) as exc:
                 # Project not found, move on to next one
-                LOG.warning(f"Project {project_id} not found: {exc}")
+                LOG.warning(
+                    'Project %(project_id)s not found: %(exc)s',
+                    {'project_id': project_id, 'exc': exc},
+                )
                 continue
 
             project_result = _xform_get_quota(
@@ -334,7 +337,10 @@ class ListQuota(command.Lister):
                 sdk_exceptions.NotFoundException,
             ) as exc:
                 # Project not found, move on to next one
-                LOG.warning(f"Project {project_id} not found: {exc}")
+                LOG.warning(
+                    'Project %(project_id)s not found: %(exc)s',
+                    {'project_id': project_id, 'exc': exc},
+                )
                 continue
 
             project_result = _xform_get_quota(
@@ -389,7 +395,10 @@ class ListQuota(command.Lister):
                 sdk_exceptions.ForbiddenException,
             ) as exc:
                 # Project not found, move on to next one
-                LOG.warning(f"Project {project_id} not found: {exc}")
+                LOG.warning(
+                    'Project %(project_id)s not found: %(exc)s',
+                    {'project_id': project_id, 'exc': exc},
+                )
                 continue
 
             project_result = _xform_get_quota(
@@ -797,20 +806,25 @@ and ``server-group-members`` output for a given quota class."""
         info.update(volume_quota_info)
         info.update(network_quota_info)
 
-        # Map the internal quota names to the external ones
-        # COMPUTE_QUOTAS and NETWORK_QUOTAS share floating-ips,
-        # secgroup-rules and secgroups as dict value, so when
-        # neutron is enabled, quotas of these three resources
-        # in nova will be replaced by neutron's.
-        for k, v in itertools.chain(
-            COMPUTE_QUOTAS.items(),
-            NOVA_NETWORK_QUOTAS.items(),
-            VOLUME_QUOTAS.items(),
-            NETWORK_QUOTAS.items(),
-        ):
-            if not k == v and info.get(k) is not None:
-                info[v] = info[k]
-                info.pop(k)
+        def _normalize_names(section: dict) -> None:
+            # Map the internal quota names to the external ones
+            # COMPUTE_QUOTAS and NETWORK_QUOTAS share floating-ips,
+            # secgroup-rules and secgroups as dict value, so when
+            # neutron is enabled, quotas of these three resources
+            # in nova will be replaced by neutron's.
+            for k, v in itertools.chain(
+                COMPUTE_QUOTAS.items(),
+                NOVA_NETWORK_QUOTAS.items(),
+                VOLUME_QUOTAS.items(),
+                NETWORK_QUOTAS.items(),
+            ):
+                if not k == v and section.get(k) is not None:
+                    section[v] = section.pop(k)
+
+        _normalize_names(info)
+        if parsed_args.usage:
+            _normalize_names(info["reservation"])
+            _normalize_names(info["usage"])
 
         # Remove the 'id' field since it's not very useful
         if 'id' in info:

openstackclient/compute/v2/server.py

@@ -4267,7 +4267,7 @@ release the new server and restart the old one."""
             metavar='<server>',
             help=_('Server (name or ID)'),
         )
-        phase_group = parser.add_mutually_exclusive_group()
+        phase_group = parser.add_mutually_exclusive_group(required=True)
         phase_group.add_argument(
             '--flavor',
             metavar='<flavor>',
@@ -5018,7 +5018,7 @@ class SshServer(command.Command):
         )
 
         cmd = ' '.join(['ssh', ip_address] + args)
-        LOG.debug(f"ssh command: {cmd}")
+        LOG.debug('ssh command: %s', cmd)
         # we intentionally pass through user-provided arguments and run this in
         # the user's shell
         os.system(cmd)  # noqa: S605

openstackclient/identity/common.py

@@ -256,6 +256,37 @@ def find_project(identity_client, name_or_id, domain_name_or_id=None):
     )
 
 
+def find_project_id_sdk(
+    identity_client,
+    name_or_id,
+    domain_name_or_id=None,
+    *,
+    validate_actor_existence=True,
+    validate_domain_actor_existence=None,
+):
+    if domain_name_or_id is None:
+        return _find_sdk_id(
+            identity_client.find_project,
+            name_or_id=name_or_id,
+            validate_actor_existence=validate_actor_existence,
+        )
+
+    if validate_domain_actor_existence is None:
+        validate_domain_actor_existence = validate_actor_existence
+
+    domain_id = find_domain_id_sdk(
+        identity_client,
+        name_or_id=domain_name_or_id,
+        validate_actor_existence=validate_domain_actor_existence,
+    )
+    return _find_sdk_id(
+        identity_client.find_project,
+        name_or_id=name_or_id,
+        validate_actor_existence=validate_actor_existence,
+        domain_id=domain_id,
+    )
+
+
 def find_user(identity_client, name_or_id, domain_name_or_id=None):
     if domain_name_or_id is None:
         return _find_identity_resource(

openstackclient/identity/v2_0/service.py

@@ -160,7 +160,9 @@ class ShowService(command.ShowOne):
             for service, service_endpoints in endpoints.items():
                 if service_endpoints:
                     info = {"type": service}
-                    info.update(service_endpoints[0])
+                    # FIXME(stephenfin): The return type for this in ksa is
+                    # wrong
+                    info.update(service_endpoints[0])  # type: ignore
                     return zip(*sorted(info.items()))
 
             msg = _(

openstackclient/identity/v3/federation_protocol.py

@@ -26,6 +26,15 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
+def _format_protocol(protocol):
+    columns = ('name', 'idp_id', 'mapping_id')
+    column_headers = ('id', 'identity_provider', 'mapping')
+    return (
+        column_headers,
+        utils.get_item_properties(protocol, columns),
+    )
+
+
 class CreateProtocol(command.ShowOne):
     _description = _("Create new federation protocol")
 
@@ -58,21 +67,15 @@ class CreateProtocol(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        protocol = identity_client.federation.protocols.create(
-            protocol_id=parsed_args.federation_protocol,
-            identity_provider=parsed_args.identity_provider,
-            mapping=parsed_args.mapping,
+        identity_client = self.app.client_manager.sdk_connection.identity
+
+        protocol = identity_client.create_federation_protocol(
+            name=parsed_args.federation_protocol,
+            idp_id=parsed_args.identity_provider,
+            mapping_id=parsed_args.mapping,
         )
-        info = dict(protocol._info)
-        # NOTE(marek-denis): Identity provider is not included in a response
-        # from Keystone, however it should be listed to the user. Add it
-        # manually to the output list, simply reusing value provided by the
-        # user.
-        info['identity_provider'] = parsed_args.identity_provider
-        info['mapping'] = info.pop('mapping_id')
-        info.pop('links', None)
-        return zip(*sorted(info.items()))
+
+        return _format_protocol(protocol)
 
 
 class DeleteProtocol(command.Command):
@@ -99,12 +102,15 @@ class DeleteProtocol(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
+
         result = 0
         for i in parsed_args.federation_protocol:
             try:
-                identity_client.federation.protocols.delete(
-                    parsed_args.identity_provider, i
+                identity_client.delete_federation_protocol(
+                    idp_id=parsed_args.identity_provider,
+                    protocol=i,
+                    ignore_missing=False,
                 )
             except Exception as e:
                 result += 1
@@ -140,9 +146,9 @@ class ListProtocols(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
 
-        protocols = identity_client.federation.protocols.list(
+        protocols = identity_client.federation_protocols(
             parsed_args.identity_provider
         )
         columns = ('id', 'mapping')
@@ -181,21 +187,16 @@ class SetProtocol(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
 
-        protocol = identity_client.federation.protocols.update(
-            parsed_args.identity_provider,
-            parsed_args.federation_protocol,
-            parsed_args.mapping,
-        )
-        info = dict(protocol._info)
-        # NOTE(marek-denis): Identity provider is not included in a response
-        # from Keystone, however it should be listed to the user. Add it
-        # manually to the output list, simply reusing value provided by the
-        # user.
-        info['identity_provider'] = parsed_args.identity_provider
-        info['mapping'] = info.pop('mapping_id')
-        return zip(*sorted(info.items()))
+        kwargs = {'idp_id': parsed_args.identity_provider}
+        if parsed_args.federation_protocol:
+            kwargs['name'] = parsed_args.federation_protocol
+        if parsed_args.mapping:
+            kwargs['mapping_id'] = parsed_args.mapping
+
+        protocol = identity_client.update_federation_protocol(**kwargs)
+        return _format_protocol(protocol)
 
 
 class ShowProtocol(command.ShowOne):
@@ -220,12 +221,10 @@ class ShowProtocol(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        protocol = identity_client.federation.protocols.get(
-            parsed_args.identity_provider, parsed_args.federation_protocol
+        protocol = identity_client.get_federation_protocol(
+            idp_id=parsed_args.identity_provider,
+            protocol=parsed_args.federation_protocol,
         )
-        info = dict(protocol._info)
-        info['mapping'] = info.pop('mapping_id')
-        info.pop('links', None)
-        return zip(*sorted(info.items()))
+        return _format_protocol(protocol)

openstackclient/identity/v3/limit.py

@@ -25,6 +25,28 @@ from openstackclient.identity import common as common_utils
 LOG = logging.getLogger(__name__)
 
 
+def _format_limit(limit):
+    columns = (
+        "description",
+        "id",
+        "project_id",
+        "region_id",
+        "resource_limit",
+        "resource_name",
+        "service_id",
+    )
+    column_headers = (
+        "description",
+        "id",
+        "project_id",
+        "region_id",
+        "resource_limit",
+        "resource_name",
+        "service_id",
+    )
+    return (column_headers, utils.get_item_properties(limit, columns))
+
+
 class CreateLimit(command.ShowOne):
     _description = _("Create a limit")
 
@@ -46,6 +68,7 @@ class CreateLimit(command.ShowOne):
             required=True,
             help=_('Project to associate the resource limit to'),
         )
+        common_utils.add_project_domain_option_to_parser(parser)
         parser.add_argument(
             '--service',
             metavar='<service>',
@@ -67,47 +90,33 @@ class CreateLimit(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-
-        project = common_utils.find_project(
-            identity_client, parsed_args.project
+        identity_client = self.app.client_manager.sdk_connection.identity
+
+        kwargs = {
+            "resource_name": parsed_args.resource_name,
+            "resource_limit": parsed_args.resource_limit,
+        }
+        if parsed_args.description:
+            kwargs["description"] = parsed_args.description
+
+        kwargs["project_id"] = common_utils.find_project_id_sdk(
+            identity_client,
+            parsed_args.project,
+            domain_name_or_id=parsed_args.project_domain,
         )
-        service = common_utils.find_service(
+
+        kwargs["service_id"] = common_utils.find_service_sdk(
             identity_client, parsed_args.service
-        )
-        region = None
+        ).id
+
         if parsed_args.region:
-            if 'None' not in parsed_args.region:
-                # NOTE (vishakha): Due to bug #1799153 and for any another
-                # related case where GET resource API does not support the
-                # filter by name, osc_lib.utils.find_resource() method cannot
-                # be used because that method try to fall back to list all the
-                # resource if requested resource cannot be get via name. Which
-                # ends up with NoUniqueMatch error.
-                # So osc_lib.utils.find_resource() function cannot be used for
-                # 'regions', using common_utils.get_resource() instead.
-                region = common_utils.get_resource(
-                    identity_client.regions, parsed_args.region
-                )
-            else:
-                self.log.warning(
-                    _(
-                        "Passing 'None' to indicate no region is deprecated. "
-                        "Instead, don't pass --region."
-                    )
-                )
+            kwargs["region_id"] = identity_client.get_region(
+                parsed_args.region
+            ).id
 
-        limit = identity_client.limits.create(
-            project,
-            service,
-            parsed_args.resource_name,
-            parsed_args.resource_limit,
-            description=parsed_args.description,
-            region=region,
-        )
+        limit = identity_client.create_limit(**kwargs)
 
-        limit._info.pop('links', None)
-        return zip(*sorted(limit._info.items()))
+        return _format_limit(limit)
 
 
 class ListLimit(command.Lister):
@@ -136,50 +145,41 @@ class ListLimit(command.Lister):
             metavar='<project>',
             help=_('List resource limits associated with project'),
         )
+        common_utils.add_project_domain_option_to_parser(parser)
+
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        service = None
+        kwargs = {}
         if parsed_args.service:
-            service = common_utils.find_service(
+            kwargs["service_id"] = common_utils.find_service_sdk(
                 identity_client, parsed_args.service
             )
-        region = None
+
         if parsed_args.region:
-            if 'None' not in parsed_args.region:
-                # NOTE (vishakha): Due to bug #1799153 and for any another
-                # related case where GET resource API does not support the
-                # filter by name, osc_lib.utils.find_resource() method cannot
-                # be used because that method try to fall back to list all the
-                # resource if requested resource cannot be get via name. Which
-                # ends up with NoUniqueMatch error.
-                # So osc_lib.utils.find_resource() function cannot be used for
-                # 'regions', using common_utils.get_resource() instead.
-                region = common_utils.get_resource(
-                    identity_client.regions, parsed_args.region
-                )
-            else:
-                self.log.warning(
-                    _(
-                        "Passing 'None' to indicate no region is deprecated. "
-                        "Instead, don't pass --region."
-                    )
-                )
+            kwargs["region_id"] = identity_client.get_region(
+                parsed_args.region
+            ).id
 
-        project = None
         if parsed_args.project:
-            project = utils.find_resource(
-                identity_client.projects, parsed_args.project
+            project_domain_id = None
+            if parsed_args.project_domain:
+                project_domain_id = common_utils.find_domain_id_sdk(
+                    identity_client, parsed_args.project_domain
+                )
+
+            kwargs["project_id"] = common_utils._find_sdk_id(
+                identity_client.find_project,
+                name_or_id=parsed_args.project,
+                domain_id=project_domain_id,
             )
 
-        limits = identity_client.limits.list(
-            service=service,
-            resource_name=parsed_args.resource_name,
-            region=region,
-            project=project,
-        )
+        if parsed_args.resource_name:
+            kwargs["resource_name"] = parsed_args.resource_name
+
+        limits = identity_client.limits(**kwargs)
 
         columns = (
             'ID',
@@ -209,10 +209,9 @@ class ShowLimit(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        limit = identity_client.limits.get(parsed_args.limit_id)
-        limit._info.pop('links', None)
-        return zip(*sorted(limit._info.items()))
+        identity_client = self.app.client_manager.sdk_connection.identity
+        limit = identity_client.get_limit(parsed_args.limit_id)
+        return _format_limit(limit)
 
 
 class SetLimit(command.ShowOne):
@@ -240,17 +239,16 @@ class SetLimit(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-
-        limit = identity_client.limits.update(
-            parsed_args.limit_id,
-            description=parsed_args.description,
-            resource_limit=parsed_args.resource_limit,
-        )
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        limit._info.pop('links', None)
+        kwargs = {}
+        if parsed_args.description:
+            kwargs["description"] = parsed_args.description
+        if parsed_args.resource_limit:
+            kwargs["resource_limit"] = parsed_args.resource_limit
+        limit = identity_client.update_limit(parsed_args.limit_id, **kwargs)
 
-        return zip(*sorted(limit._info.items()))
+        return _format_limit(limit)
 
 
 class DeleteLimit(command.Command):
@@ -262,17 +260,20 @@ class DeleteLimit(command.Command):
             'limit_id',
             metavar='<limit-id>',
             nargs="+",
-            help=_('Limit to delete (ID)'),
+            help=_(
+                'Limit to delete (ID) '
+                '(repeat option to remove multiple limits)'
+            ),
         )
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         errors = 0
         for limit_id in parsed_args.limit_id:
             try:
-                identity_client.limits.delete(limit_id)
+                identity_client.delete_limit(limit_id)
             except Exception as e:
                 errors += 1
                 LOG.error(