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

openstackclient/identity/v3/token.py

@@ -136,8 +136,7 @@ class CreateRequestToken(command.ShowOne):
             '--project',
             metavar='<project>',
             help=_(
-                'Project that consumer wants to access (name or ID)'
-                ' (required)'
+                'Project that consumer wants to access (name or ID) (required)'
             ),
             required=True,
         )

openstackclient/identity/v3/trust.py

@@ -123,37 +123,67 @@ class CreateTrust(command.ShowOne):
         # pointless, and trusts are immutable, so let's enforce it at the
         # client level.
         try:
-            trustor_id = identity_client.find_user(
-                parsed_args.trustor, parsed_args.trustor_domain
-            ).id
-            kwargs['trustor_id'] = trustor_id
+            if parsed_args.trustor_domain:
+                trustor_domain_id = identity_client.find_domain(
+                    parsed_args.trustor_domain, ignore_missing=False
+                ).id
+                trustor_id = identity_client.find_user(
+                    parsed_args.trustor,
+                    ignore_missing=False,
+                    domain_id=trustor_domain_id,
+                ).id
+            else:
+                trustor_id = identity_client.find_user(
+                    parsed_args.trustor, ignore_missing=False
+                ).id
+            kwargs['trustor_user_id'] = trustor_id
         except sdk_exceptions.ForbiddenException:
-            kwargs['trustor_id'] = parsed_args.trustor
+            kwargs['trustor_user_id'] = parsed_args.trustor
 
         try:
-            trustee_id = identity_client.find_user(
-                parsed_args.trustee, parsed_args.trustee_domain
-            ).id
-            kwargs['trustee_id'] = trustee_id
+            if parsed_args.trustee_domain:
+                trustee_domain_id = identity_client.find_domain(
+                    parsed_args.trustee_domain, ignore_missing=False
+                ).id
+                trustee_id = identity_client.find_user(
+                    parsed_args.trustee,
+                    ignore_missing=False,
+                    domain_id=trustee_domain_id,
+                ).id
+            else:
+                trustee_id = identity_client.find_user(
+                    parsed_args.trustee, ignore_missing=False
+                ).id
+            kwargs['trustee_user_id'] = trustee_id
         except sdk_exceptions.ForbiddenException:
-            kwargs['trustee_id'] = parsed_args.trustee
+            kwargs['trustee_user_id'] = parsed_args.trustee
 
         try:
-            project_id = identity_client.find_project(
-                parsed_args.project, parsed_args.project_domain
-            ).id
+            if parsed_args.project_domain:
+                project_domain_id = identity_client.find_domain(
+                    parsed_args.project_domain, ignore_missing=False
+                ).id
+                project_id = identity_client.find_project(
+                    parsed_args.project,
+                    ignore_missing=False,
+                    domain_id=project_domain_id,
+                ).id
+            else:
+                project_id = identity_client.find_project(
+                    parsed_args.project, ignore_missing=False
+                ).id
             kwargs['project_id'] = project_id
         except sdk_exceptions.ForbiddenException:
             kwargs['project_id'] = parsed_args.project
 
-        role_ids = []
+        roles = []
         for role in parsed_args.roles:
             try:
                 role_id = identity_client.find_role(role).id
             except sdk_exceptions.ForbiddenException:
                 role_id = role
-            role_ids.append(role_id)
-        kwargs['roles'] = role_ids
+            roles.append({"id": role_id})
+        kwargs['roles'] = roles
 
         if parsed_args.expiration:
             expires_at = datetime.datetime.strptime(
@@ -161,8 +191,7 @@ class CreateTrust(command.ShowOne):
             )
             kwargs['expires_at'] = expires_at
 
-        if parsed_args.is_impersonation:
-            kwargs['is_impersonation'] = parsed_args.is_impersonation
+        kwargs['impersonation'] = bool(parsed_args.is_impersonation)
 
         trust = identity_client.create_trust(**kwargs)
 
@@ -204,7 +233,7 @@ class DeleteTrust(command.Command):
 
         if errors > 0:
             total = len(parsed_args.trust)
