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

openstackclient/compute/v2/server_backup.py

@@ -71,7 +71,7 @@ class CreateServerBackup(command.ShowOne):
                 self.app.stderr.write(f'\rProgress: {progress}')
                 self.app.stderr.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False

openstackclient/compute/v2/server_event.py

@@ -65,17 +65,11 @@ class ServerActionEventColumn(columns.FormattableColumn):
     """
 
     def _format_event(self, event):
-        column_map = {}
         hidden_columns = ['id', 'name', 'location']
         _, columns = utils.get_osc_show_columns_for_sdk_resource(
-            event,
-            column_map,
-            hidden_columns,
-        )
-        data = utils.get_item_properties(
-            event,
-            columns,
+            event, {}, hidden_columns
         )
+        data = utils.get_item_properties(event, columns)
         return dict(zip(columns, data))
 
     def human_readable(self):
@@ -88,17 +82,14 @@ class ServerActionEventColumn(columns.FormattableColumn):
 
 
 def _get_server_event_columns(item, client):
-    column_map = {}
-    hidden_columns = ['name', 'server_id', 'links', 'location']
+    hidden_columns = ['name', 'server_id', 'links', 'location', 'finish_time']
 
     if not sdk_utils.supports_microversion(client, '2.58'):
         # updated_at was introduced in 2.58
         hidden_columns.append('updated_at')
 
     return utils.get_osc_show_columns_for_sdk_resource(
-        item,
-        column_map,
-        hidden_columns,
+        item, {}, hidden_columns
     )
 
 
@@ -148,7 +139,7 @@ class ListServerEvent(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         kwargs = {}
 
@@ -220,13 +211,13 @@ class ListServerEvent(command.Lister):
 
         data = compute_client.server_actions(server_id, **kwargs)
 
-        columns = (
+        columns: tuple[str, ...] = (
             'request_id',
             'server_id',
             'action',
             'start_time',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'Request ID',
             'Server ID',
             'Action',
@@ -275,7 +266,7 @@ class ShowServerEvent(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         try:
             server_id = compute_client.find_server(

openstackclient/compute/v2/server_group.py

@@ -93,7 +93,7 @@ class CreateServerGroup(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         if parsed_args.policy in ('soft-affinity', 'soft-anti-affinity'):
             if not sdk_utils.supports_microversion(compute_client, '2.15'):
@@ -153,7 +153,7 @@ class DeleteServerGroup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         result = 0
         for group in parsed_args.server_group:
             try:
@@ -197,7 +197,7 @@ class ListServerGroup(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         kwargs = {}
 
@@ -216,12 +216,12 @@ class ListServerGroup(command.Lister):
         if sdk_utils.supports_microversion(compute_client, '2.64'):
             policy_key = 'Policy'
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'name',
             policy_key.lower(),
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'ID',
             'Name',
             policy_key,
@@ -264,7 +264,7 @@ class ShowServerGroup(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         group = compute_client.find_server_group(
             parsed_args.server_group, ignore_missing=False
         )

openstackclient/compute/v2/server_image.py

@@ -72,7 +72,7 @@ class CreateServerImage(command.ShowOne):
                 self.app.stdout.write(f'\rProgress: {progress}')
                 self.app.stdout.flush()
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         image_client = self.app.client_manager.image
 
         server = compute_client.find_server(

openstackclient/compute/v2/server_migration.py

@@ -154,7 +154,7 @@ class ListMigration(command.Lister):
         )
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         identity_client = self.app.client_manager.identity
 
         search_opts = {}
@@ -289,7 +289,7 @@ class ShowMigration(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(compute_client, '2.24'):
             msg = _(
@@ -333,7 +333,7 @@ class ShowMigration(command.ShowOne):
                 ignore_missing=False,
             )
 
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'ID',
             'Server UUID',
             'Status',
@@ -352,7 +352,7 @@ class ShowMigration(command.ShowOne):
             'Updated At',
         )
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'server_id',
             'status',
@@ -404,7 +404,7 @@ class AbortMigration(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(compute_client, '2.24'):
             msg = _(
@@ -469,7 +469,7 @@ class ForceCompleteMigration(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(compute_client, '2.22'):
             msg = _(

openstackclient/compute/v2/server_volume.py

@@ -34,7 +34,7 @@ class ListServerVolume(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             parsed_args.server,
@@ -42,8 +42,8 @@ class ListServerVolume(command.Lister):
         )
         volumes = compute_client.volume_attachments(server)
 
-        columns = ()
-        column_headers = ()
+        columns: tuple[str, ...] = ()
+        column_headers: tuple[str, ...] = ()
 
         if not sdk_utils.supports_microversion(compute_client, '2.89'):
             columns += ('id',)
@@ -114,7 +114,7 @@ class SetServerVolume(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         volume_client = self.app.client_manager.sdk_connection.volume
 
         if parsed_args.delete_on_termination is not None:

openstackclient/compute/v2/service.py

@@ -52,7 +52,7 @@ class DeleteService(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         result = 0
         for s in parsed_args.service:
             try:
@@ -70,7 +70,7 @@ class DeleteService(command.Command):
         if result > 0:
             total = len(parsed_args.service)
             msg = _(
-                "%(result)s of %(total)s compute services failed " "to delete."
+                "%(result)s of %(total)s compute services failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -108,8 +108,8 @@ deployment."""
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
-        columns = (
+        compute_client = self.app.client_manager.compute
+        columns: tuple[str, ...] = (
             "id",
             "binary",
             "host",
@@ -118,7 +118,7 @@ deployment."""
             "state",
             "updated_at",
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             "ID",
             "Binary",
             "Host",
@@ -153,8 +153,7 @@ class SetService(command.Command):
             "service",
             metavar="<service>",
             help=_(
-                "Name of service (Binary name), for example "
-                "``nova-compute``"
+                "Name of service (Binary name), for example ``nova-compute``"
             ),
         )
         enabled_group = parser.add_mutually_exclusive_group()
@@ -222,7 +221,7 @@ class SetService(command.Command):
         return services[0]
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         if (
             parsed_args.enable or not parsed_args.disable
@@ -281,9 +280,7 @@ class SetService(command.Command):
             force_down = False
         if force_down is not None:
             if not sdk_utils.supports_microversion(compute_client, '2.11'):
-                msg = _(
-                    '--os-compute-api-version 2.11 or later is ' 'required'
-                )
+                msg = _('--os-compute-api-version 2.11 or later is required')
                 raise exceptions.CommandError(msg)
             try:
                 compute_client.update_service_forced_down(
@@ -299,7 +296,6 @@ class SetService(command.Command):
 
         if result > 0:
             msg = _(
-                "Compute service %(service)s of host %(host)s failed to "
-                "set."
+                "Compute service %(service)s of host %(host)s failed to set."
             ) % {"service": parsed_args.service, "host": parsed_args.host}
             raise exceptions.CommandError(msg)

openstackclient/compute/v2/usage.py

@@ -115,8 +115,7 @@ class ListUsage(command.Lister):
             metavar="<start>",
             default=None,
             help=_(
-                "Usage range start date, ex 2012-01-20"
-                " (default: 4 weeks ago)"
+                "Usage range start date, ex 2012-01-20 (default: 4 weeks ago)"
             ),
         )
         parser.add_argument(
@@ -136,7 +135,7 @@ class ListUsage(command.Lister):
             else:
                 return project
 
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         columns = (
             "project_id",
             "server_usages",
@@ -222,8 +221,7 @@ class ShowUsage(command.ShowOne):
             metavar="<start>",
             default=None,
             help=_(
-                "Usage range start date, ex 2012-01-20"
-                " (default: 4 weeks ago)"
+                "Usage range start date, ex 2012-01-20 (default: 4 weeks ago)"
             ),
         )
         parser.add_argument(
@@ -236,7 +234,7 @@ class ShowUsage(command.ShowOne):
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.identity
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         date_cli_format = "%Y-%m-%d"
         now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
 

openstackclient/identity/client.py

@@ -11,7 +11,6 @@
 #   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #   License for the specific language governing permissions and limitations
 #   under the License.
-#
 
 import logging
 
@@ -20,9 +19,9 @@ from osc_lib import utils
 
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
+# global variables used when building the shell
 DEFAULT_API_VERSION = '3'
 API_VERSION_OPTION = 'os_identity_api_version'
 API_NAME = 'identity'
@@ -64,8 +63,7 @@ def build_option_parser(parser):
         metavar='<identity-api-version>',
         default=utils.env('OS_IDENTITY_API_VERSION'),
         help=_(
-            'Identity API version, default=%s '
-            '(Env: OS_IDENTITY_API_VERSION)'
+            'Identity API version, default=%s (Env: OS_IDENTITY_API_VERSION)'
         )
         % DEFAULT_API_VERSION,
     )

openstackclient/identity/common.py

@@ -88,23 +88,22 @@ def find_service_sdk(identity_client, name_type_or_id):
         raise exceptions.CommandError(e.message)
 
     # search for service type
-    services = identity_client.services()
-    result = None
-    for service in services:
-        if name_type_or_id == service.type:
-            if result:
-                msg = _(
-                    "Multiple service matches found for '%s', "
-                    "use an ID or name to be more specific."
-                )
-                raise exceptions.CommandError(msg % name_type_or_id)
-            result = service
-
-    if result is None:
-        msg = _("No service with a type, name or ID of '%s' exists.")
-        raise exceptions.CommandError(msg % name_type_or_id)
+    services = identity_client.services(type=name_type_or_id)
+    try:
+        service = next(services)
+    except StopIteration:
+        msg = _(
+            "No service with a type, name or ID of '%(query)s' exists."
+        ) % {"query": name_type_or_id}
+        raise exceptions.CommandError(msg)
 
-    return result
+    if next(services, None):
+        msg = _(
+            "Multiple service matches found for '%(query)s', use an ID to be more specific."
+        ) % {"query": name_type_or_id}
+        raise exceptions.CommandError(msg)
+
+    return service
 
 
 def get_resource(manager, name_type_or_id):
@@ -190,6 +189,16 @@ def find_domain(identity_client, name_or_id):
     )
 
 
+def find_domain_id_sdk(
+    identity_client, name_or_id, *, validate_actor_existence=True
+):
+    return _find_sdk_id(
+        identity_client.find_domain,
+        name_or_id=name_or_id,
+        validate_actor_existence=validate_actor_existence,
+    )
+
+
 def find_group(identity_client, name_or_id, domain_name_or_id=None):
     if domain_name_or_id is None:
         return _find_identity_resource(
@@ -205,6 +214,33 @@ def find_group(identity_client, name_or_id, domain_name_or_id=None):
     )
 
 
+def find_group_id_sdk(
+    identity_client,
+    name_or_id,
+    domain_name_or_id=None,
+    *,
+    validate_actor_existence=True,
+):
+    if domain_name_or_id is None:
+        return _find_sdk_id(
+            identity_client.find_group,
+            name_or_id=name_or_id,
+            validate_actor_existence=validate_actor_existence,
+        )
+
+    domain_id = find_domain_id_sdk(
+        identity_client,
+        name_or_id=domain_name_or_id,
+        validate_actor_existence=validate_actor_existence,
+    )
+    return _find_sdk_id(
+        identity_client.find_group,
+        name_or_id=name_or_id,
+        validate_actor_existence=validate_actor_existence,
+        domain_id=domain_id,
+    )
+
+
 def find_project(identity_client, name_or_id, domain_name_or_id=None):
     if domain_name_or_id is None:
         return _find_identity_resource(
@@ -230,6 +266,32 @@ def find_user(identity_client, name_or_id, domain_name_or_id=None):
     )
 
 
+def find_user_id_sdk(
+    identity_client,
+    name_or_id,
+    domain_name_or_id=None,
+    *,
+    validate_actor_existence=True,
+):
+    if domain_name_or_id is None:
+        return _find_sdk_id(
+            identity_client.find_user,
+            name_or_id=name_or_id,
+            validate_actor_existence=validate_actor_existence,
+        )
+    domain_id = find_domain_id_sdk(
+        identity_client,
+        name_or_id=domain_name_or_id,
+        validate_actor_existence=validate_actor_existence,
+    )
+    return _find_sdk_id(
+        identity_client.find_user,
+        name_or_id=name_or_id,
+        validate_actor_existence=validate_actor_existence,
+        domain_id=domain_id,
+    )
+
+
 def _find_identity_resource(
     identity_client_manager, name_or_id, resource_type, **kwargs
 ):
@@ -270,6 +332,22 @@ def _find_identity_resource(
     return resource_type(None, {'id': name_or_id, 'name': name_or_id})
 
 
+def _find_sdk_id(
+    find_command, name_or_id, *, validate_actor_existence=True, **kwargs
+):
+    try:
+        resource = find_command(
+            name_or_id=name_or_id, ignore_missing=False, **kwargs
+        )
+    except sdk_exceptions.ForbiddenException:
+        return name_or_id
+    except sdk_exceptions.ResourceNotFound as exc:
+        if not validate_actor_existence:
+            return name_or_id
+        raise exceptions.CommandError from exc
+    return resource.id
+
+
 def get_immutable_options(parsed_args):
     options = {}
     if parsed_args.immutable:
@@ -335,7 +413,7 @@ def add_inherited_option_to_parser(parser):
         action='store_true',
         default=False,
         help=_(
-            'Specifies if the role grant is inheritable to the sub ' 'projects'
+            'Specifies if the role grant is inheritable to the sub projects'
         ),
     )
 

openstackclient/identity/v2_0/ec2creds.py

@@ -128,9 +128,10 @@ class DeleteEC2Creds(command.Command):
 
         if result > 0:
             total = len(parsed_args.access_keys)
-            msg = _(
-                "%(result)s of %(total)s EC2 keys failed " "to delete."
-            ) % {'result': result, 'total': total}
+            msg = _("%(result)s of %(total)s EC2 keys failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 

openstackclient/identity/v2_0/endpoint.py

@@ -111,9 +111,10 @@ class DeleteEndpoint(command.Command):
 
         if result > 0:
             total = len(parsed_args.endpoints)
-            msg = _(
-                "%(result)s of %(total)s endpoints failed " "to delete."
-            ) % {'result': result, 'total': total}
+            msg = _("%(result)s of %(total)s endpoints failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 
@@ -132,18 +133,19 @@ class ListEndpoint(command.Lister):
 
     def take_action(self, parsed_args):
         identity_client = self.app.client_manager.identity
+
+        columns: tuple[str, ...] = (
+            'ID',
+            'Region',
+            'Service Name',
+            'Service Type',
+        )
         if parsed_args.long:
-            columns = (
-                'ID',
-                'Region',
-                'Service Name',
-                'Service Type',
+            columns += (
                 'PublicURL',
                 'AdminURL',
                 'InternalURL',
             )
-        else:
-            columns = ('ID', 'Region', 'Service Name', 'Service Type')
         data = identity_client.endpoints.list()
 
         for ep in data:

openstackclient/identity/v2_0/project.py

@@ -140,9 +140,10 @@ class DeleteProject(command.Command):
 
         if errors > 0:
             total = len(parsed_args.projects)
-            msg = _(
-                "%(errors)s of %(total)s projects failed " "to delete."
-            ) % {'errors': errors, 'total': total}
+            msg = _("%(errors)s of %(total)s projects failed to delete.") % {
+                'errors': errors,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 
@@ -169,10 +170,9 @@ class ListProject(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
+        columns: tuple[str, ...] = ('ID', 'Name')
         if parsed_args.long:
-            columns = ('ID', 'Name', 'Description', 'Enabled')
-        else:
-            columns = ('ID', 'Name')
+            columns += ('Description', 'Enabled')
         data = self.app.client_manager.identity.tenants.list()
         if parsed_args.sort:
             data = utils.sort_items(data, parsed_args.sort)

openstackclient/identity/v2_0/role.py

@@ -143,7 +143,7 @@ class DeleteRole(command.Command):
 
         if errors > 0:
             total = len(parsed_args.roles)
-            msg = _("%(errors)s of %(total)s roles failed " "to delete.") % {
+            msg = _("%(errors)s of %(total)s roles failed to delete.") % {
                 'errors': errors,
                 'total': total,
             }

openstackclient/identity/v2_0/service.py

@@ -100,9 +100,10 @@ class DeleteService(command.Command):
 
         if result > 0:
             total = len(parsed_args.services)
-            msg = _(
-                "%(result)s of %(total)s services failed " "to delete."
-            ) % {'result': result, 'total': total}
+            msg = _("%(result)s of %(total)s services failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 
@@ -120,10 +121,9 @@ class ListService(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
+        columns: tuple[str, ...] = ('ID', 'Name', 'Type')
         if parsed_args.long:
-            columns = ('ID', 'Name', 'Type', 'Description')
-        else:
-            columns = ('ID', 'Name', 'Type')
+            columns += ('Description',)
         data = self.app.client_manager.identity.services.list()
         return (
             columns,
@@ -164,7 +164,7 @@ class ShowService(command.ShowOne):
                     return zip(*sorted(info.items()))
 
             msg = _(
-                "No service catalog with a type, name or ID of '%s' " "exists."
+                "No service catalog with a type, name or ID of '%s' exists."
             ) % (parsed_args.service)
             raise exceptions.CommandError(msg)
         else: