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

openstackclient/compute/v2/server.py

@@ -21,6 +21,7 @@ import getpass
 import json
 import logging
 import os
+import typing as ty
 
 from cliff import columns as cliff_columns
 import iso8601
@@ -28,11 +29,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 compute_v2
+from openstackclient import command
 from openstackclient.common import envvars
 from openstackclient.common import pagination
 from openstackclient.i18n import _
@@ -44,7 +45,7 @@ LOG = logging.getLogger(__name__)
 IMAGE_STRING_FOR_BFV = 'N/A (booted from volume)'
 
 
-class PowerStateColumn(cliff_columns.FormattableColumn):
+class PowerStateColumn(cliff_columns.FormattableColumn[int]):
     """Generate a formatted string of a server's power state."""
 
     power_states = [
@@ -65,7 +66,7 @@ class PowerStateColumn(cliff_columns.FormattableColumn):
             return 'N/A'
 
 
-class AddressesColumn(cliff_columns.FormattableColumn):
+class AddressesColumn(cliff_columns.FormattableColumn[ty.Any]):
     """Generate a formatted string of a server's addresses."""
 
     def human_readable(self):
@@ -86,7 +87,7 @@ class AddressesColumn(cliff_columns.FormattableColumn):
         }
 
 
-class HostColumn(cliff_columns.FormattableColumn):
+class HostColumn(cliff_columns.FormattableColumn[str | None]):
     """Generate a formatted string of a hostname."""
 
     def human_readable(self):
@@ -183,9 +184,17 @@ def _prep_server_detail(compute_client, image_client, server, *, refresh=True):
         'updated_at': 'updated',
         'user_data': 'OS-EXT-SRV-ATTR:user_data',
         'vm_state': 'OS-EXT-STS:vm_state',
-        'pinned_availability_zone': 'pinned_availability_zone',
-        'scheduler_hints': 'scheduler_hints',
     }
+    # NOTE(ratailor): microversion 2.96 introduces
+    # pinned_availability_zone support
+    if sdk_utils.supports_microversion(compute_client, '2.96'):
+        column_map['pinned_availability_zone'] = 'pinned_availability_zone'
+
+    # NOTE(ratailor): microversion 2.100 introduces
+    # scheduler_hints support
+    if sdk_utils.supports_microversion(compute_client, '2.100'):
+        column_map['scheduler_hints'] = 'scheduler_hints'
+
     # Some columns returned by openstacksdk should not be shown because they're
     # either irrelevant or duplicates
     ignored_columns = {
@@ -240,6 +249,11 @@ def _prep_server_detail(compute_client, image_client, server, *, refresh=True):
     if not sdk_utils.supports_microversion(compute_client, '2.100'):
         info.pop('scheduler_hints', None)
 
+    # NOTE(ratailor): microversion 2.96 introduces
+    # pinned_availability_zone support
+    if not sdk_utils.supports_microversion(compute_client, '2.96'):
+        info.pop('pinned_availability_zone', None)
+
     # Convert the image blob to a name
     image_info = info.get('image', {})
     if image_info and any(image_info.values()):
@@ -326,10 +340,11 @@ def _prep_server_detail(compute_client, image_client, server, *, refresh=True):
             info['OS-EXT-STS:power_state']
         )
 
-    if 'scheduler_hints' in info:
-        info['scheduler_hints'] = format_columns.DictListColumn(
-            info.pop('scheduler_hints', {}),
-        )
+    if sdk_utils.supports_microversion(compute_client, '2.100'):
+        if 'scheduler_hints' in info:
+            info['scheduler_hints'] = format_columns.DictListColumn(
+                info.pop('scheduler_hints', {}),
+            )
 
     return info
 
@@ -2166,7 +2181,9 @@ class CreateServerDump(command.Command):
     def take_action(self, parsed_args):
         compute_client = self.app.client_manager.compute
         for name_or_id in parsed_args.server:
-            server = compute_client.find_server(name_or_id)
+            server = compute_client.find_server(
+                name_or_id, ignore_missing=False
+            )
             server.trigger_crash_dump(compute_client)
 
 
@@ -2209,24 +2226,49 @@ class DeleteServer(command.Command):
                 self.app.stdout.flush()
 
         compute_client = self.app.client_manager.compute
+
+        deleted_servers = []
         for server in parsed_args.server:
