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

openstackclient/tests/unit/volume/v3/test_volume_backup.py

@@ -17,6 +17,7 @@ from openstack.block_storage.v3 import backup as _backup
 from openstack.block_storage.v3 import snapshot as _snapshot
 from openstack.block_storage.v3 import volume as _volume
 from openstack import exceptions as sdk_exceptions
+from openstack.identity.v3 import project as _project
 from openstack.test import fakes as sdk_fakes
 from osc_lib import exceptions
 
@@ -381,6 +382,7 @@ class TestBackupList(volume_fakes.TestVolume):
             ("marker", None),
             ("limit", None),
             ('all_projects', False),
+            ("project", None),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -395,11 +397,14 @@ class TestBackupList(volume_fakes.TestVolume):
             all_tenants=False,
             marker=None,
             limit=None,
+            project_id=None,
         )
         self.assertEqual(self.columns, columns)
         self.assertCountEqual(self.data, list(data))
 
     def test_backup_list_with_options(self):
+        project = sdk_fakes.generate_fake_resource(_project.Project)
+        self.identity_sdk_client.find_project.return_value = project
         arglist = [
             "--long",
             "--name",
@@ -413,6 +418,8 @@ class TestBackupList(volume_fakes.TestVolume):
             "--all-projects",
             "--limit",
             "3",
+            "--project",
+            project.id,
         ]
         verifylist = [
             ("long", True),
@@ -422,6 +429,7 @@ class TestBackupList(volume_fakes.TestVolume):
             ("marker", self.backups[0].id),
             ('all_projects', True),
             ("limit", 3),
+            ("project", project.id),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -440,6 +448,7 @@ class TestBackupList(volume_fakes.TestVolume):
             all_tenants=True,
             marker=self.backups[0].id,
             limit=3,
+            project_id=project.id,
         )
         self.assertEqual(self.columns_long, columns)
         self.assertCountEqual(self.data_long, list(data))

openstackclient/volume/client.py

@@ -20,16 +20,14 @@ from osc_lib import utils
 
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
 DEFAULT_API_VERSION = '3'
 API_VERSION_OPTION = 'os_volume_api_version'
-API_NAME = "volume"
+API_NAME = 'volume'
 API_VERSIONS = {
-    "1": "cinderclient.v1.client.Client",
-    "2": "cinderclient.v2.client.Client",
-    "3": "cinderclient.v3.client.Client",
+    '2': 'cinderclient.v2.client.Client',
+    '3': 'cinderclient.v3.client.Client',
 }
 
 # Save the microversion if in use
@@ -45,11 +43,6 @@ def make_client(instance):
     from cinderclient.v3 import volume_snapshots
     from cinderclient.v3 import volumes
 
-    # Check whether the available cinderclient supports v1 or v2
-    try:
-        from cinderclient.v1 import services  # noqa
-    except Exception:
-        del API_VERSIONS['1']
     try:
         from cinderclient.v2 import services  # noqa
     except Exception:
@@ -127,21 +120,18 @@ def check_api_version(check_version):
 
     global _volume_api_version
 
-    # Copy some logic from novaclient 3.3.0 for basic version detection
-    # NOTE(dtroyer): This is only enough to resume operations using API
-    # version 3.0 or any valid version supplied by the user.
     _volume_api_version = api_versions.get_api_version(check_version)
 
     # Bypass X.latest format microversion
     if not _volume_api_version.is_latest():
-        if _volume_api_version > api_versions.APIVersion("3.0"):
+        if _volume_api_version > api_versions.APIVersion('3.0'):
             if not _volume_api_version.matches(
                 api_versions.MIN_VERSION,
                 api_versions.MAX_VERSION,
             ):
