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

openstackclient/identity/v3/token.py

@@ -15,10 +15,10 @@
 
 """Identity v3 Token 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 _
 from openstackclient.identity import common
 
@@ -37,6 +37,7 @@ class AuthorizeRequestToken(command.ShowOne):
         parser.add_argument(
             '--role',
             metavar='<role>',
+            dest='roles',
             action='append',
             default=[],
             required=True,
@@ -52,7 +53,7 @@ class AuthorizeRequestToken(command.ShowOne):
 
         # NOTE(stevemar): We want a list of role ids
         roles = []
-        for role in parsed_args.role:
+        for role in parsed_args.roles:
             role_id = utils.find_resource(
                 identity_client.roles,
                 role,

openstackclient/identity/v3/trust.py

@@ -18,10 +18,10 @@ import itertools
 import logging
 
 from openstack import exceptions as sdk_exceptions
-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
 
@@ -179,7 +179,9 @@ class CreateTrust(command.ShowOne):
         roles = []
         for role in parsed_args.roles:
             try:
-                role_id = identity_client.find_role(role).id
+                role_id = identity_client.find_role(
+                    role, ignore_missing=False
+                ).id
             except sdk_exceptions.ForbiddenException:
                 role_id = role
             roles.append({"id": role_id})

openstackclient/identity/v3/unscoped_saml.py

@@ -17,9 +17,9 @@ The first step of federated auth is to fetch an unscoped token. From there,
 the user can list domains and projects they are allowed to access, and request
 a scoped token."""
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/identity/v3/user.py

@@ -20,10 +20,10 @@ import logging
 import typing as ty
 
 from openstack import exceptions as sdk_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 _
 from openstackclient.identity import common
 
@@ -82,9 +82,9 @@ def _get_options_for_user(identity_client, parsed_args):
         options['multi_factor_auth_enabled'] = True
     if parsed_args.disable_multi_factor_auth:
         options['multi_factor_auth_enabled'] = False
-    if parsed_args.multi_factor_auth_rule:
+    if parsed_args.multi_factor_auth_rules:
         auth_rules = [
-            rule.split(",") for rule in parsed_args.multi_factor_auth_rule
+            rule.split(",") for rule in parsed_args.multi_factor_auth_rules
         ]
         if auth_rules:
             options['multi_factor_auth_rules'] = auth_rules
@@ -175,7 +175,8 @@ def _add_user_options(parser):
     parser.add_argument(
         '--multi-factor-auth-rule',
         metavar='<rule>',
-        action="append",
+        dest='multi_factor_auth_rules',
+        action='append',
         default=[],
         help=_(
             'Set multi-factor auth rules. For example, to set a rule '
@@ -298,6 +299,9 @@ class CreateUser(command.ShowOne):
                     "when a user does not have a password."
                 )
             )
+        else:
+            kwargs['password'] = password
+
         options = _get_options_for_user(identity_client, parsed_args)
         if options:
             kwargs['options'] = options
@@ -306,7 +310,6 @@ class CreateUser(command.ShowOne):
             user = identity_client.create_user(
                 is_enabled=is_enabled,
                 name=parsed_args.name,
-                password=password,
                 **kwargs,
             )
         except sdk_exc.ConflictException:
@@ -420,7 +423,8 @@ class ListUser(command.Lister):
             dest='is_enabled',
             default=None,
             help=_(
-                'List only enabled users, does nothing with --project and --group'
+                'List only enabled users, does nothing with '
+                '--project and --group'
             ),
         )
         parser.add_argument(
@@ -429,7 +433,8 @@ class ListUser(command.Lister):
             dest='is_enabled',
             default=None,
             help=_(
-                'List only disabled users, does nothing with --project and --group'
+                'List only disabled users, does nothing with '
+                '--project and --group'
             ),
         )
         return parser