-            msg = _("%(errors)s of %(total)s trusts failed " "to delete.") % {
+            msg = _("%(errors)s of %(total)s trusts failed to delete.") % {
                 'errors': errors,
                 'total': total,
             }
@@ -289,9 +318,19 @@ class ListTrust(command.Lister):
             trustor = None
             if parsed_args.trustor:
                 try:
-                    trustor_id = identity_client.find_user(
-                        parsed_args.trustor, parsed_args.trustor_domain
-                    ).id
+                    if parsed_args.trustor_domain:
+                        trustor_domain_id = identity_client.find_domain(
+                            parsed_args.trustor_domain, ignore_missing=False
+                        ).id
+                        trustor_id = identity_client.find_user(
+                            parsed_args.trustor,
+                            ignore_missing=False,
+                            domain_id=trustor_domain_id,
+                        ).id
+                    else:
+                        trustor_id = identity_client.find_user(
+                            parsed_args.trustor, ignore_missing=False
+                        ).id
                     trustor = trustor_id
                 except sdk_exceptions.ForbiddenException:
                     trustor = parsed_args.trustor
@@ -299,9 +338,19 @@ class ListTrust(command.Lister):
             trustee = None
             if parsed_args.trustee:
                 try:
-                    trustee_id = identity_client.find_user(
-                        parsed_args.trustee, parsed_args.trustee_domain
-                    ).id
+                    if parsed_args.trustee_domain:
+                        trustee_domain_id = identity_client.find_domain(
+                            parsed_args.trustee_domain, ignore_missing=False
+                        ).id
+                        trustee_id = identity_client.find_user(
+                            parsed_args.trustee,
+                            ignore_missing=False,
+                            domain_id=trustee_domain_id,
+                        ).id
+                    else:
+                        trustee_id = identity_client.find_user(
+                            parsed_args.trustee, ignore_missing=False
+                        ).id
                     trustee = trustee_id
                 except sdk_exceptions.ForbiddenException:
                     trustee = parsed_args.trustee

openstackclient/identity/v3/user.py

@@ -17,6 +17,7 @@
 
 import copy
 import logging
+import typing as ty
 
 from openstack import exceptions as sdk_exc
 from osc_lib.command import command
@@ -40,6 +41,7 @@ def _format_user(user):
         'name',
         'description',
         'password_expires_at',
+        'options',
     )
     column_headers = (
         'default_project_id',
@@ -50,6 +52,7 @@ def _format_user(user):
         'name',
         'description',
         'password_expires_at',
+        'options',
     )
     return (
         column_headers,
@@ -58,7 +61,7 @@ def _format_user(user):
 
 
 def _get_options_for_user(identity_client, parsed_args):
-    options = {}
+    options: dict[str, ty.Any] = {}
     if parsed_args.ignore_lockout_failure_attempts:
         options['ignore_lockout_failure_attempts'] = True
     if parsed_args.no_ignore_lockout_failure_attempts:
@@ -288,7 +291,7 @@ class CreateUser(command.ShowOne):
         elif parsed_args.password_prompt:
             password = utils.get_password(self.app.stdin)
 
-        if not parsed_args.password:
+        if not password:
             LOG.warning(
                 _(
                     "No password was supplied, authentication will fail "
@@ -377,7 +380,7 @@ class DeleteUser(command.Command):
 
         if errors > 0:
             total = len(parsed_args.users)
-            msg = _("%(errors)s of %(total)s users failed " "to delete.") % {
+            msg = _("%(errors)s of %(total)s users failed to delete.") % {
                 'errors': errors,
                 'total': total,
             }
@@ -411,6 +414,24 @@ class ListUser(command.Lister):
             default=False,
             help=_('List additional fields in output'),
         )
+        parser.add_argument(
+            '--enabled',
+            action='store_true',
+            dest='is_enabled',
+            default=None,
+            help=_(
+                'List only enabled users, does nothing with --project and --group'
+            ),
+        )
+        parser.add_argument(
+            '--disabled',
+            action='store_false',
+            dest='is_enabled',
+            default=None,
+            help=_(
+                'List only disabled users, does nothing with --project and --group'
+            ),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -430,6 +451,9 @@ class ListUser(command.Lister):
                 ignore_missing=False,
             ).id
 
+        if parsed_args.is_enabled is not None:
+            enabled = parsed_args.is_enabled
+
         if parsed_args.project:
             if domain is not None:
                 project = identity_client.find_project(
@@ -468,9 +492,15 @@ class ListUser(command.Lister):
                 group=group,
             )
         else:
-            data = identity_client.users(
-                domain_id=domain,
-            )
+            if parsed_args.is_enabled is not None:
+                data = identity_client.users(
+                    domain_id=domain,
+                    is_enabled=enabled,
+                )
+            else:
+                data = identity_client.users(
+                    domain_id=domain,
+                )
 
         # Column handling
         if parsed_args.long:
@@ -612,10 +642,12 @@ class SetUser(command.Command):
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
         if parsed_args.project:
-            project_domain_id = identity_client.find_domain(
-                name_or_id=parsed_args.project_domain,
-                ignore_missing=False,
-            ).id
+            project_domain_id = None
+            if 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,
@@ -656,6 +688,8 @@ class SetPasswordUser(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)
 
         # FIXME(gyee): there are two scenarios:
         #
@@ -698,7 +732,9 @@ class SetPasswordUser(command.Command):
             )
 
         identity_client.update_user(
-            current_password=current_password, password=password
+            user=user_id,
+            current_password=current_password,
+            password=password,
         )
 
 

openstackclient/image/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
 
@@ -21,13 +20,11 @@ from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
 
+# global variables used when building the shell
 DEFAULT_API_VERSION = '2'
 API_VERSION_OPTION = 'os_image_api_version'
 API_NAME = 'image'
-API_VERSIONS = {
-    '1': 'openstack.connection.Connection',
-    '2': 'openstack.connection.Connection',
-}
+API_VERSIONS = ('1', '2')
 
 
 def make_client(instance):
@@ -49,3 +46,8 @@ def build_option_parser(parser):
         % DEFAULT_API_VERSION,
     )
     return parser
+
+
+def check_api_version(check_version):
+    # SDK supports auto-negotiation for us: always return True
+    return True

openstackclient/image/v1/image.py

@@ -30,12 +30,6 @@ from osc_lib import utils
 
 from openstackclient.i18n import _
 
-if os.name == "nt":
-    import msvcrt
-else:
-    msvcrt = None
-
-
 CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"]
 DEFAULT_CONTAINER_FORMAT = 'bare'
 DEFAULT_DISK_FORMAT = 'raw'
@@ -53,7 +47,6 @@ DISK_CHOICES = [
     "ploop",
 ]
 
-
 LOG = logging.getLogger(__name__)
 
 
@@ -323,8 +316,10 @@ class CreateImage(command.ShowOne):
             else:
                 # Read file from stdin
                 if not sys.stdin.isatty():
-                    if msvcrt:
-                        msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
+                    if os.name == "nt":
+                        import msvcrt
+
+                        msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)  # type: ignore
                     if hasattr(sys.stdin, 'buffer'):
                         kwargs['data'] = sys.stdin.buffer
                     else:
