openstack/python-openstackclient
Code Issues Proposed changes

image: Trivial style changes

Browse Source 
Change-Id: I35b7b8a80609916eb47357af4398789788d66382
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Stephen Finucane 2022-06-30 11:01:05 +01:00
parent 9eea28ba59
commit 2290b38ab3
1 changed files with 319 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

508
openstackclient/image/v2/image.py
View File

@ -44,8 +44,19 @@ else:
CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"] CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"]
DEFAULT_CONTAINER_FORMAT = 'bare' DEFAULT_CONTAINER_FORMAT = 'bare'
DEFAULT_DISK_FORMAT = 'raw' DEFAULT_DISK_FORMAT = 'raw'
DISK_CHOICES = ["ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vhdx", DISK_CHOICES = [
"vdi", "iso", "ploop"] "ami",
"ari",
"aki",
"vhd",
"vmdk",
"raw",
"qcow2",
"vhdx",
"vdi",
"iso",
"ploop",
]
MEMBER_STATUS_CHOICES = ["accepted", "pending", "rejected", "all"] MEMBER_STATUS_CHOICES = ["accepted", "pending", "rejected", "all"]
@ -59,10 +70,25 @@ def _format_image(image, human_readable=False):
properties = {} properties = {}
# the only fields we're not including is "links", "tags" and the properties # the only fields we're not including is "links", "tags" and the properties
fields_to_show = ['status', 'name', 'container_format', 'created_at', fields_to_show = [
'size', 'disk_format', 'updated_at', 'visibility', 'status',
'min_disk', 'protected', 'id', 'file', 'checksum', 'name',
'owner', 'virtual_size', 'min_ram', 'schema'] 'container_format',
'created_at',
'size',
'disk_format',
'updated_at',
'visibility',
'min_disk',
'protected',
'id',
'file',
'checksum',
'owner',
'virtual_size',
'min_ram',
'schema',
]
# TODO(gtema/anybody): actually it should be possible to drop this method, # TODO(gtema/anybody): actually it should be possible to drop this method,
# since SDK already delivers a proper object # since SDK already delivers a proper object
@ -99,12 +125,12 @@ _formatters = {
def _get_member_columns(item): def _get_member_columns(item):
column_map = { column_map = {'image_id': 'image_id'}
'image_id': 'image_id'
}
hidden_columns = ['id', 'location', 'name'] hidden_columns = ['id', 'location', 'name']
return utils.get_osc_show_columns_for_sdk_resource( return utils.get_osc_show_columns_for_sdk_resource(
item.to_dict(), column_map, hidden_columns, item.to_dict(),
column_map,
hidden_columns,
) )
@ -142,7 +168,7 @@ class AddProjectToImage(command.ShowOne):
_description = _("Associate project with image") _description = _("Associate project with image")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(AddProjectToImage, self).get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"image", "image",
metavar="<image>", metavar="<image>",
@ -166,10 +192,12 @@ class AddProjectToImage(command.ShowOne):
project_id = common.find_project( project_id = common.find_project(
identity_client, identity_client,
parsed_args.project, parsed_args.project,
parsed_args.project_domain).id parsed_args.project_domain,
).id
image = image_client.find_image(parsed_args.image, image = image_client.find_image(
ignore_missing=False) parsed_args.image, ignore_missing=False
)
obj = image_client.add_member( obj = image_client.add_member(
image=image.id, image=image.id,
@ -188,7 +216,7 @@ class CreateImage(command.ShowOne):
deadopts = ('size', 'location', 'copy-from', 'checksum', 'store') deadopts = ('size', 'location', 'copy-from', 'checksum', 'store')
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(CreateImage, self).get_parser(prog_name) parser = super().get_parser(prog_name)
# TODO(bunting): There are additional arguments that v1 supported # TODO(bunting): There are additional arguments that v1 supported
# that v2 either doesn't support or supports weirdly. # that v2 either doesn't support or supports weirdly.
# --checksum - could be faked clientside perhaps? # --checksum - could be faked clientside perhaps?
@ -211,19 +239,28 @@ class CreateImage(command.ShowOne):
default=DEFAULT_CONTAINER_FORMAT, default=DEFAULT_CONTAINER_FORMAT,
choices=CONTAINER_CHOICES, choices=CONTAINER_CHOICES,
metavar="<container-format>", metavar="<container-format>",
help=(_("Image container format. " help=(
_(
"Image container format. "
"The supported options are: %(option_list)s. " "The supported options are: %(option_list)s. "
"The default format is: %(default_opt)s") % "The default format is: %(default_opt)s"
{'option_list': ', '.join(CONTAINER_CHOICES), )
'default_opt': DEFAULT_CONTAINER_FORMAT}) % {
'option_list': ', '.join(CONTAINER_CHOICES),
'default_opt': DEFAULT_CONTAINER_FORMAT,
}
),
) )
parser.add_argument( parser.add_argument(
"--disk-format", "--disk-format",
default=DEFAULT_DISK_FORMAT, default=DEFAULT_DISK_FORMAT,
choices=DISK_CHOICES, choices=DISK_CHOICES,
metavar="<disk-format>", metavar="<disk-format>",
help=_("Image disk format. The supported options are: %s. " help=_(
"The default format is: raw") % ', '.join(DISK_CHOICES) "Image disk format. The supported options are: %s. "
"The default format is: raw"
)
% ', '.join(DISK_CHOICES),
) )
parser.add_argument( parser.add_argument(
"--min-disk", "--min-disk",
@ -253,8 +290,10 @@ class CreateImage(command.ShowOne):
dest='force', dest='force',
action='store_true', action='store_true',
default=False, default=False,
help=_("Force image creation if volume is in use " help=_(
"(only meaningful with --volume)"), "Force image creation if volume is in use "
"(only meaningful with --volume)"
),
) )
parser.add_argument( parser.add_argument(
"--progress", "--progress",
@ -266,17 +305,21 @@ class CreateImage(command.ShowOne):
'--sign-key-path', '--sign-key-path',
metavar="<sign-key-path>", metavar="<sign-key-path>",
default=[], default=[],
help=_("Sign the image using the specified private key. " help=_(
"Only use in combination with --sign-cert-id") "Sign the image using the specified private key. "
"Only use in combination with --sign-cert-id"
),
) )
parser.add_argument( parser.add_argument(
'--sign-cert-id', '--sign-cert-id',
metavar="<sign-cert-id>", metavar="<sign-cert-id>",
default=[], default=[],
help=_("The specified certificate UUID is a reference to " help=_(
"the certificate in the key manager that corresponds " "The specified certificate UUID is a reference to "
"to the public key and is used for signature validation. " "the certificate in the key manager that corresponds "
"Only use in combination with --sign-key-path") "to the public key and is used for signature validation. "
"Only use in combination with --sign-key-path"
),
) )
protected_group = parser.add_mutually_exclusive_group() protected_group = parser.add_mutually_exclusive_group()
protected_group.add_argument( protected_group.add_argument(
@ -315,16 +358,20 @@ class CreateImage(command.ShowOne):
dest="properties", dest="properties",
metavar="<key=value>", metavar="<key=value>",
action=parseractions.KeyValueAction, action=parseractions.KeyValueAction,
help=_("Set a property on this image " help=_(
"(repeat option to set multiple properties)"), "Set a property on this image "
"(repeat option to set multiple properties)"
),
) )
parser.add_argument( parser.add_argument(
"--tag", "--tag",
dest="tags", dest="tags",
metavar="<tag>", metavar="<tag>",
action='append', action='append',
help=_("Set a tag on this image " help=_(
"(repeat option to set multiple tags)"), "Set a tag on this image "
"(repeat option to set multiple tags)"
),
) )
parser.add_argument( parser.add_argument(
"--project", "--project",
@ -336,8 +383,8 @@ class CreateImage(command.ShowOne):
dest="use_import", dest="use_import",
action="store_true", action="store_true",
help=_( help=_(
"Force the use of glance image import instead of" "Force the use of glance image import instead of direct upload"
" direct upload") ),
) )
common.add_project_domain_option_to_parser(parser) common.add_project_domain_option_to_parser(parser)
for deadopt in self.deadopts: for deadopt in self.deadopts:
@ -355,16 +402,25 @@ class CreateImage(command.ShowOne):
for deadopt in self.deadopts: for deadopt in self.deadopts:
if getattr(parsed_args, deadopt.replace('-', '_'), None): if getattr(parsed_args, deadopt.replace('-', '_'), None):
raise exceptions.CommandError( msg = _(
_("ERROR: --%s was given, which is an Image v1 option" "ERROR: --%s was given, which is an Image v1 option "
" that is no longer supported in Image v2") % deadopt) "that is no longer supported in Image v2"
)
raise exceptions.CommandError(msg % deadopt)
# Build an attribute dict from the parsed args, only include # Build an attribute dict from the parsed args, only include
# attributes that were actually set on the command line # attributes that were actually set on the command line
kwargs = {'allow_duplicates': True} kwargs = {'allow_duplicates': True}
copy_attrs = ('name', 'id', copy_attrs = (
'container_format', 'disk_format', 'name',
'min_disk', 'min_ram', 'tags', 'visibility') 'id',
'container_format',
'disk_format',
'min_disk',
'min_ram',
'tags',
'visibility',
)
for attr in copy_attrs: for attr in copy_attrs:
if attr in parsed_args: if attr in parsed_args:
val = getattr(parsed_args, attr, None) val = getattr(parsed_args, attr, None)
@ -409,16 +465,20 @@ class CreateImage(command.ShowOne):
# open the file first to ensure any failures are handled before the # open the file first to ensure any failures are handled before the
# image is created. Get the file name (if it is file, and not stdin) # image is created. Get the file name (if it is file, and not stdin)
# for easier further handling. # for easier further handling.
(fp, fname) = get_data_file(parsed_args) fp, fname = get_data_file(parsed_args)
info = {} info = {}
if fp is not None and parsed_args.volume: if fp is not None and parsed_args.volume:
raise exceptions.CommandError(_("Uploading data and using " msg = _(
"container are not allowed at " "Uploading data and using container are not allowed at "
"the same time")) "the same time"
)
raise exceptions.CommandError(msg)
if fp is None and parsed_args.file: if fp is None and parsed_args.file:
LOG.warning(_("Failed to get an image file.")) LOG.warning(_("Failed to get an image file."))
return {}, {} return {}, {}
if fp is not None and parsed_args.progress: if fp is not None and parsed_args.progress:
filesize = os.path.getsize(fname) filesize = os.path.getsize(fname)
if filesize is not None: if filesize is not None:
@ -433,49 +493,58 @@ class CreateImage(command.ShowOne):
# sign an image using a given local private key file # sign an image using a given local private key file
if parsed_args.sign_key_path or parsed_args.sign_cert_id: if parsed_args.sign_key_path or parsed_args.sign_cert_id:
if not parsed_args.file: if not parsed_args.file:
msg = (_("signing an image requires the --file option, " msg = _(
"passing files via stdin when signing is not " "signing an image requires the --file option, "
"supported.")) "passing files via stdin when signing is not "
"supported."
)
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)
if (len(parsed_args.sign_key_path) < 1 or
len(parsed_args.sign_cert_id) < 1): if (
msg = (_("'sign-key-path' and 'sign-cert-id' must both be " len(parsed_args.sign_key_path) < 1 or
"specified when attempting to sign an image.")) len(parsed_args.sign_cert_id) < 1
):
msg = _(
"'sign-key-path' and 'sign-cert-id' must both be "
"specified when attempting to sign an image."
)
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)
else:
sign_key_path = parsed_args.sign_key_path
sign_cert_id = parsed_args.sign_cert_id
signer = image_signer.ImageSigner()
try:
pw = utils.get_password(
self.app.stdin,
prompt=("Please enter private key password, leave "
"empty if none: "),
confirm=False)
if not pw or len(pw) < 1: sign_key_path = parsed_args.sign_key_path
pw = None sign_cert_id = parsed_args.sign_cert_id
else: signer = image_signer.ImageSigner()
# load_private_key() requires the password to be try:
# passed as bytes pw = utils.get_password(
pw = pw.encode() self.app.stdin,
prompt=(
"Please enter private key password, leave "
"empty if none: "
),
confirm=False,
)
signer.load_private_key( if not pw or len(pw) < 1:
sign_key_path, pw = None
password=pw) else:
except Exception: # load_private_key() requires the password to be
msg = (_("Error during sign operation: private key " # passed as bytes
"could not be loaded.")) pw = pw.encode()
raise exceptions.CommandError(msg)
signature = signer.generate_signature(fp) signer.load_private_key(sign_key_path, password=pw)
signature_b64 = b64encode(signature) except Exception:
kwargs['img_signature'] = signature_b64 msg = _(
kwargs['img_signature_certificate_uuid'] = sign_cert_id "Error during sign operation: private key "
kwargs['img_signature_hash_method'] = signer.hash_method "could not be loaded."
if signer.padding_method: )
kwargs['img_signature_key_type'] = \ raise exceptions.CommandError(msg)
signer.padding_method
signature = signer.generate_signature(fp)
signature_b64 = b64encode(signature)
kwargs['img_signature'] = signature_b64
kwargs['img_signature_certificate_uuid'] = sign_cert_id
kwargs['img_signature_hash_method'] = signer.hash_method
if signer.padding_method:
kwargs['img_signature_key_type'] = signer.padding_method
# If a volume is specified. # If a volume is specified.
if parsed_args.volume: if parsed_args.volume:
@ -488,7 +557,7 @@ class CreateImage(command.ShowOne):
if volume_client.api_version >= api_versions.APIVersion('3.1'): if volume_client.api_version >= api_versions.APIVersion('3.1'):
mv_kwargs.update( mv_kwargs.update(
visibility=kwargs.get('visibility', 'private'), visibility=kwargs.get('visibility', 'private'),
protected=bool(parsed_args.protected) protected=bool(parsed_args.protected),
) )
else: else:
if kwargs.get('visibility') or parsed_args.protected: if kwargs.get('visibility') or parsed_args.protected:
@ -524,7 +593,7 @@ class DeleteImage(command.Command):
_description = _("Delete image(s)") _description = _("Delete image(s)")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(DeleteImage, self).get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"images", "images",
metavar="<image>", metavar="<image>",
@ -539,19 +608,24 @@ class DeleteImage(command.Command):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
for image in parsed_args.images: for image in parsed_args.images:
try: try:
image_obj = image_client.find_image(image, image_obj = image_client.find_image(
ignore_missing=False) image, ignore_missing=False
)
image_client.delete_image(image_obj.id) image_client.delete_image(image_obj.id)
except Exception as e: except Exception as e:
del_result += 1 del_result += 1
LOG.error(_("Failed to delete image with name or " msg = _(
"ID '%(image)s': %(e)s"), "Failed to delete image with name or "
{'image': image, 'e': e}) "ID '%(image)s': %(e)s"
)
LOG.error(msg, {'image': image, 'e': e})
total = len(parsed_args.images) total = len(parsed_args.images)
if (del_result > 0): if del_result > 0:
msg = (_("Failed to delete %(dresult)s of %(total)s images.") msg = _("Failed to delete %(dresult)s of %(total)s images.") % {
% {'dresult': del_result, 'total': total}) 'dresult': del_result,
'total': total,
}
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)
@ -559,7 +633,7 @@ class ListImage(command.Lister):
_description = _("List available images") _description = _("List available images")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ListImage, self).get_parser(prog_name) parser = super().get_parser(prog_name)
public_group = parser.add_mutually_exclusive_group() public_group = parser.add_mutually_exclusive_group()
public_group.add_argument( public_group.add_argument(
"--public", "--public",
@ -600,20 +674,22 @@ class ListImage(command.Lister):
'--property', '--property',
metavar='<key=value>', metavar='<key=value>',
action=parseractions.KeyValueAction, action=parseractions.KeyValueAction,
help=_('Filter output based on property ' help=_(
'(repeat option to filter on multiple properties)'), 'Filter output based on property '
'(repeat option to filter on multiple properties)'
),
) )
parser.add_argument( parser.add_argument(
'--name', '--name',
metavar='<name>', metavar='<name>',
default=None, default=None,
help=_("Filter images based on name.") help=_("Filter images based on name."),
) )
parser.add_argument( parser.add_argument(
'--status', '--status',
metavar='<status>', metavar='<status>',
default=None, default=None,
help=_("Filter images based on status.") help=_("Filter images based on status."),
) )
parser.add_argument( parser.add_argument(
'--member-status', '--member-status',
@ -621,14 +697,18 @@ class ListImage(command.Lister):
default=None, default=None,
type=lambda s: s.lower(), type=lambda s: s.lower(),
choices=MEMBER_STATUS_CHOICES, choices=MEMBER_STATUS_CHOICES,
help=(_("Filter images based on member status. " help=(
"The supported options are: %s. ") % _(
', '.join(MEMBER_STATUS_CHOICES)) "Filter images based on member status. "
"The supported options are: %s. "
)
% ', '.join(MEMBER_STATUS_CHOICES)
),
) )
parser.add_argument( parser.add_argument(
'--project', '--project',
metavar='<project>', metavar='<project>',
help=_("Search by project (admin only) (name or ID)") help=_("Search by project (admin only) (name or ID)"),
) )
common.add_project_domain_option_to_parser(parser) common.add_project_domain_option_to_parser(parser)
parser.add_argument( parser.add_argument(
@ -636,8 +716,10 @@ class ListImage(command.Lister):
metavar='<tag>', metavar='<tag>',
action='append', action='append',
default=[], default=[],
help=_('Filter images based on tag. ' help=_(
'(repeat option to filter on multiple tags)'), 'Filter images based on tag. '
'(repeat option to filter on multiple tags)'
),
) )
parser.add_argument( parser.add_argument(
'--hidden', '--hidden',
@ -663,9 +745,11 @@ class ListImage(command.Lister):
'--sort', '--sort',
metavar="<key>[:<direction>]", metavar="<key>[:<direction>]",
default='name:asc', default='name:asc',
help=_("Sort output by selected keys and directions(asc or desc) " help=_(
"(default: name:asc), multiple keys and directions can be " "Sort output by selected keys and directions (asc or desc) "
"specified separated by comma"), "(default: name:asc), multiple keys and directions can be "
"specified separated by comma"
),
) )
parser.add_argument( parser.add_argument(
"--limit", "--limit",
@ -677,9 +761,11 @@ class ListImage(command.Lister):
'--marker', '--marker',
metavar='<image>', metavar='<image>',
default=None, default=None,
help=_("The last image of the previous page. Display " help=_(
"list of images after marker. Display all images if not " "The last image of the previous page. Display "
"specified. (name or ID)"), "list of images after marker. Display all images if not "
"specified. (name or ID)"
),
) )
return parser return parser
@ -770,11 +856,14 @@ class ListImage(command.Lister):
return ( return (
column_headers, column_headers,
(utils.get_item_properties( (
s, utils.get_item_properties(
columns, s,
formatters=_formatters, columns,
) for s in data) formatters=_formatters,
)
for s in data
),
) )
@ -782,7 +871,7 @@ class ListImageProjects(command.Lister):
_description = _("List projects associated with image") _description = _("List projects associated with image")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ListImageProjects, self).get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"image", "image",
metavar="<image>", metavar="<image>",
@ -793,27 +882,29 @@ class ListImageProjects(command.Lister):
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
columns = ( columns = ("Image ID", "Member ID", "Status")
"Image ID",
"Member ID",
"Status"
)
image_id = image_client.find_image(parsed_args.image).id image_id = image_client.find_image(parsed_args.image).id
data = image_client.members(image=image_id) data = image_client.members(image=image_id)
return (columns, return (
(utils.get_item_properties( columns,
s, columns, (
) for s in data)) utils.get_item_properties(
s,
columns,
)
for s in data
),
)
class RemoveProjectImage(command.Command): class RemoveProjectImage(command.Command):
_description = _("Disassociate project with image") _description = _("Disassociate project with image")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(RemoveProjectImage, self).get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"image", "image",
metavar="<image>", metavar="<image>",
@ -831,23 +922,22 @@ class RemoveProjectImage(command.Command):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
identity_client = self.app.client_manager.identity identity_client = self.app.client_manager.identity
project_id = common.find_project(identity_client, project_id = common.find_project(
parsed_args.project, identity_client, parsed_args.project, parsed_args.project_domain
parsed_args.project_domain).id ).id
image = image_client.find_image(parsed_args.image, image = image_client.find_image(
ignore_missing=False) parsed_args.image, ignore_missing=False
)
image_client.remove_member( image_client.remove_member(member=project_id, image=image.id)
member=project_id,
image=image.id)
class SaveImage(command.Command): class SaveImage(command.Command):
_description = _("Save an image locally") _description = _("Save an image locally")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(SaveImage, self).get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"--file", "--file",
metavar="<filename>", metavar="<filename>",
@ -877,7 +967,7 @@ class SetImage(command.Command):
deadopts = ('visibility',) deadopts = ('visibility',)
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(SetImage, self).get_parser(prog_name) parser = super().get_parser(prog_name)
# TODO(bunting): There are additional arguments that v1 supported # TODO(bunting): There are additional arguments that v1 supported
# --size - does not exist in v2 # --size - does not exist in v2
# --store - does not exist in v2 # --store - does not exist in v2
@ -889,20 +979,16 @@ class SetImage(command.Command):
# --checksum - maybe could be done client side # --checksum - maybe could be done client side
# --stdin - could be implemented # --stdin - could be implemented
parser.add_argument( parser.add_argument(
"image", "image", metavar="<image>", help=_("Image to modify (name or ID)")
metavar="<image>",
help=_("Image to modify (name or ID)")
) )
parser.add_argument( parser.add_argument(
"--name", "--name", metavar="<name>", help=_("New image name")
metavar="<name>",
help=_("New image name")
) )
parser.add_argument( parser.add_argument(
"--min-disk", "--min-disk",
type=int, type=int,
metavar="<disk-gb>", metavar="<disk-gb>",
help=_("Minimum disk size needed to boot image, in gigabytes") help=_("Minimum disk size needed to boot image, in gigabytes"),
) )
parser.add_argument( parser.add_argument(
"--min-ram", "--min-ram",
@ -914,15 +1000,15 @@ class SetImage(command.Command):
"--container-format", "--container-format",
metavar="<container-format>", metavar="<container-format>",
choices=CONTAINER_CHOICES, choices=CONTAINER_CHOICES,
help=_("Image container format. The supported options are: %s") % help=_("Image container format. The supported options are: %s")
', '.join(CONTAINER_CHOICES) % ', '.join(CONTAINER_CHOICES),
) )
parser.add_argument( parser.add_argument(
"--disk-format", "--disk-format",
metavar="<disk-format>", metavar="<disk-format>",
choices=DISK_CHOICES, choices=DISK_CHOICES,
help=_("Image disk format. The supported options are: %s") % help=_("Image disk format. The supported options are: %s")
', '.join(DISK_CHOICES) % ', '.join(DISK_CHOICES),
) )
protected_group = parser.add_mutually_exclusive_group() protected_group = parser.add_mutually_exclusive_group()
protected_group.add_argument( protected_group.add_argument(
@ -961,8 +1047,10 @@ class SetImage(command.Command):
dest="properties", dest="properties",
metavar="<key=value>", metavar="<key=value>",
action=parseractions.KeyValueAction, action=parseractions.KeyValueAction,
help=_("Set a property on this image " help=_(
"(repeat option to set multiple properties)"), "Set a property on this image "
"(repeat option to set multiple properties)"
),
) )
parser.add_argument( parser.add_argument(
"--tag", "--tag",
@ -970,8 +1058,10 @@ class SetImage(command.Command):
metavar="<tag>", metavar="<tag>",
default=None, default=None,
action='append', action='append',
help=_("Set a tag on this image " help=_(
"(repeat option to set multiple tags)"), "Set a tag on this image "
"(repeat option to set multiple tags)"
),
) )
parser.add_argument( parser.add_argument(
"--architecture", "--architecture",
@ -1084,11 +1174,16 @@ class SetImage(command.Command):
for deadopt in self.deadopts: for deadopt in self.deadopts:
if getattr(parsed_args, deadopt.replace('-', '_'), None): if getattr(parsed_args, deadopt.replace('-', '_'), None):
raise exceptions.CommandError( raise exceptions.CommandError(
_("ERROR: --%s was given, which is an Image v1 option" _(
" that is no longer supported in Image v2") % deadopt) "ERROR: --%s was given, which is an Image v1 option"
" that is no longer supported in Image v2"
)
% deadopt
)
image = image_client.find_image( image = image_client.find_image(
parsed_args.image, ignore_missing=False, parsed_args.image,
ignore_missing=False,
) )
project_id = None project_id = None
if parsed_args.project: if parsed_args.project:
@ -1125,10 +1220,25 @@ class SetImage(command.Command):
# handle everything else # handle everything else
kwargs = {} kwargs = {}
copy_attrs = ('architecture', 'container_format', 'disk_format', copy_attrs = (
'file', 'instance_id', 'kernel_id', 'locations', 'architecture',
'min_disk', 'min_ram', 'name', 'os_distro', 'os_version', 'container_format',
'prefix', 'progress', 'ramdisk_id', 'tags', 'visibility') 'disk_format',
'file',
'instance_id',
'kernel_id',
'locations',
'min_disk',
'min_ram',
'name',
'os_distro',
'os_version',
'prefix',
'progress',
'ramdisk_id',
'tags',
'visibility',
)
for attr in copy_attrs: for attr in copy_attrs:
if attr in parsed_args: if attr in parsed_args:
val = getattr(parsed_args, attr, None) val = getattr(parsed_args, attr, None)
@ -1173,8 +1283,10 @@ class SetImage(command.Command):
image = image_client.update_image(image.id, **kwargs) image = image_client.update_image(image.id, **kwargs)
except Exception: except Exception:
if activation_status is not None: if activation_status is not None:
LOG.info(_("Image %(id)s was %(status)s."), LOG.info(
{'id': image.id, 'status': activation_status}) _("Image %(id)s was %(status)s."),
{'id': image.id, 'status': activation_status},
)
raise raise
@ -1182,7 +1294,7 @@ class ShowImage(command.ShowOne):
_description = _("Display image details") _description = _("Display image details")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ShowImage, self).get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"--human-readable", "--human-readable",
default=False, default=False,
@ -1199,8 +1311,9 @@ class ShowImage(command.ShowOne):
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
image = image_client.find_image(parsed_args.image, image = image_client.find_image(
ignore_missing=False) parsed_args.image, ignore_missing=False
)
info = _format_image(image, parsed_args.human_readable) info = _format_image(image, parsed_args.human_readable)
return zip(*sorted(info.items())) return zip(*sorted(info.items()))
@ -1210,7 +1323,7 @@ class UnsetImage(command.Command):
_description = _("Unset image tags and properties") _description = _("Unset image tags and properties")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(UnsetImage, self).get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"image", "image",
metavar="<image>", metavar="<image>",
@ -1222,8 +1335,10 @@ class UnsetImage(command.Command):
metavar="<tag>", metavar="<tag>",
default=[], default=[],
action='append', action='append',
help=_("Unset a tag on this image " help=_(
"(repeat option to unset multiple tags)"), "Unset a tag on this image "
"(repeat option to unset multiple tags)"
),
) )
parser.add_argument( parser.add_argument(
"--property", "--property",
@ -1231,15 +1346,18 @@ class UnsetImage(command.Command):
metavar="<property-key>", metavar="<property-key>",
default=[], default=[],
action='append', action='append',
help=_("Unset a property on this image " help=_(
"(repeat option to unset multiple properties)"), "Unset a property on this image "
"(repeat option to unset multiple properties)"
),
) )
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
image = image_client.find_image(parsed_args.image, image = image_client.find_image(
ignore_missing=False) parsed_args.image, ignore_missing=False
)
kwargs = {} kwargs = {}
tagret = 0 tagret = 0
@ -1249,8 +1367,9 @@ class UnsetImage(command.Command):
try: try:
image_client.remove_tag(image.id, k) image_client.remove_tag(image.id, k)
except Exception: except Exception:
LOG.error(_("tag unset failed, '%s' is a " LOG.error(
"nonexistent tag "), k) _("tag unset failed, '%s' is a " "nonexistent tag "), k
)
tagret += 1 tagret += 1
if parsed_args.properties: if parsed_args.properties:
@ -1262,35 +1381,46 @@ class UnsetImage(command.Command):
# pass modified properties object, so that SDK can figure # pass modified properties object, so that SDK can figure
# out, what was changed inside # out, what was changed inside
# NOTE: ping gtema to improve that in SDK # NOTE: ping gtema to improve that in SDK
new_props = kwargs.get('properties', new_props = kwargs.get(
image.get('properties').copy()) 'properties', image.get('properties').copy()
)
new_props.pop(k, None) new_props.pop(k, None)
kwargs['properties'] = new_props kwargs['properties'] = new_props
else: else:
LOG.error(_("property unset failed, '%s' is a " LOG.error(
"nonexistent property "), k) _(
"property unset failed, '%s' is a "
"nonexistent property "
),
k,
)
propret += 1 propret += 1
# We must give to update a current image for the reference on what # We must give to update a current image for the reference on what
# has changed # has changed
image_client.update_image( image_client.update_image(image, **kwargs)
image,
**kwargs)
tagtotal = len(parsed_args.tags) tagtotal = len(parsed_args.tags)
proptotal = len(parsed_args.properties) proptotal = len(parsed_args.properties)
if (tagret > 0 and propret > 0): if tagret > 0 and propret > 0:
msg = (_("Failed to unset %(tagret)s of %(tagtotal)s tags," msg = _(
"Failed to unset %(propret)s of %(proptotal)s properties.") "Failed to unset %(tagret)s of %(tagtotal)s tags,"
% {'tagret': tagret, 'tagtotal': tagtotal, "Failed to unset %(propret)s of %(proptotal)s properties."
'propret': propret, 'proptotal': proptotal}) ) % {
'tagret': tagret,
'tagtotal': tagtotal,
'propret': propret,
'proptotal': proptotal,
}
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)
elif tagret > 0: elif tagret > 0:
msg = (_("Failed to unset %(tagret)s of %(tagtotal)s tags.") msg = _("Failed to unset %(tagret)s of %(tagtotal)s tags.") % {
% {'tagret': tagret, 'tagtotal': tagtotal}) 'tagret': tagret,
'tagtotal': tagtotal,
}
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)
elif propret > 0: elif propret > 0:
msg = (_("Failed to unset %(propret)s of %(proptotal)s" msg = _(
" properties.") "Failed to unset %(propret)s of %(proptotal)s" " properties."
% {'propret': propret, 'proptotal': proptotal}) ) % {'propret': propret, 'proptotal': proptotal}
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)