-                msg = _("versions supported by client: %(min)s - %(max)s") % {
-                    "min": api_versions.MIN_VERSION,
-                    "max": api_versions.MAX_VERSION,
+                msg = _('versions supported by client: %(min)s - %(max)s') % {
+                    'min': api_versions.MIN_VERSION,
+                    'max': api_versions.MAX_VERSION,
                 }
                 raise exceptions.CommandError(msg)
 

openstackclient/volume/v2/backup_record.py

@@ -16,9 +16,9 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v2/consistency_group.py

@@ -18,10 +18,10 @@ import argparse
 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 _
 
 
@@ -38,8 +38,8 @@ def _find_volumes(parsed_args_volumes, volume_client):
         except Exception as e:
             result += 1
             LOG.error(
-                _("Failed to find volume with name or ID '%(volume)s':%(e)s")
-                % {'volume': volume, 'e': e}
+                _("Failed to find volume with name or ID '%(volume)s':%(e)s"),
+                {'volume': volume, 'e': e},
             )
 
     return result, uuid
@@ -73,8 +73,8 @@ class AddVolumeToConsistencyGroup(command.Command):
         if result > 0:
             total = len(parsed_args.volumes)
             LOG.error(
-                _("%(result)s of %(total)s volumes failed to add.")
-                % {'result': result, 'total': total}
+                _("%(result)s of %(total)s volumes failed to add."),
+                {'result': result, 'total': total},
             )
 
         if add_uuid:
@@ -226,8 +226,8 @@ class DeleteConsistencyGroup(command.Command):
                     _(
                         "Failed to delete consistency group with "
                         "name or ID '%(consistency_group)s':%(e)s"
-                    )
-                    % {'consistency_group': i, 'e': e}
+                    ),
+                    {'consistency_group': i, 'e': e},
                 )
 
         if result > 0:
@@ -317,8 +317,8 @@ class RemoveVolumeFromConsistencyGroup(command.Command):
         if result > 0:
             total = len(parsed_args.volumes)
             LOG.error(
-                _("%(result)s of %(total)s volumes failed to remove.")
-                % {'result': result, 'total': total}
+                _("%(result)s of %(total)s volumes failed to remove."),
+                {'result': result, 'total': total},
             )
 
         if remove_uuid:

openstackclient/volume/v2/consistency_group_snapshot.py

@@ -16,10 +16,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 _
 
 
@@ -101,8 +101,8 @@ class DeleteConsistencyGroupSnapshot(command.Command):
                     _(
                         "Failed to delete consistency group snapshot "
                         "with name or ID '%(snapshot)s': %(e)s"
-                    )
-                    % {'snapshot': snapshot, 'e': e}
+                    ),
+                    {'snapshot': snapshot, 'e': e},
                 )
 
         if result > 0:

openstackclient/volume/v2/qos_specs.py

@@ -19,10 +19,10 @@ import logging
 
 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 _
 
 
@@ -146,8 +146,8 @@ class DeleteQos(command.Command):
                     _(
                         "Failed to delete QoS specification with "
                         "name or ID '%(qos)s': %(e)s"
-                    )
-                    % {'qos': i, 'e': e}
+                    ),
+                    {'qos': i, 'e': e},
                 )
 
         if result > 0:

openstackclient/volume/v2/service.py

