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

openstackclient/volume/v3/volume.py

@@ -18,16 +18,19 @@ import argparse
 import copy
 import functools
 import logging
+import typing as ty
 
 from cliff import columns as cliff_columns
+from openstack.block_storage.v3 import volume as _volume
 from openstack import exceptions as sdk_exceptions
 from openstack import utils as sdk_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.api import volume_v3
+from openstackclient import command
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
@@ -59,7 +62,7 @@ class KeyValueHintAction(argparse.Action):
             )
 
 
-class AttachmentsColumn(cliff_columns.FormattableColumn):
+class AttachmentsColumn(cliff_columns.FormattableColumn[list[ty.Any]]):
     """Formattable column for attachments column.
 
     Unlike the parent FormattableColumn class, the initializer of the
@@ -90,6 +93,52 @@ class AttachmentsColumn(cliff_columns.FormattableColumn):
         return msg
 
 
+def _format_volume(volume: _volume.Volume) -> dict[str, ty.Any]:
+    # Some columns returned by openstacksdk should not be shown because they're
+    # either irrelevant or duplicates
+    ignored_columns = {
+        # computed columns
+        'location',
+        # create-only columns
+        'OS-SCH-HNT:scheduler_hints',
+        'imageRef',
+        # removed columns
+        'os-volume-replication:driver_data',
+        'os-volume-replication:extended_status',
+        # unnecessary columns
+        'links',
+    }
+    optional_columns = {
+        # only present if part of a consistency group
+        'consistencygroup_id',
+        # only present if the volume is encrypted
+        'encryption_key_id',
+        # only present if there are image properties associated
+        'volume_image_metadata',
+    }
+
+    info = volume.to_dict(original_names=True)
+    data = {}
+    for key, value in info.items():
+        if key in ignored_columns:
+            continue
+
+        if key in optional_columns:
+            if info[key] is None:
+                continue
+
+        data[key] = value
+
+    data.update(
+        {
+            'properties': format_columns.DictColumn(data.pop('metadata')),
+            'type': data.pop('volume_type'),
+        }
+    )
+
+    return data
+
+
 class CreateVolume(command.ShowOne):
     _description = _("Create new volume")
 
@@ -272,8 +321,7 @@ class CreateVolume(command.ShowOne):
         # volume from snapshot, backup or source volume
         size = parsed_args.size
 
-        volume_client_sdk = self.app.client_manager.sdk_connection.volume
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
         image_client = self.app.client_manager.image
 
         if (
@@ -285,8 +333,8 @@ class CreateVolume(command.ShowOne):
             )
             raise exceptions.CommandError(msg)
 
-        if parsed_args.backup and not (
-            volume_client.api_version.matches('3.47')
+        if parsed_args.backup and not sdk_utils.supports_microversion(
+            volume_client, '3.47'
         ):
             msg = _(
                 "--os-volume-api-version 3.47 or greater is required "
@@ -308,9 +356,7 @@ class CreateVolume(command.ShowOne):
                 )
                 raise exceptions.CommandError(msg)
             if parsed_args.cluster:
-                if not sdk_utils.supports_microversion(
-                    volume_client_sdk, '3.16'
-                ):
+                if not sdk_utils.supports_microversion(volume_client, '3.16'):
                     msg = _(
                         "--os-volume-api-version 3.16 or greater is required "
                         "to support the cluster parameter."
@@ -328,7 +374,7 @@ class CreateVolume(command.ShowOne):
                     "manage a volume."
                 )
                 raise exceptions.CommandError(msg)
-            volume = volume_client_sdk.manage_volume(
+            volume = volume_client.manage_volume(
                 host=parsed_args.host,
                 cluster=parsed_args.cluster,
                 ref=parsed_args.remote_source,
@@ -339,35 +385,22 @@ class CreateVolume(command.ShowOne):
                 metadata=parsed_args.properties,
                 bootable=parsed_args.bootable,
             )
-            data = {}
-            for key, value in volume.to_dict().items():
-                # FIXME(stephenfin): Stop ignoring these once we bump SDK
-                # https://review.opendev.org/c/openstack/openstacksdk/+/945836/
-                if key in (
-                    'cluster_name',
-                    'consumes_quota',
-                    'encryption_key_id',
-                    'service_uuid',
-                    'shared_targets',
-                    'volume_type_id',
-                ):
-                    continue
-                data[key] = value
+            data = _format_volume(volume)
             return zip(*sorted(data.items()))
 
         source_volume = None
         if parsed_args.source:
-            source_volume_obj = utils.find_resource(
-                volume_client.volumes, parsed_args.source
+            source_volume_obj = volume_client.find_volume(
+                parsed_args.source, ignore_missing=False
             )
             source_volume = source_volume_obj.id
             size = max(size or 0, source_volume_obj.size)
 
         consistency_group = None
         if parsed_args.consistency_group:
-            consistency_group = utils.find_resource(
-                volume_client.consistencygroups, parsed_args.consistency_group
-            ).id
+            consistency_group = volume_v3.find_consistency_group(
+                volume_client, parsed_args.consistency_group
+            )['id']
 
         image = None
         if parsed_args.image:
@@ -377,8 +410,8 @@ class CreateVolume(command.ShowOne):
 
         snapshot = None
         if parsed_args.snapshot:
-            snapshot_obj = utils.find_resource(
-                volume_client.volume_snapshots, parsed_args.snapshot
+            snapshot_obj = volume_client.find_snapshot(
+                parsed_args.snapshot, ignore_missing=False
             )
             snapshot = snapshot_obj.id
             # Cinder requires a value for size when creating a volume
@@ -391,14 +424,14 @@ class CreateVolume(command.ShowOne):
 
         backup = None
         if parsed_args.backup:
-            backup_obj = utils.find_resource(
-                volume_client.backups, parsed_args.backup
+            backup_obj = volume_client.find_backup(
+                parsed_args.backup, ignore_missing=False
             )
             backup = backup_obj.id
             # As above
             size = max(size or 0, backup_obj.size)
 
-        volume = volume_client.volumes.create(
+        volume = volume_client.create_volume(
             size=size,
             snapshot_id=snapshot,
             name=parsed_args.name,
@@ -406,9 +439,9 @@ class CreateVolume(command.ShowOne):
             volume_type=parsed_args.type,
             availability_zone=parsed_args.availability_zone,
             metadata=parsed_args.properties,
-            imageRef=image,
-            source_volid=source_volume,
-            consistencygroup_id=consistency_group,
+            image_id=image,
+            source_volume_id=source_volume,
+            consistency_group_id=consistency_group,
             scheduler_hints=parsed_args.hint,
             backup_id=backup,
         )
@@ -416,14 +449,14 @@ class CreateVolume(command.ShowOne):
         if parsed_args.bootable is not None:
             try:
                 if utils.wait_for_status(
-                    volume_client.volumes.get,
+                    volume_client.get_volume,
                     volume.id,
                     success_status=['available'],
                     error_status=['error'],
                     sleep_time=1,
                 ):
-                    volume_client.volumes.set_bootable(
-                        volume.id, parsed_args.bootable
+                    volume_client.set_volume_bootable_status(
+                        volume, parsed_args.bootable
                     )
                 else:
                     msg = _(
@@ -436,14 +469,14 @@ class CreateVolume(command.ShowOne):
         if parsed_args.read_only is not None:
             try:
                 if utils.wait_for_status(
-                    volume_client.volumes.get,
+                    volume_client.get_volume,
                     volume.id,
                     success_status=['available'],
                     error_status=['error'],
                     sleep_time=1,
                 ):
-                    volume_client.volumes.update_readonly_flag(
-                        volume.id, parsed_args.read_only
+                    volume_client.set_volume_readonly(
+                        volume, parsed_args.read_only
                     )
                 else:
                     msg = _(
@@ -457,17 +490,8 @@ class CreateVolume(command.ShowOne):
                     e,
                 )
 
-        # Remove key links from being displayed
-        volume._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    volume._info.pop('metadata')
-                ),
-                'type': volume._info.pop('volume_type'),
-            }
-        )
-        volume._info.pop("links", None)
-        return zip(*sorted(volume._info.items()))
+        data = _format_volume(volume)
+        return zip(*sorted(data.items()))
 
 
 class DeleteVolume(command.Command):
@@ -574,6 +598,16 @@ class ListVolume(command.Lister):
             metavar='<status>',
             help=_('Filter results by status'),
         )
+        parser.add_argument(
+            '--property',
+            metavar='<key=value>',
+            action=parseractions.KeyValueAction,
+            dest='properties',
+            help=_(
+                'Filter by a property on the volume list '
+                '(repeat option to filter by multiple properties) '
+            ),
+        )
         parser.add_argument(
             '--all-projects',
             action='store_true',
@@ -642,6 +676,7 @@ class ListVolume(command.Lister):
             'user_id': user_id,
             'name': parsed_args.name,
             'status': parsed_args.status,
+            'metadata': parsed_args.properties,
         }
 
         data = volume_client.volumes.list(
@@ -726,16 +761,19 @@ class MigrateVolume(command.Command):
                 "(possibly by another operation)"
             ),
         )
+        # TODO(stephenfin): Add --cluster argument
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
-        volume_client.volumes.migrate_volume(
+        volume_client = self.app.client_manager.sdk_connection.volume
+        volume = volume_client.find_volume(
+            parsed_args.volume, ignore_missing=False
+        )
+        volume_client.migrate_volume(
             volume.id,
-            parsed_args.host,
-            parsed_args.force_host_copy,
-            parsed_args.lock_volume,
+            host=parsed_args.host,
+            force_host_copy=parsed_args.force_host_copy,
+            lock_volume=parsed_args.lock_volume,
         )
 
 
@@ -1078,24 +1116,13 @@ class ShowVolume(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
-        volume = utils.find_resource(volume_client.volumes, parsed_args.volume)
+        volume_client = self.app.client_manager.sdk_connection.volume
+        volume = volume_client.find_volume(
+            parsed_args.volume, ignore_missing=False
+        )
 
-        # Special mapping for columns to make the output easier to read:
-        # 'metadata' --> 'properties'
-        # 'volume_type' --> 'type'
-        volume._info.update(
-            {
-                'properties': format_columns.DictColumn(
-                    volume._info.pop('metadata')
-                ),
-                'type': volume._info.pop('volume_type'),
-            },
-        )
-
-        # Remove key links from being displayed
-        volume._info.pop("links", None)
-        return zip(*sorted(volume._info.items()))
+        data = _format_volume(volume)
+        return zip(*sorted(data.items()))
 
 
 class UnsetVolume(command.Command):

openstackclient/volume/v3/volume_attachment.py

@@ -11,13 +11,14 @@
 # under the License.
 
 import logging
+import typing as ty
 
 from openstack import utils as sdk_utils
 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.common import envvars
 from openstackclient.common import pagination
 from openstackclient.i18n import _
@@ -56,12 +57,12 @@ def _format_attachment(attachment):
     # VolumeAttachmentManager.create returns a dict while everything else
     # returns a VolumeAttachment object
     if isinstance(attachment, dict):
-        data = []
+        data: tuple[ty.Any, ...] = ()
         for column in columns:
             if column == 'connection_info':
-                data.append(format_columns.DictColumn(attachment[column]))
+                data += (format_columns.DictColumn(attachment[column]),)
                 continue
-            data.append(attachment[column])
+            data += (attachment[column],)
     else:
         data = utils.get_item_properties(
             attachment,
@@ -458,7 +459,7 @@ class ListVolumeAttachment(command.Lister):
         }
         # Update search option with `filters`
         # if AppendFilters.filters:
-        #     search_opts.update(shell_utils.extract_filters(AppendFilters.filters))
+        #     search_opts.update(shell_utils.extract_filters(AppendFilters.filters))  # noqa: E501
 
         # TODO(stephenfin): Implement sorting
         attachments = volume_client.attachments(

openstackclient/volume/v3/volume_backup.py

@@ -21,17 +21,17 @@ import logging
 from cliff import columns as cliff_columns
 from openstack import utils as sdk_utils
 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.i18n import _
 
 LOG = logging.getLogger(__name__)
 
 
-class VolumeIdColumn(cliff_columns.FormattableColumn):
+class VolumeIdColumn(cliff_columns.FormattableColumn[str]):
     """Formattable column for volume ID column.
 
     Unlike the parent FormattableColumn class, the initializer of the