@@ -441,6 +446,7 @@ class ListUser(command.Lister):
         if parsed_args.domain:
             domain = identity_client.find_domain(
                 name_or_id=parsed_args.domain,
+                ignore_missing=False,
             ).id
 
         group = None
@@ -467,15 +473,13 @@ class ListUser(command.Lister):
                     ignore_missing=False,
                 ).id
 
-            assignments = identity_client.role_assignments_filter(
-                project=project
-            )
-
             # NOTE(stevemar): If a user has more than one role on a project
             # then they will have two entries in the returned data. Since we
             # are looking for any role, let's just track unique user IDs.
             user_ids = set()
-            for assignment in assignments:
+            for assignment in identity_client.role_assignments(
+                scope_project_id=project
+            ):
                 if assignment.user:
                     user_ids.add(assignment.user['id'])
 
@@ -689,7 +693,12 @@ 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)
+        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)
 
         # FIXME(gyee): there are two scenarios:
         #

openstackclient/image/v1/image.py

@@ -19,15 +19,16 @@ import argparse
 import logging
 import os
 import sys
+import typing as ty
 
 from cliff import columns as cliff_columns
 from osc_lib.api import utils as api_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.i18n import _
 
 CONTAINER_CHOICES = ["ami", "ari", "aki", "bare", "docker", "ova", "ovf"]
@@ -67,10 +68,7 @@ def _get_columns(item):
     )
 
 
-_formatters = {}
-
-
-class HumanReadableSizeColumn(cliff_columns.FormattableColumn):
+class HumanReadableSizeColumn(cliff_columns.FormattableColumn[int]):
     def human_readable(self):
         """Return a formatted visibility string
 
@@ -84,7 +82,7 @@ class HumanReadableSizeColumn(cliff_columns.FormattableColumn):
             return ''
 
 
-class VisibilityColumn(cliff_columns.FormattableColumn):
+class VisibilityColumn(cliff_columns.FormattableColumn[bool]):
     def human_readable(self):
         """Return a formatted visibility string
 
@@ -340,9 +338,12 @@ class CreateImage(command.ShowOne):
 
         if image:
             display_columns, columns = _get_columns(image)
-            _formatters['properties'] = format_columns.DictColumn
             data = utils.get_item_properties(
-                image, columns, formatters=_formatters
+                image,
+                columns,
+                formatters={
+                    'properties': format_columns.DictColumn,
+                },
             )
             return (display_columns, data)
         elif info:
@@ -493,19 +494,19 @@ class ListImage(command.Lister):
             column_headers = columns
 
         # List of image data received
-        data = list(image_client.images(**kwargs))
+        images = list(image_client.images(**kwargs))
 
         if parsed_args.property:
             # NOTE(dtroyer): coerce to a list to subscript it in py3
             attr, value = list(parsed_args.property.items())[0]
             api_utils.simple_filter(
-                data,
+                images,
                 attr=attr,
                 value=value,
                 property_field='properties',
             )
 
-        data = utils.sort_items(data, parsed_args.sort)
+        data = utils.sort_items(images, parsed_args.sort)
 
         return (
             column_headers,
@@ -839,11 +840,13 @@ class ShowImage(command.ShowOne):
             parsed_args.image, ignore_missing=False
         )
 
+        formatters: dict[
+            str, type[cliff_columns.FormattableColumn[ty.Any]]
+        ] = {
+            'properties': format_columns.DictColumn,
+        }
         if parsed_args.human_readable:
-            _formatters['size'] = HumanReadableSizeColumn
+            formatters['size'] = HumanReadableSizeColumn
         display_columns, columns = _get_columns(image)
-        _formatters['properties'] = format_columns.DictColumn
-        data = utils.get_item_properties(
-            image, columns, formatters=_formatters
-        )
+        data = utils.get_item_properties(image, columns, formatters=formatters)
         return (display_columns, data)

openstackclient/image/v2/cache.py

@@ -17,10 +17,10 @@ import copy
 import datetime
 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/image/v2/image.py

