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

openstackclient/volume/v2/volume_type.py

@@ -272,8 +272,7 @@ class CreateVolumeType(command.ShowOne):
                 )
             except Exception as e:
                 msg = _(
-                    "Failed to add project %(project)s access to "
-                    "type: %(e)s"
+                    "Failed to add project %(project)s access to type: %(e)s"
                 )
                 LOG.error(msg % {'project': parsed_args.project, 'e': e})
 
@@ -363,7 +362,7 @@ class DeleteVolumeType(command.Command):
         if result > 0:
             total = len(parsed_args.volume_types)
             msg = _(
-                "%(result)s of %(total)s volume types failed " "to delete."
+                "%(result)s of %(total)s volume types failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -553,8 +552,7 @@ class SetVolumeType(command.Command):
             '--project',
             metavar='<project>',
             help=_(
-                'Set volume type access to project (name or ID) '
-                '(admin only)'
+                'Set volume type access to project (name or ID) (admin only)'
             ),
         )
         public_group = parser.add_mutually_exclusive_group()
@@ -646,17 +644,12 @@ class SetVolumeType(command.Command):
                 volume_client.volume_types.update(volume_type.id, **kwargs)
             except Exception as e:
                 LOG.error(
-                    _(
-                        "Failed to update volume type name or"
-                        " description: %s"
-                    ),
+                    _("Failed to update volume type name or description: %s"),
                     e,
                 )
                 result += 1
 
-        properties = {}
-
-        properties = {}
+        properties: dict[str, str] = {}
         if parsed_args.properties:
             properties.update(parsed_args.properties)
         if parsed_args.multiattach:
@@ -690,7 +683,7 @@ class SetVolumeType(command.Command):
                 )
             except Exception as e:
                 LOG.error(
-                    _("Failed to set volume type access to " "project: %s"), e
+                    _("Failed to set volume type access to project: %s"), e
                 )
                 result += 1
 
@@ -714,7 +707,7 @@ class SetVolumeType(command.Command):
 
         if result > 0:
             raise exceptions.CommandError(
-                _("Command Failed: One or more of" " the operations failed")
+                _("Command Failed: One or more of the operations failed")
             )
 
 
@@ -822,8 +815,7 @@ class UnsetVolumeType(command.Command):
             "--encryption-type",
             action="store_true",
             help=_(
-                "Remove the encryption type for this volume type "
-                "(admin only)"
+                "Remove the encryption type for this volume type (admin only)"
             ),
         )
         return parser
@@ -859,10 +851,7 @@ class UnsetVolumeType(command.Command):
                 )
             except Exception as e:
                 LOG.error(
-                    _(
-                        "Failed to remove volume type access from "
-                        "project: %s"
-                    ),
+                    _("Failed to remove volume type access from project: %s"),
                     e,
                 )
                 result += 1
@@ -881,5 +870,5 @@ class UnsetVolumeType(command.Command):
 
         if result > 0:
             raise exceptions.CommandError(
-                _("Command Failed: One or more of" " the operations failed")
+                _("Command Failed: One or more of the operations failed")
             )

openstackclient/volume/v3/block_storage_cluster.py

@@ -19,13 +19,13 @@ from openstackclient.i18n import _
 
 
 def _format_cluster(cluster, detailed=False):