@@ -236,6 +236,11 @@ class ListVolumeBackup(command.Lister):
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
+        parser.add_argument(
+            '--project',
+            metavar='<project>',
+            help=_('Filter results by project (name or ID) (admin only)'),
+        )
         parser.add_argument(
             "--long",
             action="store_true",
@@ -296,6 +301,7 @@ class ListVolumeBackup(command.Lister):
 
     def take_action(self, parsed_args):
         volume_client = self.app.client_manager.sdk_connection.volume
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         columns: tuple[str, ...] = (
             'id',
@@ -332,6 +338,14 @@ class ListVolumeBackup(command.Lister):
             VolumeIdColumn, volume_cache=volume_cache
         )
 
+        all_tenants = parsed_args.all_projects
+        project_id = None
+        if parsed_args.project:
+            all_tenants = True
+            project_id = identity_client.find_project(
+                parsed_args.project, ignore_missing=False
+            ).id
+
         filter_volume_id = None
         if parsed_args.volume:
             try:
@@ -360,9 +374,10 @@ class ListVolumeBackup(command.Lister):
             name=parsed_args.name,
             status=parsed_args.status,
             volume_id=filter_volume_id,
-            all_tenants=parsed_args.all_projects,
+            all_tenants=all_tenants,
             marker=marker_backup_id,
             limit=parsed_args.limit,
+            project_id=project_id,
         )
 
         return (

openstackclient/volume/v3/volume_group.py

@@ -13,10 +13,10 @@
 import argparse
 
 from cinderclient import api_versions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.common import envvars
 from openstackclient.i18n import _
 
@@ -552,7 +552,7 @@ class ShowVolumeGroup(command.ShowOne):
             parsed_args.group,
         )
 
