python-openstackclient 7.3.1__py3-none-any.whl → 8.0.0__py3-none-any.whl

openstackclient/volume/v1/volume_snapshot.py

@@ -1,433 +0,0 @@
-#   Copyright 2012-2013 OpenStack Foundation
-#
-#   Licensed under the Apache License, Version 2.0 (the "License"); you may
-#   not use this file except in compliance with the License. You may obtain
-#   a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-#   License for the specific language governing permissions and limitations
-#   under the License.
-#
-
-"""Volume v1 Snapshot action implementations"""
-
-import copy
-import functools
-import logging
-
-from cliff import columns as cliff_columns
-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.i18n import _
-
-
-LOG = logging.getLogger(__name__)
-
-
-class VolumeIdColumn(cliff_columns.FormattableColumn):
-    """Formattable column for volume ID column.
-
-    Unlike the parent FormattableColumn class, the initializer of the
-    class takes volume_cache as the second argument.
-    osc_lib.utils.get_item_properties instantiate cliff FormattableColumn
-    object with a single parameter "column value", so you need to pass
-    a partially initialized class like
-    ``functools.partial(VolumeIdColumn, volume_cache)``.
-    """
-
-    def __init__(self, value, volume_cache=None):
-        super().__init__(value)
-        self._volume_cache = volume_cache or {}
-
-    def human_readable(self):
-        """Return a volume name if available
-
-        :rtype: either the volume ID or name
-        """
-        volume_id = self._value
-        volume = volume_id
-        if volume_id in self._volume_cache.keys():
-            volume = self._volume_cache[volume_id].display_name
-        return volume
-
-
-class CreateVolumeSnapshot(command.ShowOne):
-    _description = _("Create new volume snapshot")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'snapshot_name',
-            metavar='<snapshot-name>',
-            help=_('Name of the new snapshot'),
-        )
-        parser.add_argument(
-            '--volume',
-            metavar='<volume>',
-            help=_(
-                'Volume to snapshot (name or ID) '
-                '(default is <snapshot-name>)'
-            ),
-        )
-        parser.add_argument(
-            '--description',
-            metavar='<description>',
-            help=_('Description of the snapshot'),
-        )
-        parser.add_argument(
-            '--force',
-            dest='force',
-            action='store_true',
-            default=False,
-            help=_(
-                'Create a snapshot attached to an instance. '
-                'Default is False'
-            ),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume = parsed_args.volume
-        if not parsed_args.volume:
-            volume = parsed_args.snapshot_name
-        volume_id = utils.find_resource(volume_client.volumes, volume).id
-        snapshot = volume_client.volume_snapshots.create(
-            volume_id,
-            parsed_args.force,
-            parsed_args.snapshot_name,
-            parsed_args.description,
-        )
-
-        snapshot._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    snapshot._info.pop('metadata')
-                )
-            }
-        )
-
-        return zip(*sorted(snapshot._info.items()))
-
-
-class DeleteVolumeSnapshot(command.Command):
-    _description = _("Delete volume snapshot(s)")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'snapshots',
-            metavar='<snapshot>',
-            nargs="+",
-            help=_('Snapshot(s) to delete (name or ID)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        result = 0
-
-        for i in parsed_args.snapshots:
-            try:
-                snapshot_id = utils.find_resource(
-                    volume_client.volume_snapshots, i
-                ).id
-                volume_client.volume_snapshots.delete(snapshot_id)
-            except Exception as e:
-                result += 1
-                LOG.error(
-                    _(
-                        "Failed to delete snapshot with "
-                        "name or ID '%(snapshot)s': %(e)s"
-                    ),
-                    {'snapshot': i, 'e': e},
-                )
-
-        if result > 0:
-            total = len(parsed_args.snapshots)
-            msg = _(
-                "%(result)s of %(total)s snapshots failed " "to delete."
-            ) % {'result': result, 'total': total}
-            raise exceptions.CommandError(msg)
-
-
-class ListVolumeSnapshot(command.Lister):
-    _description = _("List volume snapshots")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            '--all-projects',
-            action='store_true',
-            default=False,
-            help=_('Include all projects (admin only)'),
-        )
-        parser.add_argument(
-            '--long',
-            action='store_true',
-            default=False,
-            help=_('List additional fields in output'),
-        )
-        parser.add_argument(
-            '--name',
-            metavar='<name>',
-            default=None,
-            help=_('Filters results by a name.'),
-        )
-        parser.add_argument(
-            '--status',
-            metavar='<status>',
-            choices=[
-                'available',
-                'error',
-                'creating',
-                'deleting',
-                'error_deleting',
-            ],
-            help=_(
-                "Filters results by a status. "
-                "('available', 'error', 'creating', 'deleting'"
-                " or 'error_deleting')"
-            ),
-        )
-        parser.add_argument(
-            '--volume',
-            metavar='<volume>',
-            default=None,
-            help=_('Filters results by a volume (name or ID).'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-
-        if parsed_args.long:
-            columns = [
-                'ID',
-                'Display Name',
-                'Display Description',
-                'Status',
-                'Size',
-                'Created At',
-                'Volume ID',
-                'Metadata',
-            ]
-            column_headers = copy.deepcopy(columns)
-            column_headers[6] = 'Volume'
-            column_headers[7] = 'Properties'
-        else:
-            columns = [
-                'ID',
-                'Display Name',
-                'Display Description',
-                'Status',
-                'Size',
-            ]
-            column_headers = copy.deepcopy(columns)
-
-        # Always update Name and Description
-        column_headers[1] = 'Name'
-        column_headers[2] = 'Description'
-
-        # Cache the volume list
-        volume_cache = {}
-        try:
-            for s in volume_client.volumes.list():
-                volume_cache[s.id] = s
-        except Exception:  # noqa: S110
-            # Just forget it if there's any trouble
-            pass
-        VolumeIdColumnWithCache = functools.partial(
-            VolumeIdColumn, volume_cache=volume_cache
-        )
-
-        volume_id = None
-        if parsed_args.volume:
-            volume_id = utils.find_resource(
-                volume_client.volumes, parsed_args.volume
-            ).id
-
-        search_opts = {
-            'all_tenants': parsed_args.all_projects,
-            'display_name': parsed_args.name,
-            'status': parsed_args.status,
-            'volume_id': volume_id,
-        }
-
-        data = volume_client.volume_snapshots.list(search_opts=search_opts)
-        return (
-            column_headers,
-            (
-                utils.get_item_properties(
-                    s,
-                    columns,
-                    formatters={
-                        'Metadata': format_columns.DictColumn,
-                        'Volume ID': VolumeIdColumnWithCache,
-                    },
-                )
-                for s in data
-            ),
-        )
-
-
-class SetVolumeSnapshot(command.Command):
-    _description = _("Set volume snapshot properties")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'snapshot',
-            metavar='<snapshot>',
-            help=_('Snapshot to modify (name or ID)'),
-        )
-        parser.add_argument(
-            '--name', metavar='<name>', help=_('New snapshot name')
-        )
-        parser.add_argument(
-            '--description',
-            metavar='<description>',
-            help=_('New snapshot description'),
-        )
-        parser.add_argument(
-            "--no-property",
-            dest="no_property",
-            action="store_true",
-            help=_(
-                "Remove all properties from <snapshot> "
-                "(specify both --no-property and --property to "
-                "remove the current properties before setting "
-                "new properties.)"
-            ),
-        )
-        parser.add_argument(
-            '--property',
-            metavar='<key=value>',
-            action=parseractions.KeyValueAction,
-            help=_(
-                'Property to add/change for this snapshot '
-                '(repeat option to set multiple properties)'
-            ),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        snapshot = utils.find_resource(
-            volume_client.volume_snapshots, parsed_args.snapshot
-        )
-
-        result = 0
-        if parsed_args.no_property:
-            try:
-                key_list = snapshot.metadata.keys()
-                volume_client.volume_snapshots.delete_metadata(
-                    snapshot.id,
-                    list(key_list),
-                )
-            except Exception as e:
-                LOG.error(_("Failed to clean snapshot properties: %s"), e)
-                result += 1
-
-        if parsed_args.property:
-            try:
-                volume_client.volume_snapshots.set_metadata(
-                    snapshot.id, parsed_args.property
-                )
-            except Exception as e:
-                LOG.error(_("Failed to set snapshot property: %s"), e)
-                result += 1
-
-        kwargs = {}
-        if parsed_args.name:
-            kwargs['display_name'] = parsed_args.name
-        if parsed_args.description:
-            kwargs['display_description'] = parsed_args.description
-        if kwargs:
-            try:
-                snapshot.update(**kwargs)
-            except Exception as e:
-                LOG.error(
-                    _(
-                        "Failed to update snapshot display name "
-                        "or display description: %s"
-                    ),
-                    e,
-                )
-                result += 1
-
-        if result > 0:
-            raise exceptions.CommandError(
-                _("One or more of the " "set operations failed")
-            )
-
-
-class ShowVolumeSnapshot(command.ShowOne):
-    _description = _("Display volume snapshot details")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'snapshot',
-            metavar='<snapshot>',
-            help=_('Snapshot to display (name or ID)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        snapshot = utils.find_resource(
-            volume_client.volume_snapshots, parsed_args.snapshot
-        )
-
-        snapshot._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    snapshot._info.pop('metadata')
-                )
-            }
-        )
-
-        return zip(*sorted(snapshot._info.items()))
-
-
-class UnsetVolumeSnapshot(command.Command):
-    _description = _("Unset volume snapshot properties")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'snapshot',
-            metavar='<snapshot>',
-            help=_('Snapshot to modify (name or ID)'),
-        )
-        parser.add_argument(
-            '--property',
-            metavar='<key>',
-            action='append',
-            help=_(
-                'Property to remove from snapshot '
-                '(repeat option to remove multiple properties)'
-            ),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        snapshot = utils.find_resource(
-            volume_client.volume_snapshots, parsed_args.snapshot
-        )
-
-        if parsed_args.property:
-            volume_client.volume_snapshots.delete_metadata(
-                snapshot.id,
-                parsed_args.property,
-            )

openstackclient/volume/v1/volume_transfer_request.py

@@ -1,200 +0,0 @@
-#
-#   Licensed under the Apache License, Version 2.0 (the "License"); you may
-#   not use this file except in compliance with the License. You may obtain
-#   a copy of the License at
-#
-#        http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-#   License for the specific language governing permissions and limitations
-#   under the License.
-#
-
-"""Volume v1 transfer action implementations"""
-
-import logging
-
-from osc_lib.command import command
-from osc_lib import exceptions
-from osc_lib import utils
-
-from openstackclient.i18n import _
-
-
-LOG = logging.getLogger(__name__)
-
-
-class AcceptTransferRequest(command.ShowOne):
-    _description = _("Accept volume transfer request.")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'transfer_request',
-            metavar="<transfer-request-id>",
-            help=_('Volume transfer request to accept (ID only)'),
-        )
-        parser.add_argument(
-            '--auth-key',
-            metavar="<key>",
-            help=_('Volume transfer request authentication key'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-
-        try:
-            transfer_request_id = utils.find_resource(
-                volume_client.transfers, parsed_args.transfer_request
-            ).id
-        except exceptions.CommandError:
-            # Non-admin users will fail to lookup name -> ID so we just
-            # move on and attempt with the user-supplied information
-            transfer_request_id = parsed_args.transfer_request
-
-        if not parsed_args.auth_key:
-            msg = _("argument --auth-key is required")
-            raise exceptions.CommandError(msg)
-
-        transfer_accept = volume_client.transfers.accept(
-            transfer_request_id,
-            parsed_args.auth_key,
-        )
-        transfer_accept._info.pop("links", None)
-
-        return zip(*sorted(transfer_accept._info.items()))
-
-
-class CreateTransferRequest(command.ShowOne):
-    _description = _("Create volume transfer request.")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            '--name',
-            metavar="<name>",
-            help=_('New transfer request name (default to None)'),
-        )
-        parser.add_argument(
-            'volume',
-            metavar="<volume>",
-            help=_('Volume to transfer (name or ID)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume_id = utils.find_resource(
-            volume_client.volumes,
-            parsed_args.volume,
-        ).id
-        volume_transfer_request = volume_client.transfers.create(
-            volume_id,
-            parsed_args.name,
-        )
-        volume_transfer_request._info.pop("links", None)
-
-        return zip(*sorted(volume_transfer_request._info.items()))
-
-
-class DeleteTransferRequest(command.Command):
-    _description = _("Delete volume transfer request(s).")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'transfer_request',
-            metavar="<transfer-request>",
-            nargs="+",
-            help=_('Volume transfer request(s) to delete (name or ID)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        result = 0
-
-        for t in parsed_args.transfer_request:
-            try:
-                transfer_request_id = utils.find_resource(
-                    volume_client.transfers,
-                    t,
-                ).id
-                volume_client.transfers.delete(transfer_request_id)
-            except Exception as e:
-                result += 1
-                LOG.error(
-                    _(
-                        "Failed to delete volume transfer request "
-                        "with name or ID '%(transfer)s': %(e)s"
-                    )
-                    % {'transfer': t, 'e': e}
-                )
-
-        if result > 0:
-            total = len(parsed_args.transfer_request)
-            msg = _(
-                "%(result)s of %(total)s volume transfer requests failed"
-                " to delete"
-            ) % {'result': result, 'total': total}
-            raise exceptions.CommandError(msg)
-
-
-class ListTransferRequest(command.Lister):
-    _description = _("Lists all volume transfer requests.")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            '--all-projects',
-            dest='all_projects',
-            action="store_true",
-            default=False,
-            help=_('Include all projects (admin only)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        columns = ['ID', 'Name', 'Volume ID']
-        column_headers = ['ID', 'Name', 'Volume']
-
-        volume_client = self.app.client_manager.volume
-
-        volume_transfer_result = volume_client.transfers.list(
-            detailed=True,
-            search_opts={'all_tenants': parsed_args.all_projects},
-        )
-
-        return (
-            column_headers,
-            (
-                utils.get_item_properties(s, columns)
-                for s in volume_transfer_result
-            ),
-        )
-
-
-class ShowTransferRequest(command.ShowOne):
-    _description = _("Show volume transfer request details.")
-
-    def get_parser(self, prog_name):
-        parser = super().get_parser(prog_name)
-        parser.add_argument(
-            'transfer_request',
-            metavar="<transfer-request>",
-            help=_('Volume transfer request to display (name or ID)'),
-        )
-        return parser
-
-    def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume_transfer_request = utils.find_resource(
-            volume_client.transfers,
-            parsed_args.transfer_request,
-        )
-        volume_transfer_request._info.pop("links", None)
-
-        return zip(*sorted(volume_transfer_request._info.items()))