-    columns = (
+    columns: tuple[str, ...] = (
         'name',
         'binary',
         'state',
         'status',
     )
-    column_headers = (
+    column_headers: tuple[str, ...] = (
         'Name',
         'Binary',
         'State',
@@ -147,7 +147,7 @@ class ListBlockStorageCluster(command.Lister):
             )
             raise exceptions.CommandError(msg)
 
-        columns = ('Name', 'Binary', 'State', 'Status')
+        columns: tuple[str, ...] = ('Name', 'Binary', 'State', 'Status')
         if parsed_args.long:
             columns += (
                 'Num Hosts',

openstackclient/volume/v3/block_storage_manage.py

@@ -317,9 +317,7 @@ class BlockStorageManageSnapshots(command.Lister):
                 # if the user requested e.g. '--detailed false' then they
                 # should simply stop requesting this since the default has
                 # changed
-                msg = _(
-                    "The --detailed option has been deprecated. " "Unset it."
-                )
+                msg = _("The --detailed option has been deprecated. Unset it.")
                 self.log.warning(msg)
 
         columns = [

openstackclient/volume/v3/volume.py

@@ -309,8 +309,7 @@ class CreateVolume(volume_v2.CreateVolume):
                     )
                 else:
                     msg = _(
-                        "Volume status is not available for setting boot "
-                        "state"
+                        "Volume status is not available for setting boot state"
                     )
                     raise exceptions.CommandError(msg)
             except Exception as e:
@@ -335,10 +334,7 @@ class CreateVolume(volume_v2.CreateVolume):
                     raise exceptions.CommandError(msg)
             except Exception as e:
                 LOG.error(
-                    _(
-                        "Failed to set volume read-only access "
-                        "mode flag: %s"
-                    ),
+                    _("Failed to set volume read-only access mode flag: %s"),
                     e,
                 )
 
@@ -402,7 +398,7 @@ class DeleteVolume(volume_v2.DeleteVolume):
 
         if result > 0:
             total = len(parsed_args.volumes)
-            msg = _("%(result)s of %(total)s volumes failed " "to delete.") % {
+            msg = _("%(result)s of %(total)s volumes failed to delete.") % {
                 'result': result,
                 'total': total,
             }
@@ -523,7 +519,7 @@ class ListVolume(command.Lister):
         server_cache = {}
         if do_server_list:
             try:
-                compute_client = self.app.client_manager.sdk_connection.compute
+                compute_client = self.app.client_manager.compute
                 for s in compute_client.servers():
                     server_cache[s.id] = s
             except sdk_exceptions.SDKException:  # noqa: S110
@@ -768,18 +764,24 @@ class SetVolume(command.Command):
                         _("New size must be greater than %s GB") % volume.size
                     )
                     raise exceptions.CommandError(msg)
-                if (
-                    volume.status != 'available'
-                    and not volume_client.api_version.matches('3.42')
-                ):
+                if volume.status not in ('available', 'in-use'):
                     msg = (
                         _(
                             "Volume is in %s state, it must be available "
-                            "before size can be extended"
+                            "or in-use before size can be extended."
                         )
                         % volume.status
                     )
                     raise exceptions.CommandError(msg)
+                if (
+                    volume.status == 'in-use'
+                    and not volume_client.api_version.matches('3.42')
+                ):
+                    msg = _(
+                        "--os-volume-api-version 3.42 or greater is "
+                        "required to extend in-use volumes."
+                    )
+                    raise exceptions.CommandError(msg)
                 volume_client.volumes.extend(volume.id, parsed_args.size)
             except Exception as e:
                 LOG.error(_("Failed to set volume size: %s"), e)
@@ -847,10 +849,7 @@ class SetVolume(command.Command):
                 )
             except Exception as e:
                 LOG.error(
-                    _(
-                        "Failed to set volume read-only access "
-                        "mode flag: %s"
-                    ),
+                    _("Failed to set volume read-only access mode flag: %s"),
                     e,
                 )
                 result += 1
@@ -903,7 +902,7 @@ class SetVolume(command.Command):
 
         if result > 0:
             raise exceptions.CommandError(
-                _("One or more of the " "set operations failed")
+                _("One or more of the set operations failed")
             )
 
 
@@ -995,7 +994,7 @@ class UnsetVolume(command.Command):
 
         if result > 0:
             raise exceptions.CommandError(
-                _("One or more of the " "unset operations failed")
+                _("One or more of the unset operations failed")
             )
 
 

openstackclient/volume/v3/volume_attachment.py

@@ -18,6 +18,7 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import envvars
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
@@ -171,7 +172,7 @@ class CreateVolumeAttachment(command.ShowOne):
 
     def take_action(self, parsed_args):
         volume_client = self.app.client_manager.sdk_connection.volume
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(volume_client, '3.27'):
             msg = _(
@@ -399,7 +400,7 @@ class ListVolumeAttachment(command.Lister):
             '--all-projects',
             dest='all_projects',
             action='store_true',
-            default=utils.env('ALL_PROJECTS', default=False),
+            default=envvars.boolenv('ALL_PROJECTS'),
             help=_('Shows details for all projects (admin only).'),
         )
         parser.add_argument(

openstackclient/volume/v3/volume_backup.py

@@ -162,7 +162,7 @@ class CreateVolumeBackup(command.ShowOne):
 
             kwargs['availability_zone'] = parsed_args.availability_zone
 
-        columns = (
+        columns: tuple[str, ...] = (
             "id",
             "name",
             "volume_id",
@@ -298,7 +298,7 @@ class ListVolumeBackup(command.Lister):
     def take_action(self, parsed_args):
         volume_client = self.app.client_manager.sdk_connection.volume
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'name',
             'description',
@@ -307,7 +307,7 @@ class ListVolumeBackup(command.Lister):
             'is_incremental',
             'created_at',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'ID',
             'Name',
             'Description',
@@ -403,8 +403,7 @@ class RestoreVolumeBackup(command.ShowOne):
             "--force",
             action="store_true",
             help=_(
-                "Restore the backup to an existing volume "
-                "(default to False)"
+                "Restore the backup to an existing volume (default to False)"
             ),
         )
         return parser
@@ -412,7 +411,7 @@ class RestoreVolumeBackup(command.ShowOne):
     def take_action(self, parsed_args):
         volume_client = self.app.client_manager.sdk_connection.volume
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'volume_id',
             'volume_name',
@@ -466,7 +465,7 @@ class SetVolumeBackup(command.Command):
             '--name',
             metavar='<name>',
             help=_(
-                'New backup name'
+                'New backup name '
                 '(supported by --os-volume-api-version 3.9 or above)'
             ),
         )
@@ -655,7 +654,7 @@ 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)
-        columns = (
+        columns: tuple[str, ...] = (
             "availability_zone",
             "container",
             "created_at",

openstackclient/volume/v3/volume_group.py

@@ -17,6 +17,7 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import envvars
 from openstackclient.i18n import _
 
 
@@ -410,7 +411,7 @@ class ListVolumeGroup(command.Lister):
             '--all-projects',
             dest='all_projects',
             action='store_true',
-            default=utils.env('ALL_PROJECTS', default=False),
+            default=envvars.boolenv('ALL_PROJECTS'),
             help=_('Shows details for all projects (admin only).'),
         )
         # TODO(stephenfin): Add once we have an equivalent command for

openstackclient/volume/v3/volume_group_snapshot.py

@@ -17,6 +17,7 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import envvars
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
@@ -145,7 +146,7 @@ class ListVolumeGroupSnapshot(command.Lister):
             '--all-projects',
             dest='all_projects',
             action='store_true',
-            default=utils.env('ALL_PROJECTS', default=False),
+            default=envvars.boolenv('ALL_PROJECTS'),
             help=_('Shows details for all projects (admin only).'),
         )
         # TODO(stephenfin): Add once we have an equivalent command for

openstackclient/volume/v3/volume_snapshot.py

@@ -91,7 +91,8 @@ class DeleteVolumeSnapshot(command.Command):
 
         if result > 0:
             total = len(parsed_args.snapshots)
-            msg = _(
-                "%(result)s of %(total)s snapshots failed " "to delete."
-            ) % {'result': result, 'total': total}
+            msg = _("%(result)s of %(total)s snapshots failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)

openstackclient/volume/v3/volume_type.py

@@ -273,8 +273,7 @@ class CreateVolumeType(command.ShowOne):
                 )
             except Exception as e:
                 msg = _(
-                    "Failed to add project %(project)s access to "
-                    "type: %(e)s"
+                    "Failed to add project %(project)s access to type: %(e)s"
                 )
                 LOG.error(msg % {'project': parsed_args.project, 'e': e})
 
@@ -364,7 +363,7 @@ class DeleteVolumeType(command.Command):
         if result > 0:
             total = len(parsed_args.volume_types)
             msg = _(
-                "%(result)s of %(total)s volume types failed " "to delete."
+                "%(result)s of %(total)s volume types failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -635,8 +634,7 @@ class SetVolumeType(command.Command):
             '--project',
             metavar='<project>',
             help=_(
-                'Set volume type access to project (name or ID) '
-                '(admin only)'
+                'Set volume type access to project (name or ID) (admin only)'
             ),
         )
         public_group = parser.add_mutually_exclusive_group()
@@ -728,17 +726,12 @@ class SetVolumeType(command.Command):
                 volume_client.volume_types.update(volume_type.id, **kwargs)
             except Exception as e:
                 LOG.error(
-                    _(
-                        "Failed to update volume type name or"
-                        " description: %s"
-                    ),
+                    _("Failed to update volume type name or description: %s"),
                     e,
                 )
                 result += 1
 
-        properties = {}
-
-        properties = {}
+        properties: dict[str, str] = {}
         if parsed_args.properties:
             properties.update(parsed_args.properties)
         if parsed_args.multiattach:
@@ -772,7 +765,7 @@ class SetVolumeType(command.Command):
                 )
             except Exception as e:
                 LOG.error(
-                    _("Failed to set volume type access to " "project: %s"), e
+                    _("Failed to set volume type access to project: %s"), e
                 )
                 result += 1
 
@@ -796,7 +789,7 @@ class SetVolumeType(command.Command):
 
         if result > 0:
             raise exceptions.CommandError(
-                _("Command Failed: One or more of" " the operations failed")
+                _("Command Failed: One or more of the operations failed")
             )
 
 
@@ -904,8 +897,7 @@ class UnsetVolumeType(command.Command):
             "--encryption-type",
             action="store_true",
             help=_(
-                "Remove the encryption type for this volume type "
-                "(admin only)"
+                "Remove the encryption type for this volume type (admin only)"
             ),
         )
         return parser
@@ -941,10 +933,7 @@ class UnsetVolumeType(command.Command):
                 )
             except Exception as e:
                 LOG.error(
-                    _(
-                        "Failed to remove volume type access from "
-                        "project: %s"
-                    ),
+                    _("Failed to remove volume type access from project: %s"),
                     e,
                 )
                 result += 1
@@ -963,5 +952,5 @@ class UnsetVolumeType(command.Command):
 
         if result > 0:
             raise exceptions.CommandError(
-                _("Command Failed: One or more of" " the operations failed")
+                _("Command Failed: One or more of the operations failed")
             )

{python_openstackclient-7.3.1.dist-info → python_openstackclient-8.0.0.dist-info}/AUTHORS

@@ -107,11 +107,13 @@ Dina Belova <dbelova@mirantis.com>
 Dirk Mueller <dirk@dmllr.de>
 Diwei Zhu <zhu.diw@northeastern.edu>
 Dmitrii Shcherbakov <dmitrii.shcherbakov@canonical.com>
+Dmitriy Chubinidze <dcu995@gmail.com>
 Dmitriy Rabotyagov <drabotyagov@vexxhost.com>
 Dmitriy Rabotyagov <noonedeadpunk@ya.ru>
 Dmitry Tantsur <dtantsur@protonmail.com>
 Dolph Mathews <dolph.mathews@gmail.com>
 Dongcan Ye <hellochosen@gmail.com>