-        group = volume_client.groups.show(group.id, **kwargs)
+        group = volume_client.groups.get(group.id, **kwargs)
 
         if parsed_args.show_replication_targets:
             replication_targets = (

openstackclient/volume/v3/volume_group_snapshot.py

@@ -13,10 +13,10 @@
 import logging
 
 from openstack import utils as sdk_utils
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.common import envvars
 from openstackclient.i18n import _
 

openstackclient/volume/v3/volume_group_type.py

@@ -15,10 +15,10 @@ import logging
 from cinderclient import api_versions
 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 _
 
 LOG = logging.getLogger(__name__)

openstackclient/volume/v3/volume_message.py

@@ -17,10 +17,10 @@
 import logging as LOG
 
 from cinderclient import api_versions
-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.i18n import _
 from openstackclient.identity import common as identity_common

openstackclient/volume/v3/volume_snapshot.py

@@ -22,10 +22,10 @@ from cliff import columns as cliff_columns
 from openstack.block_storage.v3 import snapshot as _snapshot
 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.i18n import _
 from openstackclient.identity import common as identity_common
@@ -33,7 +33,7 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-class VolumeIdColumn(cliff_columns.FormattableColumn):
+class VolumeIdColumn(cliff_columns.FormattableColumn[str]):
     """Formattable column for volume ID column.
 
     Unlike the parent FormattableColumn class, the initializer of the

openstackclient/volume/v3/volume_transfer_request.py

@@ -17,10 +17,10 @@
 import logging
 
 from cinderclient import api_versions
-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/volume/v3/volume_type.py

@@ -10,21 +10,21 @@
 #   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 v3 Type action implementations"""
 
 import functools
 import logging
+import typing as ty
 
 from cinderclient import api_versions
 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 import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -32,7 +32,7 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-class EncryptionInfoColumn(cliff_columns.FormattableColumn):
+class EncryptionInfoColumn(cliff_columns.FormattableColumn[ty.Any]):
     """Formattable column for encryption info column.
 
     Unlike the parent FormattableColumn class, the initializer of the
@@ -172,7 +172,8 @@ class CreateVolumeType(command.ShowOne):
             default=False,
             help=_(
                 "Enabled replication for this volume type "
-                "(this is an alias for '--property replication_enabled=<is> True') "
+                "(this is an alias for "
+                "'--property replication_enabled=<is> True') "
                 "(requires driver support)"
             ),
         )
@@ -182,7 +183,8 @@ class CreateVolumeType(command.ShowOne):
             dest='availability_zones',
             help=_(
                 "Set an availability zone for this volume type "
-                "(this is an alias for '--property RESKEY:availability_zones:<az>') "
+                "(this is an alias for "
+                "'--property RESKEY:availability_zones:<az>') "
                 "(repeat option to set multiple availability zones)"
             ),
         )
@@ -447,7 +449,8 @@ class ListVolumeType(command.Lister):
             default=False,
             help=_(
                 "List only volume types with replication enabled "
-                "(this is an alias for '--property replication_enabled=<is> True') "
+                "(this is an alias for "
+                "'--property replication_enabled=<is> True') "
                 "(supported by --os-volume-api-version 3.52 or above)"
             ),
         )
@@ -457,7 +460,8 @@ class ListVolumeType(command.Lister):
             dest='availability_zones',
             help=_(
                 "List only volume types with this availability configured "
-                "(this is an alias for '--property RESKEY:availability_zones:<az>') "
+                "(this is an alias for "
+                "'--property RESKEY:availability_zones:<az>') "
                 "(repeat option to filter on multiple availability zones)"
             ),
         )
@@ -616,7 +620,8 @@ class SetVolumeType(command.Command):
             default=False,
             help=_(
                 "Enabled replication for this volume type "
-                "(this is an alias for '--property replication_enabled=<is> True') "
+                "(this is an alias for "
+                "'--property replication_enabled=<is> True') "
                 "(requires driver support)"
             ),
         )
@@ -626,7 +631,8 @@ class SetVolumeType(command.Command):
             dest='availability_zones',
             help=_(
                 "Set an availability zone for this volume type "
-                "(this is an alias for '--property RESKEY:availability_zones:<az>') "
+                "(this is an alias for "
+                "'--property RESKEY:availability_zones:<az>') "
                 "(repeat option to set multiple availability zones)"
             ),
         )