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

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,
@@ -528,6 +529,16 @@ class SaveImage(command.Command):
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--chunk-size",
+            type=int,
+            default=1024,
+            metavar="<chunk-size>",
+            help=_(
+                "Size in bytes to read from the wire and buffer at one "
+                "time (default: 1024)"
+            ),
+        )
         parser.add_argument(
             "--file",
             metavar="<filename>",
@@ -550,7 +561,12 @@ class SaveImage(command.Command):
         if output_file is None:
             output_file = getattr(sys.stdout, "buffer", sys.stdout)
 
-        image_client.download_image(image.id, stream=True, output=output_file)
+        image_client.download_image(
+            image.id,
+            stream=True,
+            output=output_file,
+            chunk_size=parsed_args.chunk_size,
+        )
 
 
 class SetImage(command.Command):
@@ -824,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 _
 
 
@@ -37,14 +37,18 @@ def _format_image_cache(cached_images):
                 image_obj = copy.deepcopy(image)
                 image_obj['state'] = 'cached'
                 image_obj['last_accessed'] = (
-                    datetime.datetime.utcfromtimestamp(
-                        image['last_accessed']
-                    ).isoformat()
+                    datetime.datetime.fromtimestamp(
+                        image['last_accessed'], tz=datetime.timezone.utc
+                    )
+                    .replace(tzinfo=None)
+                    .isoformat()
                 )
                 image_obj['last_modified'] = (
-                    datetime.datetime.utcfromtimestamp(
-                        image['last_modified']
-                    ).isoformat()
+                    datetime.datetime.fromtimestamp(
+                        image['last_modified'], tz=datetime.timezone.utc
+                    )
+                    .replace(tzinfo=None)
+                    .isoformat()
                 )
                 image_list.append(image_obj)
         elif item == "queued_images":

openstackclient/image/v2/image.py

@@ -22,6 +22,7 @@ import logging
 import os
 import sys
 import typing as ty
+import urllib.parse
 
 from openstack import exceptions as sdk_exceptions
 from openstack.image import image_signer
@@ -29,10 +30,10 @@ from openstack import utils as sdk_utils
 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.common import pagination
 from openstackclient.common import progressbar
 from openstackclient.i18n import _
@@ -54,6 +55,19 @@ DISK_CHOICES = [
     "iso",
     "ploop",
 ]
+# A list of openstacksdk Image object attributes (values) that named
+# differently from actual properties stored by Glance (keys).
+IMAGE_ATTRIBUTES_CUSTOM_NAMES = {
+    'os_hidden': 'is_hidden',
+    'protected': 'is_protected',
+    'os_hash_algo': 'hash_algo',
+    'os_hash_value': 'hash_value',
+    'img_config_drive': 'needs_config_drive',
+    'os_secure_boot': 'needs_secure_boot',
+    'hw_vif_multiqueue_enabled': 'is_hw_vif_multiqueue_enabled',
+    'hw_boot_menu': 'is_hw_boot_menu_enabled',
+    'auto_disk_config': 'has_auto_disk_config',
+}
 MEMBER_STATUS_CHOICES = ["accepted", "pending", "rejected", "all"]
 
 LOG = logging.getLogger(__name__)
@@ -84,6 +98,9 @@ def _format_image(image, human_readable=False):
         'virtual_size',
         'min_ram',
         'schema',
+        'is_hidden',
+        'hash_algo',
+        'hash_value',
     ]
 
     # TODO(gtema/anybody): actually it should be possible to drop this method,
@@ -534,7 +551,7 @@ class CreateImage(command.ShowOne):
             sign_cert_id = parsed_args.sign_cert_id
             signer = image_signer.ImageSigner()
             try:
-                pw = utils.get_password(
+                pw: str | None = utils.get_password(
                     self.app.stdin,
                     prompt=(
                         "Please enter private key password, leave "
@@ -545,12 +562,11 @@ class CreateImage(command.ShowOne):
 
                 if not pw or len(pw) < 1:
                     pw = None
-                else:
-                    # load_private_key() requires the password to be
-                    # passed as bytes
-                    pw = pw.encode()
 
-                signer.load_private_key(sign_key_path, password=pw)
+                signer.load_private_key(
+                    sign_key_path,
+                    password=pw.encode() if pw else None,
+                )
             except Exception:
                 msg = _(
                     "Error during sign operation: private key "
@@ -889,6 +905,8 @@ class ListImage(command.Lister):
                 'visibility',
                 'is_protected',
                 'owner_id',
+                'hash_algo',
+                'hash_value',
                 'tags',
             )
             column_headers: tuple[str, ...] = (
@@ -902,6 +920,8 @@ class ListImage(command.Lister):
                 'Visibility',
                 'Protected',
                 'Project',
+                'Hash Algorithm',
+                'Hash Value',
                 'Tags',
             )
         else:
@@ -912,18 +932,19 @@ class ListImage(command.Lister):
         if 'limit' in kwargs:
             # Disable automatic pagination in SDK
             kwargs['paginated'] = False
-        data = list(image_client.images(**kwargs))
+
+        images = list(image_client.images(**kwargs))
 
         if parsed_args.property:
             for attr, value in parsed_args.property.items():
                 api_utils.simple_filter(
-                    data,
+                    images,
                     attr=attr,
                     value=value,
                     property_field='properties',
                 )
 
-        data = utils.sort_items(data, parsed_args.sort, str)
+        data = utils.sort_items(images, parsed_args.sort, str)
 
         return (
             column_headers,
@@ -1052,6 +1073,16 @@ class SaveImage(command.Command):
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "--chunk-size",
+            type=int,
+            default=1024,
+            metavar="<chunk-size>",
+            help=_(
+                "Size in bytes to read from the wire and buffer at one "
+                "time (default: 1024)"
+            ),
+        )
         parser.add_argument(
             "--file",
             metavar="<filename>",
@@ -1076,7 +1107,12 @@ class SaveImage(command.Command):
         if output_file is None:
             output_file = getattr(sys.stdout, "buffer", sys.stdout)
 
-        image_client.download_image(image.id, stream=True, output=output_file)
+        image_client.download_image(
+            image.id,
+            stream=True,
+            output=output_file,
+            chunk_size=parsed_args.chunk_size,
+        )
 
 
 class SetImage(command.Command):
@@ -1357,7 +1393,10 @@ class SetImage(command.Command):
         if parsed_args.visibility is not None:
             kwargs['visibility'] = parsed_args.visibility
 
-        if parsed_args.project:
+        # Only set owner_id if --project is used WITHOUT membership flags
+        # When --project is used with --accept/--reject/--pending, it should
+        # only identify which member's status to update, not change ownership
+        if parsed_args.project and not parsed_args.membership:
             # We already did the project lookup above
             kwargs['owner_id'] = project_id
 
@@ -1477,6 +1516,11 @@ class UnsetImage(command.Command):
                     )
                     new_props.pop(k, None)
                     kwargs['properties'] = new_props
+                elif (
+                    k in IMAGE_ATTRIBUTES_CUSTOM_NAMES
+                    and IMAGE_ATTRIBUTES_CUSTOM_NAMES[k] in image
+                ):
+                    delattr(image, IMAGE_ATTRIBUTES_CUSTOM_NAMES[k])
                 else:
                     LOG.error(
                         _(
@@ -1744,6 +1788,12 @@ class ImportImage(command.ShowOne):
                     "'--method=web-download'"
                 )
                 raise exceptions.CommandError(msg)
+            _parsed = urllib.parse.urlparse(parsed_args.uri)
+            if not all({_parsed.scheme, _parsed.netloc}):
+                msg = _("'%(uri)s' is not a valid url")
+                raise exceptions.CommandError(
+                    msg % {'uri': parsed_args.uri},
+                )
         else:
             if parsed_args.uri:
                 msg = _(

openstackclient/image/v2/info.py

@@ -12,8 +12,8 @@
 
 
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/image/v2/metadef_namespaces.py

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

openstackclient/image/v2/metadef_objects.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 _
 
 
@@ -123,8 +123,11 @@ class DeleteMetadefObject(command.Command):
         parser.add_argument(
             "objects",
             metavar="<object>",
-            nargs="+",
-            help=_("Metadef object(s) to delete (name)"),
+            nargs="*",
+            help=_(
+                "Metadef object(s) to delete (name) "
+                "(omit this argument to delete all objects in the namespace)"
+            ),
         )
         return parser
 
@@ -133,6 +136,9 @@ class DeleteMetadefObject(command.Command):
 
         namespace = parsed_args.namespace
 
+        if not parsed_args.objects:
+            return image_client.delete_all_metadef_objects(namespace)
+
         result = 0
         for obj in parsed_args.objects:
             try:

openstackclient/image/v2/metadef_properties.py

@@ -15,10 +15,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 _
 
 
@@ -124,14 +124,22 @@ class DeleteMetadefProperty(command.Command):
         parser.add_argument(
             "properties",
             metavar="<property>",
-            nargs="+",
-            help=_("Metadef propert(ies) to delete (name)"),
+            nargs="*",
+            help=_(
+                "Metadef properties to delete (name) "
+                "(omit this argument to delete all properties "
+                "in the namespace)"
+            ),
         )
         return parser
 
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
 
+        if not parsed_args.properties:
+            image_client.delete_all_metadef_properties(parsed_args.namespace)
+            return
+
         result = 0
         for prop in parsed_args.properties:
             try:

openstackclient/image/v2/metadef_resource_type_association.py

@@ -12,10 +12,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 _
 
 LOG = logging.getLogger(__name__)

openstackclient/image/v2/metadef_resource_types.py

@@ -12,9 +12,9 @@
 
 """Image V2 Action Implementations"""
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/image/v2/task.py

@@ -11,9 +11,9 @@
 # under the License.
 
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 _formatters = {