python-openstackclient 6.6.1__py3-none-any.whl → 7.0.0__py3-none-any.whl

openstackclient/identity/v3/user.py

@@ -18,7 +18,7 @@
 import copy
 import logging
 
-from keystoneauth1 import exceptions as ks_exc
+from openstack import exceptions as sdk_exc
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
@@ -30,6 +30,33 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
+def _format_user(user):
+    columns = (
+        'default_project_id',
+        'domain_id',
+        'email',
+        'is_enabled',
+        'id',
+        'name',
+        'description',
+        'password_expires_at',
+    )
+    column_headers = (
+        'default_project_id',
+        'domain_id',
+        'email',
+        'enabled',
+        'id',
+        'name',
+        'description',
+        'password_expires_at',
+    )
+    return (
+        column_headers,
+        utils.get_item_properties(user, columns),
+    )
+
+
 def _get_options_for_user(identity_client, parsed_args):
     options = {}
     if parsed_args.ignore_lockout_failure_attempts:
@@ -161,7 +188,7 @@ class CreateUser(command.ShowOne):
     _description = _("Create new user")
 
     def get_parser(self, prog_name):
-        parser = super(CreateUser, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'name',
             metavar='<name>',
@@ -220,25 +247,26 @@ class CreateUser(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-
-        project_id = None
-        if parsed_args.project:
-            project_id = common.find_project(
-                identity_client,
-                parsed_args.project,
-                parsed_args.project_domain,
-            ).id
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         domain_id = None
         if parsed_args.domain:
-            domain_id = common.find_domain(
-                identity_client, parsed_args.domain
+            domain_id = identity_client.find_domain(
+                name_or_id=parsed_args.domain,
+                ignore_missing=False,
             ).id
 
-        enabled = True
+        project_id = None
+        if parsed_args.project:
+            project_id = identity_client.find_project(
+                name_or_id=parsed_args.project,
+                ignore_missing=False,
+                domain_id=domain_id,
+            ).id
+
+        is_enabled = True
         if parsed_args.disable:
-            enabled = False
+            is_enabled = False
         if parsed_args.password_prompt:
             parsed_args.password = utils.get_password(self.app.stdin)
 
@@ -252,36 +280,35 @@ class CreateUser(command.ShowOne):
         options = _get_options_for_user(identity_client, parsed_args)
 
         try:
-            user = identity_client.users.create(
+            user = identity_client.create_user(
+                default_project_id=project_id,
+                description=parsed_args.description,
+                domain_id=domain_id,
+                email=parsed_args.email,
+                is_enabled=is_enabled,
                 name=parsed_args.name,
-                domain=domain_id,
-                default_project=project_id,
                 password=parsed_args.password,
-                email=parsed_args.email,
-                description=parsed_args.description,
-                enabled=enabled,
                 options=options,
             )
-        except ks_exc.Conflict:
+        except sdk_exc.ConflictException:
             if parsed_args.or_show:
-                user = utils.find_resource(
-                    identity_client.users,
-                    parsed_args.name,
+                user = identity_client.find_user(
+                    name_or_id=parsed_args.name,
                     domain_id=domain_id,
+                    ignore_missing=False,
                 )
                 LOG.info(_('Returning existing user %s'), user.name)
             else:
                 raise
 
-        user._info.pop('links')
-        return zip(*sorted(user._info.items()))
+        return _format_user(user)
 
 
 class DeleteUser(command.Command):
     _description = _("Delete user(s)")
 
     def get_parser(self, prog_name):
-        parser = super(DeleteUser, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'users',
             metavar='<user>',
@@ -296,21 +323,28 @@ class DeleteUser(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         domain = None
         if parsed_args.domain:
-            domain = common.find_domain(identity_client, parsed_args.domain)
+            domain = identity_client.find_domain(
+                name_or_id=parsed_args.domain,
+                ignore_missing=True,
+            )
         errors = 0
         for user in parsed_args.users:
             try:
                 if domain is not None:
-                    user_obj = utils.find_resource(
-                        identity_client.users, user, domain_id=domain.id
+                    user_obj = identity_client.find_user(
+                        name_or_id=user,
+                        domain_id=domain.id,
+                        ignore_missing=False,
                     )
                 else:
-                    user_obj = utils.find_resource(identity_client.users, user)
-                identity_client.users.delete(user_obj.id)
+                    user_obj = identity_client.find_user(
+                        name_or_id=user, ignore_missing=False
+                    )
+                identity_client.delete_user(user_obj.id, ignore_missing=False)
             except Exception as e:
                 errors += 1
                 LOG.error(
@@ -334,7 +368,7 @@ class ListUser(command.Lister):
     _description = _("List users")
 
     def get_parser(self, prog_name):
-        parser = super(ListUser, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--domain',
             metavar='<domain>',
@@ -360,32 +394,36 @@ class ListUser(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         domain = None
         if parsed_args.domain:
-            domain = common.find_domain(identity_client, parsed_args.domain).id
+            domain = identity_client.find_domain(
+                name_or_id=parsed_args.domain,
+            ).id
 
         group = None
         if parsed_args.group:
-            group = common.find_group(
-                identity_client, parsed_args.group, parsed_args.domain
+            group = identity_client.find_group(
+                name_or_id=parsed_args.group,
+                domain_id=parsed_args.domain,
+                ignore_missing=False,
             ).id
 
         if parsed_args.project:
             if domain is not None:
-                project = utils.find_resource(
-                    identity_client.projects,
-                    parsed_args.project,
+                project = identity_client.find_project(
+                    name_or_id=parsed_args.project,
                     domain_id=domain,
+                    ignore_missing=False,
                 ).id
             else:
-                project = utils.find_resource(
-                    identity_client.projects,
-                    parsed_args.project,
+                project = identity_client.find_project(
+                    name_or_id=parsed_args.project,
+                    ignore_missing=False,
                 ).id
 
-            assignments = identity_client.role_assignments.list(
+            assignments = identity_client.role_assignments_filter(
                 project=project
             )
 
@@ -394,21 +432,25 @@ class ListUser(command.Lister):
             # are looking for any role, let's just track unique user IDs.
             user_ids = set()
             for assignment in assignments:
-                if hasattr(assignment, 'user'):
+                if assignment.user:
                     user_ids.add(assignment.user['id'])
 
             # NOTE(stevemar): Call find_resource once we have unique IDs, so
             # it's fewer trips to the Identity API, then collect the data.
             data = []
             for user_id in user_ids:
-                user = utils.find_resource(identity_client.users, user_id)
+                user = identity_client.find_user(user_id, ignore_missing=False)
                 data.append(user)
 
-        else:
-            data = identity_client.users.list(
-                domain=domain,
+        elif parsed_args.group:
+            data = identity_client.group_users(
+                domain_id=domain,
                 group=group,
             )
+        else:
+            data = identity_client.users(
+                domain_id=domain,
+            )
 
         # Column handling
         if parsed_args.long:
@@ -419,11 +461,12 @@ class ListUser(command.Lister):
                 'Domain Id',
                 'Description',
                 'Email',
-                'Enabled',
+                'Is Enabled',
             ]
             column_headers = copy.deepcopy(columns)
             column_headers[2] = 'Project'
             column_headers[3] = 'Domain'
+            column_headers[6] = 'Enabled'
         else:
             columns = ['ID', 'Name']
             column_headers = columns
@@ -445,7 +488,7 @@ class SetUser(command.Command):
     _description = _("Set user properties")
 
     def get_parser(self, prog_name):
-        parser = super(SetUser, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'user',
             metavar='<user>',
@@ -507,7 +550,7 @@ class SetUser(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         if parsed_args.password_prompt:
             parsed_args.password = utils.get_password(self.app.stdin)
@@ -524,14 +567,19 @@ class SetUser(command.Command):
             identity_client, 'user', parsed_args.user, parsed_args.domain
         )
         if parsed_args.domain:
-            domain = common.find_domain(identity_client, parsed_args.domain)
-            user = utils.find_resource(
-                identity_client.users, user_str, domain_id=domain.id
+            domain = identity_client.find_domain(
+                name_or_id=parsed_args.domain,
+                ignore_missing=False,
+            )
+            user = identity_client.find_user(
+                name_or_id=user_str,
+                domain_id=domain.id,
+                ignore_missing=False,
             )
         else:
-            user = utils.find_resource(
-                identity_client.users,
-                parsed_args.user,
+            user = identity_client.find_user(
+                name_or_id=parsed_args.user,
+                ignore_missing=False,
             )
 
         kwargs = {}
@@ -544,23 +592,27 @@ class SetUser(command.Command):
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
         if parsed_args.project:
-            project_id = common.find_project(
-                identity_client,
-                parsed_args.project,
-                parsed_args.project_domain,
+            project_domain_id = identity_client.find_domain(
+                name_or_id=parsed_args.project_domain,
+                ignore_missing=False,
+            ).id
+            project_id = identity_client.find_project(
+                name_or_id=parsed_args.project,
+                ignore_missing=False,
+                domain_id=project_domain_id,
             ).id
-            kwargs['default_project'] = project_id
-        kwargs['enabled'] = user.enabled
+            kwargs['default_project_id'] = project_id
+        kwargs['is_enabled'] = user.is_enabled
         if parsed_args.enable:
-            kwargs['enabled'] = True
+            kwargs['is_enabled'] = True
         if parsed_args.disable:
-            kwargs['enabled'] = False
+            kwargs['is_enabled'] = False
 
         options = _get_options_for_user(identity_client, parsed_args)
         if options:
             kwargs['options'] = options
 
-        identity_client.users.update(user.id, **kwargs)
+        identity_client.update_user(user=user, **kwargs)
 
 
 class SetPasswordUser(command.Command):
@@ -569,7 +621,7 @@ class SetPasswordUser(command.Command):
     required_scope = False
 
     def get_parser(self, prog_name):
-        parser = super(SetPasswordUser, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--password',
             metavar='<new-password>',
@@ -583,7 +635,7 @@ class SetPasswordUser(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         # FIXME(gyee): there are two scenarios:
         #
@@ -625,14 +677,16 @@ class SetPasswordUser(command.Command):
                 )
             )
 
-        identity_client.users.update_password(current_password, password)
+        identity_client.update_user(
+            current_password=current_password, password=password
+        )
 
 
 class ShowUser(command.ShowOne):
     _description = _("Display user details")
 
     def get_parser(self, prog_name):
-        parser = super(ShowUser, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'user',
             metavar='<user>',
@@ -646,18 +700,28 @@ class ShowUser(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         user_str = common._get_token_resource(
             identity_client, 'user', parsed_args.user, parsed_args.domain
         )
+
+        domain = None
         if parsed_args.domain:
-            domain = common.find_domain(identity_client, parsed_args.domain)
-            user = utils.find_resource(
-                identity_client.users, user_str, domain_id=domain.id
+            domain = identity_client.find_domain(
+                name_or_id=parsed_args.domain,
+                ignore_missing=True,
+            )
+        if domain:
+            user = identity_client.find_user(
+                name_or_id=user_str,
+                domain_id=domain.id,
+                ignore_missing=False,
             )
         else:
-            user = utils.find_resource(identity_client.users, user_str)
+            user = identity_client.find_user(
+                name_or_id=user_str,
+                ignore_missing=False,
+            )
 
-        user._info.pop('links')
-        return zip(*sorted(user._info.items()))
+        return _format_user(user)

openstackclient/image/client.py

@@ -19,19 +19,19 @@ from osc_lib import utils
 
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
 DEFAULT_API_VERSION = '2'
 API_VERSION_OPTION = 'os_image_api_version'
-API_NAME = "image"
+API_NAME = 'image'
 API_VERSIONS = {
-    "1": "openstack.connection.Connection",
-    "2": "openstack.connection.Connection",
+    '1': 'openstack.connection.Connection',
+    '2': 'openstack.connection.Connection',
 }
 
 
 def make_client(instance):
+    """Returns an image service client."""
     LOG.debug(
         'Image client initialized using OpenStack SDK: %s',
         instance.sdk_connection.image,

openstackclient/image/v1/image.py

@@ -16,7 +16,6 @@
 """Image V1 Action Implementations"""
 
 import argparse
-import io
 import logging
 import os
 import sys
@@ -110,7 +109,7 @@ class CreateImage(command.ShowOne):
     _description = _("Create/upload an image")
 
     def get_parser(self, prog_name):
-        parser = super(CreateImage, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "name",
             metavar="<image-name>",
@@ -320,7 +319,7 @@ class CreateImage(command.ShowOne):
             elif parsed_args.file:
                 # Send an open file handle to glanceclient so it will
                 # do a chunked transfer
-                kwargs["data"] = io.open(parsed_args.file, "rb")
+                kwargs["data"] = open(parsed_args.file, "rb")
             else:
                 # Read file from stdin
                 if not sys.stdin.isatty():
@@ -363,7 +362,7 @@ class DeleteImage(command.Command):
     _description = _("Delete image(s)")
 
     def get_parser(self, prog_name):
-        parser = super(DeleteImage, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "images",
             metavar="<image>",
@@ -403,7 +402,7 @@ class ListImage(command.Lister):
     _description = _("List available images")
 
     def get_parser(self, prog_name):
-        parser = super(ListImage, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         public_group = parser.add_mutually_exclusive_group()
         public_group.add_argument(
             "--public",
@@ -534,7 +533,7 @@ class SaveImage(command.Command):
     _description = _("Save an image locally")
 
     def get_parser(self, prog_name):
-        parser = super(SaveImage, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "--file",
             metavar="<filename>",
@@ -564,7 +563,7 @@ class SetImage(command.Command):
     _description = _("Set image properties")
 
     def get_parser(self, prog_name):
-        parser = super(SetImage, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "image",
             metavar="<image>",
@@ -771,7 +770,7 @@ class SetImage(command.Command):
                 elif parsed_args.file:
                     # Send an open file handle to glanceclient so it will
                     # do a chunked transfer
-                    kwargs["data"] = io.open(parsed_args.file, "rb")
+                    kwargs["data"] = open(parsed_args.file, "rb")
                 else:
                     # Read file from stdin
                     if sys.stdin.isatty() is not True:
@@ -809,7 +808,7 @@ class ShowImage(command.ShowOne):
     _description = _("Display image details")
 
     def get_parser(self, prog_name):
-        parser = super(ShowImage, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "--human-readable",
             default=False,

openstackclient/image/v2/cache.py

@@ -36,16 +36,16 @@ def _format_image_cache(cached_images):
             for image in cached_images[item]:
                 image_obj = copy.deepcopy(image)
                 image_obj['state'] = 'cached'
-                image_obj[
-                    'last_accessed'
-                ] = datetime.datetime.utcfromtimestamp(
-                    image['last_accessed']
-                ).isoformat()
-                image_obj[
-                    'last_modified'
-                ] = datetime.datetime.utcfromtimestamp(
-                    image['last_modified']
-                ).isoformat()
+                image_obj['last_accessed'] = (
+                    datetime.datetime.utcfromtimestamp(
+                        image['last_accessed']
+                    ).isoformat()
+                )
+                image_obj['last_modified'] = (
+                    datetime.datetime.utcfromtimestamp(
+                        image['last_modified']
+                    ).isoformat()
+                )
                 image_list.append(image_obj)
         elif item == "queued_images":
             for image in cached_images[item]:
@@ -194,6 +194,7 @@ class ClearCachedImage(command.Command):
             "--cache",
             action="store_const",
             const="cache",
+            default="both",
             dest="target",
             help=_("Clears all the cached images"),
         )
@@ -201,6 +202,7 @@ class ClearCachedImage(command.Command):
             "--queue",
             action="store_const",
             const="queue",
+            default="both",
             dest="target",
             help=_("Clears all the queued images"),
         )

openstackclient/image/v2/metadef_objects.py

@@ -223,3 +223,47 @@ class SetMetadefObject(command.Command):
         image_client.update_metadef_object(
             object, parsed_args.namespace, **kwargs
         )
+
+
+class ShowMetadefObjectProperty(command.ShowOne):
+    _description = _(
+        "Describe a specific metadata definitions property inside an object."
+    )
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "namespace",
+            metavar="<namespace_name>",
+            help=_("Namespace (name) for the namespace"),
+        )
+        parser.add_argument(
+            "object",
+            metavar="<object_name>",
+            help=_("Name of an object."),
+        )
+        parser.add_argument(
+            "property",
+            help=_("Name of the property."),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        image_client = self.app.client_manager.image
+
+        namespace_name = parsed_args.namespace
+        object_name = parsed_args.object
+
+        obj = image_client.get_metadef_object(object_name, namespace_name)
+        try:
+            prop = obj['properties'][parsed_args.property]
+            prop['name'] = parsed_args.property
+
+        except KeyError:
+            msg = _('Property %s not found in object %s.') % (
+                parsed_args.property,
+                parsed_args.object,
+            )
+            raise exceptions.CommandError(msg)
+
+        return zip(*sorted(prop.items()))