+Doug Goldstein <cardoe@cardoe.com>
 Doug Hellmann <doug.hellmann@dreamhost.com>
 Doug Hellmann <doug@doughellmann.com>
 Doug Wiegley <dwiegley@salesforce.com>
@@ -176,6 +178,7 @@ Ilya Popov <ilya_p@hotmail.com>
 Imtiaz Chowdhury <imtiaz.chowdhury@workday.com>
 Inessa Vasilevskaya <ivasilevskaya@mirantis.com>
 Iswarya_Vakati <v.iswarya@nectechnologies.in>
+Ivan Anfimov <lazekteam@gmail.com>
 Ivan Kolodyazhny <e0ne@e0ne.info>
 JAE YONG LEE <jaeljy135@gmail.com>
 JIHOJU <jihoju96@gmail.com>
@@ -424,6 +427,7 @@ Violet Kurtz <vi.kurtz@protonmail.com>
 Violet Kurtz <vikurtz@osuosl.org>
 Vishakha Agarwal <agarwalvishakha18@gmail.com>
 Vladimir Eremin <yottatsa@yandex-team.ru>
+Vladimir Kozhukalov <kozhukalov@gmail.com>
 Vu Cong Tuan <tuanvc@vn.fujitsu.com>
 Wenran Xiao <xiaowenran@unitedstack.com>
 Wenzhi Yu <wenzhi_yu@163.com>

{python_openstackclient-7.3.1.dist-info → python_openstackclient-8.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-openstackclient
-Version: 7.3.1
+Version: 8.0.0
 Summary: OpenStack Command-line Client
 Home-page: https://docs.openstack.org/python-openstackclient/latest/
 Author: OpenStack
@@ -17,6 +17,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: AUTHORS
 Requires-Dist: pbr !=2.1.0,>=2.0.0
@@ -35,11 +36,6 @@ Requires-Dist: stevedore >=2.0.1
 Team and repository tags
 ========================
 
-.. image:: https://governance.openstack.org/tc/badges/python-openstackclient.svg
-    :target: https://governance.openstack.org/tc/reference/tags/index.html
-
-.. Change things from this point on
-
 ===============
 OpenStackClient
 ===============
@@ -81,12 +77,12 @@ Getting Started
 
 OpenStack Client can be installed from PyPI using pip::
 
-    pip install python-openstackclient
+    python3 -m pip install python-openstackclient
 
 There are a few variants on getting help.  A list of global options and supported
 commands is shown with ``--help``::
 
-   openstack --help
+    openstack --help
 
 There is also a ``help`` command that can be used to get help text for a specific
 command::
@@ -97,11 +93,9 @@ command::
 If you want to make changes to the OpenStackClient for testing and contribution,
 make any changes and then run::
 
-    python setup.py develop
-
-or::
-
-    pip install -e .
+    git clone https://opendev.org/openstack/python-openstackclient
+    cd python-openstackclient
+    python3 -m pip install -e .
 
 Configuration
 =============