@@ -14,10 +14,10 @@
 
 """Service 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 _
 
 

openstackclient/volume/v2/volume.py

@@ -25,11 +25,11 @@ from openstack.block_storage.v2 import volume as _volume
 from openstack import exceptions as sdk_exceptions
 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_v2
+from openstackclient import command
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
@@ -61,7 +61,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
@@ -390,12 +390,19 @@ class DeleteVolume(command.Command):
             ),
         )
         group.add_argument(
-            "--purge",
+            "--cascade",
             action="store_true",
             help=_(
                 "Remove any snapshots along with volume(s) (defaults to False)"
             ),
         )
+        group.add_argument(
+            # now called "cascade", accept old arg for compatibility
+            "--purge",
+            action="store_true",
+            help=argparse.SUPPRESS,
+            dest='cascade',
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -410,7 +417,7 @@ class DeleteVolume(command.Command):
                 volume_client.delete_volume(
                     volume_obj.id,
                     force=parsed_args.force,
-                    cascade=parsed_args.purge,
+                    cascade=parsed_args.cascade,
                 )
             except Exception as e:
                 result += 1
@@ -910,12 +917,12 @@ class SetVolume(command.Command):
         elif policy:
             # If the "--migration-policy" is specified without "--type"
             LOG.warning(
-                _("'%s' option will not work without '--type' option")
-                % (
+                _("'%s' option will not work without '--type' option"),
+                (
                     '--migration-policy'
                     if parsed_args.migration_policy
                     else '--retype-policy'
-                )
+                ),
             )
 
         kwargs = {}

openstackclient/volume/v2/volume_backend.py

@@ -15,9 +15,9 @@
 """Storage backend action implementations"""
 
 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 _
 
 

openstackclient/volume/v2/volume_backup.py

@@ -18,17 +18,17 @@ import functools
 import logging
 
 from cliff import columns as cliff_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 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
@@ -175,8 +175,8 @@ class DeleteVolumeBackup(command.Command):
                     _(
                         "Failed to delete backup with "
                         "name or ID '%(backup)s': %(e)s"
-                    )
-                    % {'backup': backup, 'e': e}
+                    ),
+                    {'backup': backup, 'e': e},
                 )
 
         if result > 0:
@@ -453,7 +453,9 @@ class ShowVolumeBackup(command.ShowOne):
 
     def take_action(self, parsed_args):
         volume_client = self.app.client_manager.sdk_connection.volume
-        backup = volume_client.find_backup(parsed_args.backup)
+        backup = volume_client.find_backup(
+            parsed_args.backup, ignore_missing=False
+        )
         columns: tuple[str, ...] = (
             "availability_zone",
             "container",

openstackclient/volume/v2/volume_host.py

@@ -14,8 +14,7 @@
 
 """Volume v2 host action implementations"""
 
-from osc_lib.command import command
-
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v2/volume_snapshot.py

@@ -22,10 +22,10 @@ from cliff import columns as cliff_columns
 from openstack.block_storage.v2 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
@@ -34,7 +34,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
@@ -228,8 +228,8 @@ class DeleteVolumeSnapshot(command.Command):
                     _(
                         "Failed to delete snapshot with "
                         "name or ID '%(snapshot)s': %(e)s"
-                    )
-                    % {'snapshot': snapshot, 'e': e}
+                    ),
+                    {'snapshot': snapshot, 'e': e},
                 )
 
         if result > 0:

openstackclient/volume/v2/volume_transfer_request.py

@@ -16,10 +16,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 _
 
 
@@ -128,8 +128,8 @@ class DeleteTransferRequest(command.Command):
                     _(
                         "Failed to delete volume transfer request "
                         "with name or ID '%(transfer)s': %(e)s"
-                    )
-                    % {'transfer': t, 'e': e}
+                    ),
+                    {'transfer': t, 'e': e},
                 )
 
         if result > 0:

openstackclient/volume/v2/volume_type.py

@@ -16,14 +16,15 @@
 
 import functools
 import logging
+import typing as ty
 
 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
 
@@ -31,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
@@ -171,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)"
             ),
         )
@@ -181,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)"
             ),
         )
@@ -274,7 +277,7 @@ class CreateVolumeType(command.ShowOne):
                 msg = _(
                     "Failed to add project %(project)s access to type: %(e)s"
                 )
-                LOG.error(msg % {'project': parsed_args.project, 'e': e})
+                LOG.error(msg, {'project': parsed_args.project, 'e': e})
 
         properties = {}
         if parsed_args.properties:
@@ -355,8 +358,8 @@ class DeleteVolumeType(command.Command):
                     _(
                         "Failed to delete volume type with "
                         "name or ID '%(volume_type)s': %(e)s"
-                    )
-                    % {'volume_type': volume_type, 'e': e}
+                    ),
+                    {'volume_type': volume_type, 'e': e},
                 )
 
         if result > 0:
@@ -463,7 +466,7 @@ class ListVolumeType(command.Lister):
             _EncryptionInfoColumn = functools.partial(
                 EncryptionInfoColumn, encryption_data=encryption
             )
-            formatters['id'] = _EncryptionInfoColumn
+            formatters['id'] = _EncryptionInfoColumn  # type: ignore
 
         return (
             column_headers,
@@ -534,7 +537,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)"
             ),
         )
@@ -544,7 +548,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)"
             ),
         )
@@ -758,7 +763,7 @@ class ShowVolumeType(command.ShowOne):
                     'Failed to get access project list for volume type '
                     '%(type)s: %(e)s'
                 )
-                LOG.error(msg % {'type': volume_type.id, 'e': e})
+                LOG.error(msg, {'type': volume_type.id, 'e': e})
         volume_type._info.update({'access_project_ids': access_project_ids})
         if parsed_args.encryption_type:
             # show encryption type information for this volume type

openstackclient/volume/v3/block_storage_cleanup.py

@@ -11,9 +11,9 @@
 # under the License.
 
 from cinderclient import api_versions
-from osc_lib.command import command
 from osc_lib import exceptions
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v3/block_storage_cluster.py

@@ -11,10 +11,10 @@
 # under the License.
 
 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/block_storage_log_level.py

@@ -15,9 +15,9 @@
 """Block Storage Service action implementations"""
 
 from openstack import utils as sdk_utils
-from osc_lib.command import command
 from osc_lib import exceptions
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/volume/v3/block_storage_manage.py

@@ -16,10 +16,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.i18n import _
 
 

openstackclient/volume/v3/block_storage_resource_filter.py

@@ -14,10 +14,10 @@
 
 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.i18n import _
 
 

openstackclient/volume/v3/service.py

@@ -15,10 +15,10 @@
 """Service action implementations"""
 
 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.i18n import _