@@ -30,10 +30,10 @@ 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
-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.common import progressbar
 from openstackclient.i18n import _
@@ -551,7 +551,7 @@ class CreateImage(command.ShowOne):
             sign_cert_id = parsed_args.sign_cert_id
             signer = image_signer.ImageSigner()
             try:
-                pw = utils.get_password(
+                pw: str | None = utils.get_password(
                     self.app.stdin,
                     prompt=(
                         "Please enter private key password, leave "
@@ -562,12 +562,11 @@ class CreateImage(command.ShowOne):
 
                 if not pw or len(pw) < 1:
                     pw = None
-                else:
-                    # load_private_key() requires the password to be
-                    # passed as bytes
-                    pw = pw.encode()
 
-                signer.load_private_key(sign_key_path, password=pw)
+                signer.load_private_key(
+                    sign_key_path,
+                    password=pw.encode() if pw else None,
+                )
             except Exception:
                 msg = _(
                     "Error during sign operation: private key "
@@ -623,7 +622,7 @@ class CreateImage(command.ShowOne):
                 )
                 # TODO(stephenfin): These should be an error in a future
                 # version
-                LOG.warning(msg % opt_name)
+                LOG.warning(msg, opt_name)
 
         source_volume = volume_client.find_volume(
             parsed_args.volume, ignore_missing=False
@@ -933,18 +932,19 @@ class ListImage(command.Lister):
         if 'limit' in kwargs:
             # Disable automatic pagination in SDK
             kwargs['paginated'] = False
-        data = list(image_client.images(**kwargs))
+
+        images = list(image_client.images(**kwargs))
 
         if parsed_args.property:
             for attr, value in parsed_args.property.items():
                 api_utils.simple_filter(
-                    data,
+                    images,
                     attr=attr,
                     value=value,
                     property_field='properties',
                 )
 
-        data = utils.sort_items(data, parsed_args.sort, str)
+        data = utils.sort_items(images, parsed_args.sort, str)
 
         return (
             column_headers,
@@ -1393,7 +1393,10 @@ class SetImage(command.Command):
         if parsed_args.visibility is not None:
             kwargs['visibility'] = parsed_args.visibility
 
-        if parsed_args.project:
+        # Only set owner_id if --project is used WITHOUT membership flags
+        # When --project is used with --accept/--reject/--pending, it should
+        # only identify which member's status to update, not change ownership
+        if parsed_args.project and not parsed_args.membership:
             # We already did the project lookup above
             kwargs['owner_id'] = project_id
 
@@ -1716,6 +1719,7 @@ class ImportImage(command.ShowOne):
         )
         stores_group.add_argument(
             '--all-stores',
+            action='store_true',
             help=_(
                 "Make image available to all stores "
                 "(either '--store' or '--all-stores' required with the "

openstackclient/image/v2/info.py

@@ -12,8 +12,8 @@
 
 
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/image/v2/metadef_namespaces.py

@@ -18,10 +18,10 @@
 import logging
 
 from osc_lib.cli import format_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 _
 
 _formatters = {

openstackclient/image/v2/metadef_objects.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 _
 
 

openstackclient/image/v2/metadef_properties.py

@@ -15,10 +15,10 @@
 import json
 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 _
 
 
@@ -127,7 +127,8 @@ class DeleteMetadefProperty(command.Command):
             nargs="*",
             help=_(
                 "Metadef properties to delete (name) "
-                "(omit this argument to delete all properties in the namespace)"
+                "(omit this argument to delete all properties "
+                "in the namespace)"
             ),
         )
         return parser

openstackclient/image/v2/metadef_resource_type_association.py

@@ -12,10 +12,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 _
 
 LOG = logging.getLogger(__name__)

openstackclient/image/v2/metadef_resource_types.py

@@ -12,9 +12,9 @@
 
 """Image V2 Action Implementations"""
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/image/v2/task.py

@@ -11,9 +11,9 @@
 # under the License.
 
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 _formatters = {

openstackclient/network/common.py

@@ -12,17 +12,16 @@
 #
 
 import abc
-import argparse
 import contextlib
 import logging
 import typing as ty
 
-import cliff.app
+from cliff import _argparse
 import openstack.exceptions
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.network import utils
 
@@ -68,8 +67,6 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
     present the options for both network types, often qualified accordingly.
     """
 
-    app: cliff.app.App
-
     @property
     def _network_type(self):
         """Discover whether the running cloud is using neutron or nova-network.
@@ -84,7 +81,7 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
         # Have we set it up yet for this command?
         if not hasattr(self, '_net_type'):
             try:
-                if self.app.client_manager.is_network_endpoint_enabled():
+                if self.app.client_manager.is_network_endpoint_enabled():  # type: ignore
                     net_type = _NET_TYPE_NEUTRON
                 else:
                     net_type = _NET_TYPE_COMPUTE
@@ -136,7 +133,7 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
             )
         )
 
-    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+    def get_parser(self, prog_name: str) -> _argparse.ArgumentParser:
         LOG.debug('get_parser(%s)', prog_name)
         parser = super().get_parser(prog_name)  # type: ignore
         parser = self.update_parser_common(parser)
@@ -163,11 +160,13 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
     def take_action(self, parsed_args):
         if self.is_neutron:
             return self.take_action_network(
-                self.app.client_manager.network, parsed_args
+                self.app.client_manager.network,  # type: ignore
+                parsed_args,
             )
         elif self.is_nova_network:
             return self.take_action_compute(
-                self.app.client_manager.compute, parsed_args
+                self.app.client_manager.compute,  # type: ignore
+                parsed_args,
             )
 
     def take_action_network(self, client, parsed_args):
@@ -203,6 +202,8 @@ class NetworkAndComputeDelete(NetworkAndComputeCommand, metaclass=abc.ABCMeta):
     following the rules in doc/source/command-errors.rst.
     """
 
+    resource: str
+
     def take_action(self, parsed_args):
         ret = 0
         resources = getattr(parsed_args, self.resource, [])

openstackclient/network/v2/address_group.py

@@ -16,10 +16,10 @@
 import logging
 
 import netaddr
-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 as identity_common
 from openstackclient.network import common
@@ -151,13 +151,14 @@ class ListAddressGroup(command.Lister):
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only address groups of given name in output"),
+            help=_("List only address groups with the specified name"),
         )
         parser.add_argument(
             '--project',
             metavar="<project>",
             help=_(
-                "List address groups according to their project (name or ID)"
+                "List only address groups with the specified project "
+                "(name or ID)"
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)

openstackclient/network/v2/address_scope.py

@@ -15,10 +15,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 as identity_common
 from openstackclient.network import common
@@ -160,7 +160,7 @@ class ListAddressScope(command.Lister):
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only address scopes of given name in output"),
+            help=_("List only address scopes with the specified name"),
         )
         parser.add_argument(
             '--ip-version',
@@ -169,14 +169,16 @@ class ListAddressScope(command.Lister):
             metavar='<ip-version>',
             dest='ip_version',
             help=_(
-                "List address scopes of given IP version networks (4 or 6)"
+                "List only address scopes with the specified IP version "
+                "networks (4 or 6)"
             ),
         )
         parser.add_argument(
             '--project',
             metavar="<project>",
             help=_(
-                "List address scopes according to their project (name or ID)"
+                "List only address scopes with the specified project "
+                "(name or ID)"
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
@@ -185,12 +187,12 @@ class ListAddressScope(command.Lister):
         shared_group.add_argument(
             '--share',
             action='store_true',
-            help=_("List address scopes shared between projects"),
+            help=_("List only address scopes shared between projects"),
         )
         shared_group.add_argument(
             '--no-share',
             action='store_true',
-            help=_("List address scopes not shared between projects"),
+            help=_("List only address scopes not shared between projects"),
         )
         return parser