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

openstackclient/volume/v3/volume.py

@@ -26,11 +26,11 @@ 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
@@ -62,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
@@ -515,12 +515,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',
+        )
         parser.add_argument(
             '--remote',
             action='store_true',
@@ -532,9 +539,9 @@ class DeleteVolume(command.Command):
         volume_client = self.app.client_manager.sdk_connection.volume
         result = 0
 
-        if parsed_args.remote and (parsed_args.force or parsed_args.purge):
+        if parsed_args.remote and (parsed_args.force or parsed_args.cascade):
             msg = _(
-                "The --force and --purge options are not "
+                "The --force and --cascade options are not "
                 "supported with the --remote parameter."
             )
             raise exceptions.CommandError(msg)
@@ -550,7 +557,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
@@ -1071,12 +1078,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/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
@@ -218,8 +218,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:
@@ -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 _
 

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
@@ -246,8 +246,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/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 _
 
 
@@ -163,8 +163,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/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)"
             ),
         )
@@ -275,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:
@@ -356,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:
@@ -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)"
             ),
         )
@@ -545,7 +549,7 @@ class ListVolumeType(command.Lister):
             _EncryptionInfoColumn = functools.partial(
                 EncryptionInfoColumn, encryption_data=encryption
             )
-            formatters['id'] = _EncryptionInfoColumn
+            formatters['id'] = _EncryptionInfoColumn  # type: ignore
 
         return (
             column_headers,
@@ -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)"
             ),
         )
@@ -840,7 +846,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

{python_openstackclient-8.2.0.dist-info → python_openstackclient-9.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: python-openstackclient
-Version: 8.2.0
+Version: 9.0.0
 Summary: OpenStack Command-line Client
 Author-email: OpenStack <openstack-discuss@lists.openstack.org>
 License: Apache-2.0
@@ -21,17 +21,19 @@ Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: AUTHORS
-Requires-Dist: pbr !=2.1.0,>=2.0.0
-Requires-Dist: cryptography >=2.7
-Requires-Dist: cliff >=4.8.0
-Requires-Dist: iso8601 >=0.1.11
-Requires-Dist: openstacksdk >=4.6.0
-Requires-Dist: osc-lib >=2.3.0
-Requires-Dist: oslo.i18n >=3.15.3
-Requires-Dist: python-keystoneclient >=3.22.0
-Requires-Dist: python-cinderclient >=3.3.0
-Requires-Dist: requests >=2.27.0
-Requires-Dist: stevedore >=2.0.1
+Requires-Dist: pbr!=2.1.0,>=2.0.0
+Requires-Dist: cryptography>=2.7
+Requires-Dist: cliff>=4.13.0
+Requires-Dist: iso8601>=0.1.11
+Requires-Dist: openstacksdk>=4.6.0
+Requires-Dist: osc-lib>=2.3.0
+Requires-Dist: oslo.i18n>=3.15.3
+Requires-Dist: python-keystoneclient>=3.22.0
+Requires-Dist: python-cinderclient>=3.3.0
+Requires-Dist: requests>=2.27.0
+Requires-Dist: stevedore>=2.0.1
+Dynamic: license-file
+Dynamic: requires-dist
 
 ===============
 OpenStackClient