-            server_obj = compute_client.find_server(
-                server,
-                ignore_missing=False,
-                all_projects=parsed_args.all_projects,
-            )
+            try:
+                server_obj = compute_client.find_server(
+                    server,
+                    ignore_missing=False,
+                    all_projects=parsed_args.all_projects,
+                )
 
-            compute_client.delete_server(server_obj, force=parsed_args.force)
+                compute_client.delete_server(
+                    server_obj, force=parsed_args.force
+                )
+                deleted_servers.append(server_obj)
+            except Exception as e:
+                LOG.error(
+                    _(
+                        "Failed to delete server with "
+                        "name or ID '%(server)s': %(e)s"
+                    ),
+                    {'server': server, 'e': e},
+                )
 
-            if parsed_args.wait:
+        if parsed_args.wait:
+            for server_obj in deleted_servers:
                 try:
                     compute_client.wait_for_delete(
                         server_obj, callback=_show_progress
                     )
                 except sdk_exceptions.ResourceTimeout:
                     msg = _('Error deleting server: %s') % server_obj.id
+                    deleted_servers.remove(server_obj)
                     raise exceptions.CommandError(msg)
 
+        fails = len(parsed_args.server) - len(deleted_servers)
+        if fails > 0:
+            total = len(parsed_args.server)
+            msg = _("%(fails)s of %(total)s servers failed to delete.") % {
+                'fails': fails,
+                'total': total,
+            }
+            raise exceptions.CommandError(msg)
+
 
 class PercentAction(argparse.Action):
     def __init__(
@@ -2838,18 +2880,21 @@ class ListServer(command.Lister):
         if parsed_args.long:
             columns += (
                 'availability_zone',
-                'pinned_availability_zone',
                 'hypervisor_hostname',
                 'metadata',
-                'scheduler_hints',
             )
             column_headers += (
                 'Availability Zone',
-                'Pinned Availability Zone',
                 'Host',
                 'Properties',
-                'Scheduler Hints',
             )
+            if sdk_utils.supports_microversion(compute_client, '2.96'):
+                columns += ('pinned_availability_zone',)
+                column_headers += ('Pinned Availability Zone',)
+
+            if sdk_utils.supports_microversion(compute_client, '2.100'):
+                columns += ('scheduler_hints',)
+                column_headers += ('Scheduler Hints',)
 
         if parsed_args.all_projects:
             columns += ('project_id',)
@@ -2887,10 +2932,11 @@ class ListServer(command.Lister):
                     column_headers += ('Availability Zone',)
                 if c in (
                     'pinned_availability_zone',
-                    "Pinned Availability Zone",
+                    'Pinned Availability Zone',
                 ):
-                    columns += ('Pinned Availability Zone',)
-                    column_headers += ('Pinned Availability Zone',)
+                    if sdk_utils.supports_microversion(compute_client, '2.96'):
+                        columns += ('pinned_availability_zone',)
+                        column_headers += ('Pinned Availability Zone',)
                 if c in ('Host', "host"):
                     columns += ('hypervisor_hostname',)
                     column_headers += ('Host',)
@@ -2901,8 +2947,11 @@ class ListServer(command.Lister):
                     'scheduler_hints',
                     "Scheduler Hints",
                 ):
-                    columns += ('scheduler_hints',)
-                    column_headers += ('Scheduler Hints',)
+                    if sdk_utils.supports_microversion(
+                        compute_client, '2.100'
+                    ):
+                        columns += ('scheduler_hints',)
+                        column_headers += ('Scheduler Hints',)
 
             # remove duplicates
             column_headers = tuple(dict.fromkeys(column_headers))

openstackclient/compute/v2/server_backup.py

@@ -17,10 +17,10 @@
 
 import importlib
 
-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/compute/v2/server_event.py

@@ -22,10 +22,10 @@ from cliff import columns
 import iso8601
 from openstack import exceptions as sdk_exceptions
 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 pagination
 from openstackclient.i18n import _
 

openstackclient/compute/v2/server_group.py

@@ -16,21 +16,23 @@
 """Compute v2 Server Group action implementations"""
 
 import logging
+import typing as ty
 