@@ -384,8 +379,7 @@ class DeleteImage(command.Command):
             except Exception as e:
                 result += 1
                 msg = _(
-                    "Failed to delete image with name or "
-                    "ID '%(image)s': %(e)s"
+                    "Failed to delete image with name or ID '%(image)s': %(e)s"
                 )
                 LOG.error(msg, {'image': image, 'e': e})
 
@@ -468,7 +462,7 @@ class ListImage(command.Lister):
             kwargs['is_private'] = True
 
         if parsed_args.long:
-            columns = (
+            columns: tuple[str, ...] = (
                 'ID',
                 'Name',
                 'Disk Format',
@@ -481,7 +475,7 @@ class ListImage(command.Lister):
                 'owner_id',
                 'properties',
             )
-            column_headers = (
+            column_headers: tuple[str, ...] = (
                 'ID',
                 'Name',
                 'Disk Format',
@@ -775,8 +769,10 @@ class SetImage(command.Command):
                     # Read file from stdin
                     if sys.stdin.isatty() is not True:
                         if parsed_args.stdin:
-                            if msvcrt:
-                                msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
+                            if os.name == "nt":
+                                import msvcrt
+
+                                msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)  # type: ignore
                             if hasattr(sys.stdin, 'buffer'):
                                 kwargs['data'] = sys.stdin.buffer
                             else:

openstackclient/image/v2/cache.py

@@ -131,8 +131,7 @@ class QueueCachedImage(command.Command):
             except Exception as e:
                 failures += 1
                 msg = _(
-                    "Failed to queue image with name or "
-                    "ID '%(image)s': %(e)s"
+                    "Failed to queue image with name or ID '%(image)s': %(e)s"
                 )
                 LOG.error(msg, {'image': image, 'e': e})
 
@@ -171,8 +170,7 @@ class DeleteCachedImage(command.Command):
             except Exception as e:
                 failures += 1
                 msg = _(
-                    "Failed to delete image with name or "
-                    "ID '%(image)s': %(e)s"
+                    "Failed to delete image with name or ID '%(image)s': %(e)s"
                 )
                 LOG.error(msg, {'image': image, 'e': e})
 

openstackclient/image/v2/image.py

@@ -17,13 +17,15 @@
 
 import argparse
 from base64 import b64encode
+import copy
 import logging
 import os
 import sys
+import typing as ty
 
-from cinderclient import api_versions
 from openstack import exceptions as sdk_exceptions
 from openstack.image import image_signer
+from openstack import utils as sdk_utils
 from osc_lib.api import utils as api_utils
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -36,12 +38,6 @@ from openstackclient.common import progressbar
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
-if os.name == "nt":
-    import msvcrt
-else:
-    msvcrt = None
-
-
 CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"]
 DEFAULT_CONTAINER_FORMAT = 'bare'
 DEFAULT_DISK_FORMAT = 'raw'
@@ -60,7 +56,6 @@ DISK_CHOICES = [
 ]
 MEMBER_STATUS_CHOICES = ["accepted", "pending", "rejected", "all"]
 
-
 LOG = logging.getLogger(__name__)
 
 
@@ -154,8 +149,10 @@ def get_data_from_stdin():
         image = sys.stdin
         if hasattr(sys.stdin, 'buffer'):
             image = sys.stdin.buffer
-        if msvcrt:
-            msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
+        if os.name == "nt":
+            import msvcrt
+
+            msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)  # type: ignore
 
         return image
     else:
@@ -359,8 +356,7 @@ class CreateImage(command.ShowOne):
             action="store_true",
             default=False,
             help=_(
-                "Show upload progress bar "
-                "(ignored if passing data via stdin)"
+                "Show upload progress bar (ignored if passing data via stdin)"
             ),
         )
         parser.add_argument(
@@ -401,8 +397,7 @@ class CreateImage(command.ShowOne):
             metavar="<tag>",
             action='append',
             help=_(
-                "Set a tag on this image "
-                "(repeat option to set multiple tags)"
+                "Set a tag on this image (repeat option to set multiple tags)"
             ),
         )
         parser.add_argument(
@@ -434,7 +429,7 @@ class CreateImage(command.ShowOne):
 
         # Build an attribute dict from the parsed args, only include
         # attributes that were actually set on the command line
-        kwargs = {'allow_duplicates': True}
+        kwargs: dict[str, ty.Any] = {'allow_duplicates': True}
         copy_attrs = (
             'name',
             'id',
@@ -582,7 +577,7 @@ class CreateImage(command.ShowOne):
         return _format_image(image)
 
     def _take_action_volume(self, parsed_args):
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
 
         unsupported_opts = {
             # 'name',  # 'name' is a positional argument and will always exist
@@ -613,12 +608,14 @@ class CreateImage(command.ShowOne):
                 # version
                 LOG.warning(msg % opt_name)
 
-        source_volume = utils.find_resource(
-            volume_client.volumes,
-            parsed_args.volume,
+        source_volume = volume_client.find_volume(
+            parsed_args.volume, ignore_missing=False
         )
-        kwargs = {}
-        if volume_client.api_version < api_versions.APIVersion('3.1'):
+        kwargs: dict[str, ty.Any] = {
+            'visibility': None,
+            'protected': None,
+        }
+        if not sdk_utils.supports_microversion(volume_client, '3.1'):
             if parsed_args.visibility or parsed_args.is_protected is not None:
                 msg = _(
                     '--os-volume-api-version 3.1 or greater is required '
@@ -627,20 +624,18 @@ class CreateImage(command.ShowOne):
                 )
                 raise exceptions.CommandError(msg)
         else:
-            kwargs.update(
-                visibility=parsed_args.visibility or 'private',
-                protected=parsed_args.is_protected or False,
-            )
+            kwargs['visibility'] = parsed_args.visibility or 'private'
+            kwargs['protected'] = parsed_args.is_protected or False
 
-        response, body = volume_client.volumes.upload_to_image(
+        response = volume_client.upload_volume_to_image(
             source_volume.id,
-            parsed_args.force,
             parsed_args.name,
-            parsed_args.container_format,
-            parsed_args.disk_format,
+            force=parsed_args.force,
+            disk_format=parsed_args.disk_format,
+            container_format=parsed_args.container_format,
             **kwargs,
         )
-        info = body['os-volume_upload_image']
+        info = copy.deepcopy(response)
         try:
             info['volume_type'] = info['volume_type']['name']
         except TypeError:
@@ -705,8 +700,7 @@ class DeleteImage(command.Command):
             except Exception as e:
                 result += 1
                 msg = _(
-                    "Failed to delete image with name or "
-                    "ID '%(image)s': %(e)s"
+                    "Failed to delete image with name or ID '%(image)s': %(e)s"
                 )
                 LOG.error(msg, {'image': image, 'e': e})
 
@@ -884,7 +878,7 @@ class ListImage(command.Lister):
         if parsed_args.is_hidden:
             kwargs['is_hidden'] = parsed_args.is_hidden
         if parsed_args.long:
-            columns = (
+            columns: tuple[str, ...] = (
                 'ID',
                 'Name',
                 'Disk Format',
@@ -897,7 +891,7 @@ class ListImage(command.Lister):
                 'owner_id',
                 'tags',
             )
-            column_headers = (
+            column_headers: tuple[str, ...] = (
                 'ID',
                 'Name',
                 'Disk Format',
@@ -959,7 +953,7 @@ class ListImageProjects(command.Lister):
 
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
-        columns = ("Image ID", "Member ID", "Status")
+        columns: tuple[str, ...] = ("Image ID", "Member ID", "Status")
 
         image_id = image_client.find_image(
             parsed_args.image,
@@ -1153,8 +1147,7 @@ class SetImage(command.Command):
             default=None,
             action='append',
             help=_(
-                "Set a tag on this image "
-                "(repeat option to set multiple tags)"
+                "Set a tag on this image (repeat option to set multiple tags)"
             ),
         )
         parser.add_argument(
@@ -1457,7 +1450,6 @@ class UnsetImage(command.Command):
             ignore_missing=False,
         )
 
-        kwargs = {}
         tagret = 0
         propret = 0
         if parsed_args.tags:
@@ -1466,10 +1458,11 @@ class UnsetImage(command.Command):
                     image_client.remove_tag(image.id, k)
                 except Exception:
                     LOG.error(
-                        _("tag unset failed, '%s' is a " "nonexistent tag "), k
+                        _("tag unset failed, '%s' is a nonexistent tag "), k
                     )
                     tagret += 1
 
+        kwargs: dict[str, ty.Any] = {}
         if parsed_args.properties:
             for k in parsed_args.properties:
                 if k in image:
@@ -1519,7 +1512,7 @@ class UnsetImage(command.Command):
             raise exceptions.CommandError(msg)
         elif propret > 0:
             msg = _(
-                "Failed to unset %(propret)s of %(proptotal)s" " properties."
+                "Failed to unset %(propret)s of %(proptotal)s properties."
             ) % {'propret': propret, 'proptotal': proptotal}
             raise exceptions.CommandError(msg)
 
@@ -1551,8 +1544,7 @@ class StageImage(command.Command):
             action='store_true',
             default=False,
             help=_(
-                'Show upload progress bar '
-                '(ignored if passing data via stdin)'
+                'Show upload progress bar (ignored if passing data via stdin)'
             ),
         )
         parser.add_argument(
@@ -1583,7 +1575,7 @@ class StageImage(command.Command):
         else:
             fp = get_data_from_stdin()
 
-        kwargs = {}
+        kwargs: dict[str, ty.Any] = {}
 
         if parsed_args.progress and parsed_args.filename:
             # NOTE(stephenfin): we only show a progress bar if the user
@@ -1689,7 +1681,8 @@ class ImportImage(command.ShowOne):
                 "'copy-image' import method)"
             ),
         )
-        parser.add_argument(
+        allow_failure_group = parser.add_mutually_exclusive_group()
+        allow_failure_group.add_argument(
             '--allow-failure',
             action='store_true',
             dest='allow_failure',
@@ -1700,9 +1693,9 @@ class ImportImage(command.ShowOne):
                 'Only usable with --stores or --all-stores'
             ),
         )
-        parser.add_argument(
+        allow_failure_group.add_argument(
             '--disallow-failure',
-            action='store_true',
+            action='store_false',
             dest='allow_failure',
             default=True,
             help=_(
@@ -1866,8 +1859,8 @@ class StoresInfo(command.Lister):
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
         try:
-            columns = ("id", "description", "is_default")
-            column_headers = ("ID", "Description", "Default")
+            columns: tuple[str, ...] = ("id", "description", "is_default")
+            column_headers: tuple[str, ...] = ("ID", "Description", "Default")
             if parsed_args.detail:
                 columns += ("properties",)
                 column_headers += ("Properties",)