+from cliff import columns
 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 import command
 from openstackclient.common import pagination
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
 
 
-_formatters = {
+_formatters: dict[str, type[columns.FormattableColumn[ty.Any]]] = {
     'member_ids': format_columns.ListColumn,
     'policies': format_columns.ListColumn,
     'rules': format_columns.DictColumn,

openstackclient/compute/v2/server_image.py

@@ -19,10 +19,10 @@ import importlib
 import logging
 
 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 _
 
 

openstackclient/compute/v2/server_migration.py

@@ -15,10 +15,10 @@
 import uuid
 
 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 pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common

openstackclient/compute/v2/server_volume.py

@@ -15,10 +15,10 @@
 """Compute v2 Server 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 _
 
 

openstackclient/compute/v2/service.py

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

openstackclient/compute/v2/usage.py

@@ -15,19 +15,21 @@
 
 """Usage action implementations"""
 
+from collections.abc import Collection
 import datetime
 import functools
+import typing as ty
 
 from cliff import columns as cliff_columns
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 
 # TODO(stephenfin): This exists in a couple of places and should be moved to a
 # common module
-class ProjectColumn(cliff_columns.FormattableColumn):
+class ProjectColumn(cliff_columns.FormattableColumn[str]):
     """Formattable column for project column.
 
     Unlike the parent FormattableColumn class, the initializer of the class
@@ -53,12 +55,12 @@ class ProjectColumn(cliff_columns.FormattableColumn):
         return project
 
 
-class CountColumn(cliff_columns.FormattableColumn):
+class CountColumn(cliff_columns.FormattableColumn[Collection[ty.Any]]):
     def human_readable(self):
         return len(self._value) if self._value is not None else None
 
 
-class FloatColumn(cliff_columns.FormattableColumn):
+class FloatColumn(cliff_columns.FormattableColumn[float]):
     def human_readable(self):
         return float(f"{self._value:.2f}")
 

openstackclient/identity/common.py

@@ -99,7 +99,8 @@ def find_service_sdk(identity_client, name_type_or_id):
 
     if next(services, None):
         msg = _(
-            "Multiple service matches found for '%(query)s', use an ID to be more specific."
+            "Multiple service matches found for '%(query)s', "
+            "use an ID to be more specific."
         ) % {"query": name_type_or_id}
         raise exceptions.CommandError(msg)
 

openstackclient/identity/v2_0/catalog.py

@@ -14,19 +14,20 @@
 """Identity v2 Service Catalog action implementations"""
 
 import logging
+import typing as ty
 
 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.i18n import _
 
 
 LOG = logging.getLogger(__name__)
 
 
-class EndpointsColumn(cliff_columns.FormattableColumn):
+class EndpointsColumn(cliff_columns.FormattableColumn[ty.Any]):
     def human_readable(self):
         if not self._value:
             return ""

openstackclient/identity/v2_0/ec2creds.py

@@ -18,10 +18,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 _
 
 

openstackclient/identity/v2_0/endpoint.py

@@ -17,10 +17,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 _
 from openstackclient.identity import common
 

openstackclient/identity/v2_0/project.py

@@ -20,10 +20,10 @@ import logging
 from keystoneauth1 import exceptions as ks_exc
 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 _
 
 
@@ -59,6 +59,7 @@ class CreateProject(command.ShowOne):
         parser.add_argument(
             '--property',
             metavar='<key=value>',
+            dest='properties',
             action=parseractions.KeyValueAction,
             help=_(
                 'Add a property to <name> '
@@ -79,8 +80,8 @@ class CreateProject(command.ShowOne):
         if parsed_args.disable:
             enabled = False
         kwargs = {}
-        if parsed_args.property:
-            kwargs = parsed_args.property.copy()
+        if parsed_args.properties:
+            kwargs.update(parsed_args.properties)
 
         try:
             project = identity_client.tenants.create(
@@ -105,7 +106,14 @@ class CreateProject(command.ShowOne):
 
 
 class DeleteProject(command.Command):
-    _description = _("Delete project(s)")
+    _description = _(
+        "Delete project(s). This command will remove specified "
+        "existing project(s) if an active user is authorized to do "
+        "this. If there are resources managed by other services "
+        "(for example, Nova, Neutron, Cinder) associated with "
+        "specified project(s), delete operation will proceed "
+        "regardless."
+    )
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -223,6 +231,7 @@ class SetProject(command.Command):
         parser.add_argument(
             '--property',
             metavar='<key=value>',
+            dest='properties',
             action=parseractions.KeyValueAction,
             help=_(
                 'Set a project property '
@@ -248,8 +257,8 @@ class SetProject(command.Command):
             kwargs['enabled'] = True
         if parsed_args.disable:
             kwargs['enabled'] = False
-        if parsed_args.property:
-            kwargs.update(parsed_args.property)
+        if parsed_args.properties:
+            kwargs.update(parsed_args.properties)
         if 'id' in kwargs:
             del kwargs['id']
         if 'name' in kwargs:
@@ -331,6 +340,7 @@ class UnsetProject(command.Command):
         parser.add_argument(
             '--property',
             metavar='<key>',
+            dest='properties',
             action='append',
             default=[],
             help=_(
@@ -347,7 +357,7 @@ class UnsetProject(command.Command):
             parsed_args.project,
         )
         kwargs = project._info
-        for key in parsed_args.property:
+        for key in parsed_args.properties:
             if key in kwargs:
                 kwargs[key] = None
         identity_client.tenants.update(project.id, **kwargs)

openstackclient/identity/v2_0/role.py

@@ -18,10 +18,10 @@
 import logging
 
 from keystoneauth1 import exceptions as ks_exc
-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/identity/v2_0/role_assignment.py

@@ -13,10 +13,10 @@
 
 """Identity v2 Assignment 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 _  # noqa
 
 
@@ -68,7 +68,7 @@ class ListRoleAssignment(command.Lister):
                 parsed_args.user,
             )
         elif parsed_args.authuser:
-            if auth_ref:
+            if auth_ref and auth_ref.user_id:
                 user = utils.find_resource(
                     identity_client.users, auth_ref.user_id
                 )
@@ -80,7 +80,7 @@ class ListRoleAssignment(command.Lister):
                 parsed_args.project,
             )
         elif parsed_args.authproject:
-            if auth_ref:
+            if auth_ref and auth_ref.project_id:
                 project = utils.find_resource(
                     identity_client.projects, auth_ref.project_id
                 )

openstackclient/identity/v2_0/service.py

@@ -17,10 +17,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 _
 from openstackclient.identity import common
 

openstackclient/identity/v2_0/token.py

@@ -15,9 +15,9 @@
 
 """Identity v2 Token action implementations"""
 
-from osc_lib.command import command
 from osc_lib import exceptions
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/identity/v2_0/user.py

@@ -20,17 +20,17 @@ import logging
 
 from cliff import columns as cliff_columns
 from keystoneauth1 import exceptions as ks_exc
-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__)
 
 
-class ProjectColumn(cliff_columns.FormattableColumn):
+class ProjectColumn(cliff_columns.FormattableColumn[str]):
     """Formattable column for project column.
 
     Unlike the parent FormattableColumn class, the initializer of the

openstackclient/identity/v3/access_rule.py

@@ -17,10 +17,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 _
 from openstackclient.identity import common
 
@@ -44,7 +44,11 @@ class DeleteAccessRule(command.Command):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
         conn = self.app.client_manager.sdk_connection
-        user_id = conn.config.get_auth().get_user_id(conn.identity)
+        auth = conn.config.get_auth()
+        if auth is None:
+            # this will never happen
+            raise exceptions.CommandError('invalid authentication info')
+        user_id = auth.get_user_id(conn.identity)
 
         errors = 0
         for ac in parsed_args.access_rule:
@@ -87,7 +91,11 @@ class ListAccessRule(command.Lister):
             ).id
         else:
             conn = self.app.client_manager.sdk_connection
-            user_id = conn.config.get_auth().get_user_id(conn.identity)
+            auth = conn.config.get_auth()
+            if auth is None:
+                # this will never happen
+                raise exceptions.CommandError('invalid authentication info')
+            user_id = auth.get_user_id(conn.identity)
 
         columns = ('ID', 'Service', 'Method', 'Path')
         data = identity_client.access_rules(user=user_id)
@@ -119,7 +127,11 @@ class ShowAccessRule(command.ShowOne):
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.sdk_connection.identity
         conn = self.app.client_manager.sdk_connection
-        user_id = conn.config.get_auth().get_user_id(conn.identity)
+        auth = conn.config.get_auth()
+        if auth is None:
+            # this will never happen
+            raise exceptions.CommandError('invalid authentication info')
+        user_id = auth.get_user_id(conn.identity)
 
         access_rule = identity_client.get_access_rule(
             user_id, parsed_args.access_rule