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

openstackclient/object/client.py

@@ -19,12 +19,11 @@ from osc_lib import utils
 
 from openstackclient.api import object_store_v1
 
+# global variables used when building the shell
 DEFAULT_API_VERSION = '1'
 API_VERSION_OPTION = 'os_object_api_version'
 API_NAME = 'object_store'
-API_VERSIONS = {
-    '1': 'openstackclient.object.client.ObjectClientv1',
-}
+API_VERSIONS = ('1',)
 
 
 def make_client(instance):

openstackclient/object/v1/container.py

@@ -148,10 +148,9 @@ class ListContainer(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
+        columns: tuple[str, ...] = ('Name',)
         if parsed_args.long:
-            columns = ('Name', 'Bytes', 'Count')
-        else:
-            columns = ('Name',)
+            columns += ('Bytes', 'Count')
 
         kwargs = {}
         if parsed_args.prefix:

openstackclient/object/v1/object.py

@@ -162,16 +162,9 @@ class ListObject(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
+        columns: tuple[str, ...] = ('Name',)
         if parsed_args.long:
-            columns = (
-                'Name',
-                'Bytes',
-                'Hash',
-                'Content Type',
-                'Last Modified',
-            )
-        else:
-            columns = ('Name',)
+            columns += ('Bytes', 'Hash', 'Content Type', 'Last Modified')
 
         kwargs = {}
         if parsed_args.prefix:

openstackclient/shell.py

@@ -88,17 +88,34 @@ class OpenStackShell(shell.OpenStackShell):
                     # this throws an exception if invalid
                     skip_old_check = mod_check_api_version(version_opt)
 
+                # NOTE(stephenfin): API_VERSIONS has traditionally been a
+                # dictionary but the values are only used internally and are
+                # ignored for the modules using SDK. So we now support tuples
+                # instead.
                 mod_versions = getattr(mod, 'API_VERSIONS', None)
-                if not skip_old_check and mod_versions:
+                if mod_versions is not None and not isinstance(
+                    mod_versions, (dict, tuple)
+                ):
+                    raise TypeError(
+                        f'Plugin {mod} has incompatible API_VERSIONS. '
+                        f'Expected: tuple, dict. Got: {type(mod_versions)}. '
+                        f'Please report this to your package maintainer.'
+                    )
+
+                if mod_versions and not skip_old_check:
                     if version_opt not in mod_versions:
                         sorted_versions = sorted(
-                            mod.API_VERSIONS.keys(),
+                            list(mod.API_VERSIONS),
                             key=lambda s: list(map(int, s.split('.'))),
                         )
                         self.log.warning(
-                            "{} version {} is not in supported versions: {}".format(
-                                api, version_opt, ', '.join(sorted_versions)
-                            )
+                            "%(name)s API version %(version)s is not in "
+                            "supported versions: %(supported)s",
+                            {
+                                'name': api,
+                                'version': version_opt,
+                                'supported': ', '.join(sorted_versions),
+                            },
                         )
 
                 # Command groups deal only with major versions

openstackclient/tests/functional/base.py

@@ -36,8 +36,8 @@ def execute(cmd, *, fail_ok=False):
 
     proc = subprocess.Popen(cmdlist, stdout=stdout, stderr=stderr, env=env)
 
-    result_out, result_err = proc.communicate()
-    result_out = result_out.decode('utf-8')
+    result_out_b, result_err = proc.communicate()
+    result_out = result_out_b.decode('utf-8')
     LOG.debug('stdout: %s', result_out)
     LOG.debug('stderr: %s', result_err)
 

openstackclient/tests/functional/common/test_quota.py

@@ -25,7 +25,7 @@ class QuotaTests(base.TestCase):
     test runs as these may run in parallel and otherwise step on each other.
     """
 
-    PROJECT_NAME = None
+    PROJECT_NAME: str
 
     @classmethod
     def setUpClass(cls):
@@ -250,6 +250,8 @@ class QuotaTests(base.TestCase):
             row_headers = [str(r) for r in row.keys()]
             self.assertEqual(sorted(expected_headers), sorted(row_headers))
             resources.append(row['Resource'])
+            for header in expected_headers[1:]:
+                self.assertIsInstance(row[header], int)
         # Ensure that returned quota has network quota...
         self.assertIn("networks", resources)
         # ...and compute quota

openstackclient/tests/functional/compute/v2/common.py

@@ -22,9 +22,9 @@ from openstackclient.tests.functional import base
 class ComputeTestCase(base.TestCase):
     """Common functional test bits for Compute commands"""
 
-    flavor_name = None
-    image_name = None
-    network_arg = None
+    flavor_name: str
+    image_name: str
+    network_arg: str
 
     def setUp(self):
         """Select common resources"""
@@ -34,7 +34,7 @@ class ComputeTestCase(base.TestCase):
         self.network_arg = self.get_network()
 
     @classmethod
-    def get_flavor(cls):
+    def get_flavor(cls) -> str:
         # NOTE(rtheis): Get cirros256 or m1.tiny flavors since functional
         #               tests may create other flavors.
         flavors = cls.openstack("flavor list", parse_output=True)
@@ -43,10 +43,13 @@ class ComputeTestCase(base.TestCase):
             if flavor['Name'] in ['m1.tiny', 'cirros256']:
                 server_flavor = flavor['Name']
                 break
+
+        assert server_flavor is not None
+
         return server_flavor
 
     @classmethod
-    def get_image(cls):
+    def get_image(cls) -> str:
         # NOTE(rtheis): Get first Cirros image since functional tests may
         #               create other images.  Image may be named '-uec' or
         #               '-disk'.
@@ -59,10 +62,13 @@ class ComputeTestCase(base.TestCase):
             ):
                 server_image = image['Name']
                 break
+
+        assert server_image is not None
+
         return server_image
 
     @classmethod
-    def get_network(cls):
+    def get_network(cls) -> str:
         try:
             # NOTE(rtheis): Get private network since functional tests may
             #               create other networks.

openstackclient/tests/functional/compute/v2/test_server.py

@@ -156,7 +156,7 @@ class ServerTests(common.ComputeTestCase):
         server_name3 = cmd_output['name']
 
         cmd_output = self.openstack(
-            'server list ' '--changes-since ' + updated_at2,
+            'server list --changes-since ' + updated_at2,
             parse_output=True,
         )
 
@@ -852,8 +852,7 @@ class ServerTests(common.ComputeTestCase):
             # it to the server at /dev/vdb and delete the volume when the
             # server is deleted.
             bdm_arg = (
-                f'--block-device-mapping '
-                f'vdb={self.image_name}:image:1:true '
+                f'--block-device-mapping vdb={self.image_name}:image:1:true '
             )
         else:
             # get image ID

openstackclient/tests/functional/compute/v2/test_server_event.py

@@ -93,7 +93,7 @@ class ServerEventTests(common.ComputeTestCase):
         # And verify we can get the event list after it's deleted
         # Test 'server event list' for deleting
         cmd_output = self.openstack(
-            '--os-compute-api-version 2.21 ' 'server event list ' + server_id,
+            '--os-compute-api-version 2.21 server event list ' + server_id,
             parse_output=True,
         )
         request_id = None

openstackclient/tests/functional/identity/v2/test_user.py

@@ -37,7 +37,7 @@ class UserTests(common.IdentityTests):
         new_username = data_utils.rand_name('NewTestUser')
         new_email = data_utils.rand_name() + '@example.com'
         raw_output = self.openstack(
-            'user set ' '--email {email} ' '--name {new_name} ' '{id}'.format(
+            'user set --email {email} --name {new_name} {id}'.format(
                 email=new_email, new_name=new_username, id=user['id']
             )
         )

openstackclient/tests/functional/identity/v3/common.py

@@ -187,8 +187,7 @@ class IdentityTests(base.TestCase):
                 f'domain set --disable {cls.domain_name}'
             )
             cls.openstack(
-                '--os-identity-api-version 3 '
-                f'domain delete {cls.domain_name}'
+                f'--os-identity-api-version 3 domain delete {cls.domain_name}'
             )
         finally:
             super().tearDownClass()
@@ -270,9 +269,7 @@ class IdentityTests(base.TestCase):
         if add_clean_up:
             self.addCleanup(
                 self.openstack,
-                'group delete '
-                f'--domain {self.domain_name} '
-                f'{group_name}',
+                f'group delete --domain {self.domain_name} {group_name}',
             )
         items = self.parse_show(raw_output)
         self.assert_show_fields(items, self.GROUP_FIELDS)
@@ -305,9 +302,7 @@ class IdentityTests(base.TestCase):
         if add_clean_up:
             self.addCleanup(
                 self.openstack,
-                'project delete '
-                f'--domain {self.domain_name} '
-                f'{project_name}',
+                f'project delete --domain {self.domain_name} {project_name}',
             )
         return project_name
 

openstackclient/tests/functional/identity/v3/test_application_credential.py

@@ -50,35 +50,35 @@ class ApplicationCredentialTests(common.IdentityTests):
     def _create_role_assignments(self):
         try:
             user = self.openstack(
-                'configuration show -f value' ' -c auth.username'
+                'configuration show -f value -c auth.username'
             )
         except Exception:
             user = self.openstack(
-                'configuration show -f value' ' -c auth.user_id'
+                'configuration show -f value -c auth.user_id'
             )
         try:
             user_domain = self.openstack(
-                'configuration show -f value' ' -c auth.user_domain_name'
+                'configuration show -f value -c auth.user_domain_name'
             )
         except Exception:
             user_domain = self.openstack(
-                'configuration show -f value' ' -c auth.user_domain_id'
+                'configuration show -f value -c auth.user_domain_id'
             )
         try:
             project = self.openstack(
-                'configuration show -f value' ' -c auth.project_name'
+                'configuration show -f value -c auth.project_name'
             )
         except Exception:
             project = self.openstack(
-                'configuration show -f value' ' -c auth.project_id'
+                'configuration show -f value -c auth.project_id'
             )
         try:
             project_domain = self.openstack(
-                'configuration show -f value' ' -c auth.project_domain_name'
+                'configuration show -f value -c auth.project_domain_name'
             )
         except Exception:
             project_domain = self.openstack(
-                'configuration show -f value' ' -c auth.project_domain_id'
+                'configuration show -f value -c auth.project_domain_id'
             )
         role1 = self._create_dummy_role()
         role2 = self._create_dummy_role()
@@ -130,7 +130,7 @@ class ApplicationCredentialTests(common.IdentityTests):
     def test_application_credential_delete(self):
         name = data_utils.rand_name('name')
         self.openstack(f'application credential create {name}')
-        raw_output = self.openstack('application credential delete ' f'{name}')
+        raw_output = self.openstack(f'application credential delete {name}')
         self.assertEqual(0, len(raw_output))
 
     def test_application_credential_list(self):
@@ -147,6 +147,6 @@ class ApplicationCredentialTests(common.IdentityTests):
             self.openstack,
             f'application credential delete {name}',
         )
-        raw_output = self.openstack('application credential show ' f'{name}')
+        raw_output = self.openstack(f'application credential show {name}')
         items = self.parse_show(raw_output)
         self.assert_show_fields(items, self.APPLICATION_CREDENTIAL_FIELDS)

openstackclient/tests/functional/identity/v3/test_endpoint.py

@@ -45,7 +45,7 @@ class EndpointTests(common.IdentityTests):
         endpoint_id = self._create_dummy_endpoint(add_clean_up=False)
         project_id = self._create_dummy_project(add_clean_up=False)
         raw_output = self.openstack(
-            'endpoint add project ' f'{endpoint_id} ' f'{project_id}'
+            f'endpoint add project {endpoint_id} {project_id}'
         )
         self.assertEqual(0, len(raw_output))
         raw_output = self.openstack(f'endpoint list --endpoint {endpoint_id}')
@@ -89,11 +89,11 @@ class EndpointTests(common.IdentityTests):
         endpoint_id = self._create_dummy_endpoint(add_clean_up=False)
         project_id = self._create_dummy_project(add_clean_up=False)
         raw_output = self.openstack(
-            'endpoint add project ' f'{endpoint_id} ' f'{project_id}'
+            f'endpoint add project {endpoint_id} {project_id}'
         )
         self.assertEqual(0, len(raw_output))
 
         raw_output = self.openstack(
-            'endpoint remove project ' f'{endpoint_id} ' f'{project_id}'
+            f'endpoint remove project {endpoint_id} {project_id}'
         )
         self.assertEqual(0, len(raw_output))

openstackclient/tests/functional/identity/v3/test_group.py

@@ -36,14 +36,14 @@ class GroupTests(common.IdentityTests):
     def test_group_delete(self):
         group_name = self._create_dummy_group(add_clean_up=False)
         raw_output = self.openstack(
-            'group delete ' f'--domain {self.domain_name} ' f'{group_name}'
+            f'group delete --domain {self.domain_name} {group_name}'
         )
         self.assertEqual(0, len(raw_output))
 
     def test_group_show(self):
         group_name = self._create_dummy_group()
         raw_output = self.openstack(
-            'group show ' f'--domain {self.domain_name} ' f'{group_name}'
+            f'group show --domain {self.domain_name} {group_name}'
         )
         items = self.parse_show(raw_output)
         self.assert_show_fields(items, self.GROUP_FIELDS)
@@ -59,7 +59,7 @@ class GroupTests(common.IdentityTests):
         )
         self.assertEqual(0, len(raw_output))
         raw_output = self.openstack(
-            'group show ' f'--domain {self.domain_name} ' f'{new_group_name}'
+            f'group show --domain {self.domain_name} {new_group_name}'
         )
         group = self.parse_show_as_object(raw_output)
         self.assertEqual(new_group_name, group['name'])

openstackclient/tests/functional/identity/v3/test_idp.py

@@ -54,13 +54,9 @@ class IdentityProviderTests(common.IdentityTests):
         identity_provider = self._create_dummy_idp(add_clean_up=True)
         new_remoteid = data_utils.rand_name('newRemoteId')
         raw_output = self.openstack(
-            'identity provider set '
-            '%(identity-provider)s '
-            '--remote-id %(remote-id)s '
-            % {
-                'identity-provider': identity_provider,
-                'remote-id': new_remoteid,
-            }
+            f'identity provider set '
+            f'{identity_provider} '
+            f'--remote-id {new_remoteid}'
         )
         self.assertEqual(0, len(raw_output))
         raw_output = self.openstack(

openstackclient/tests/functional/identity/v3/test_limit.py

@@ -174,7 +174,7 @@ class LimitTestCase(common.IdentityTests):
         }
 
         raw_output = self.openstack(
-            'limit set' ' --description {description}' ' {limit_id}'.format(
+            'limit set --description {description} {limit_id}'.format(
                 **params
             ),
             cloud=SYSTEM_CLOUD,
@@ -188,9 +188,9 @@ class LimitTestCase(common.IdentityTests):
         params = {'resource_limit': 5, 'limit_id': limit_id}
 
         raw_output = self.openstack(
-            'limit set'
-            ' --resource-limit {resource_limit}'
-            ' {limit_id}'.format(**params),
+            'limit set --resource-limit {resource_limit} {limit_id}'.format(
+                **params
+            ),
             cloud=SYSTEM_CLOUD,
         )
         items = self.parse_show(raw_output)

openstackclient/tests/functional/identity/v3/test_project.py

@@ -30,9 +30,7 @@ class ProjectTests(common.IdentityTests):
         )
         self.addCleanup(
             self.openstack,
-            'project delete '
-            f'--domain {self.domain_name} '
-            f'{project_name}',
+            f'project delete --domain {self.domain_name} {project_name}',
         )
         items = self.parse_show(raw_output)
         show_fields = list(self.PROJECT_FIELDS)
@@ -45,7 +43,7 @@ class ProjectTests(common.IdentityTests):
     def test_project_delete(self):
         project_name = self._create_dummy_project(add_clean_up=False)
         raw_output = self.openstack(
-            'project delete ' f'--domain {self.domain_name} ' f'{project_name}'
+            f'project delete --domain {self.domain_name} {project_name}'
         )
         self.assertEqual(0, len(raw_output))
 
@@ -77,9 +75,7 @@ class ProjectTests(common.IdentityTests):
         self.assertEqual(0, len(raw_output))
         # check project details
         raw_output = self.openstack(
-            'project show '
-            f'--domain {self.domain_name} '
-            f'{new_project_name}'
+            f'project show --domain {self.domain_name} {new_project_name}'
         )
         items = self.parse_show(raw_output)
         fields = list(self.PROJECT_FIELDS)
@@ -91,17 +87,12 @@ class ProjectTests(common.IdentityTests):
         self.assertEqual('v0', project['k0'])
         # reset project to make sure it will be cleaned up
         self.openstack(
-            'project set '
-            f'--name {project_name} '
-            '--enable '
-            f'{new_project_name}'
+            f'project set --name {project_name} --enable {new_project_name}'
         )
 
     def test_project_show(self):
         raw_output = self.openstack(
-            'project show '
-            f'--domain {self.domain_name} '
-            f'{self.project_name}'
+            f'project show --domain {self.domain_name} {self.project_name}'
         )
         items = self.parse_show(raw_output)
         self.assert_show_fields(items, self.PROJECT_FIELDS)

openstackclient/tests/functional/identity/v3/test_region.py

@@ -49,9 +49,7 @@ class RegionTests(common.IdentityTests):
         self.assertEqual(region_id, region['region'])
         # update parent-region
         raw_output = self.openstack(
-            'region set '
-            f'--parent-region {new_parent_region_id} '
-            f'{region_id}'
+            f'region set --parent-region {new_parent_region_id} {region_id}'
         )
         self.assertEqual(0, len(raw_output))
         # check updated region details

openstackclient/tests/functional/identity/v3/test_registered_limit.py

@@ -25,7 +25,7 @@ class RegisteredLimitTestCase(common.IdentityTests):
 
     def test_registered_limit_create_with_service_id(self):
         service_name = self._create_dummy_service()
-        raw_output = self.openstack('service show' f' {service_name}')
+        raw_output = self.openstack(f'service show {service_name}')
         service_items = self.parse_show(raw_output)
         service_id = self._extract_value_from_items('id', service_items)
 
@@ -44,7 +44,7 @@ class RegisteredLimitTestCase(common.IdentityTests):
         registered_limit_id = self._extract_value_from_items('id', items)
         self.addCleanup(
             self.openstack,
-            'registered limit delete' f' {registered_limit_id}',
+            f'registered limit delete {registered_limit_id}',
             cloud=SYSTEM_CLOUD,
         )
 
@@ -178,7 +178,7 @@ class RegisteredLimitTestCase(common.IdentityTests):
             add_clean_up=False
         )
         raw_output = self.openstack(
-            'registered limit delete' f' {registered_limit_id}',
+            f'registered limit delete {registered_limit_id}',
             cloud=SYSTEM_CLOUD,
         )
         self.assertEqual(0, len(raw_output))

openstackclient/tests/functional/identity/v3/test_role.py

@@ -23,7 +23,7 @@ class RoleTests(common.IdentityTests):
         role_name = data_utils.rand_name('TestRole')
         description = data_utils.rand_name('description')
         raw_output = self.openstack(
-            'role create ' f'--description {description} ' f'{role_name}'
+            f'role create --description {description} {role_name}'
         )
         role = self.parse_show_as_object(raw_output)
         self.addCleanup(self.openstack, 'role delete {}'.format(role['id']))

openstackclient/tests/functional/identity/v3/test_role_assignment.py

@@ -24,35 +24,25 @@ class RoleAssignmentTests(common.IdentityTests):
         username = self._create_dummy_user()
         system = 'all'
         raw_output = self.openstack(
-            'role add '
-            f'--user {username} '
-            f'--system {system} '
-            f'{role_name}'
+            f'role add --user {username} --system {system} {role_name}'
         )
         self.addCleanup(
             self.openstack,
-            'role remove '
-            f'--user {username} '
-            f'--system  {system} '
-            f'{role_name}',
+            f'role remove --user {username} --system  {system} {role_name}',
         )
         self.assertEqual(0, len(raw_output))
 
-        raw_output = self.openstack(
-            'role assignment list ' f'--user {username} '
-        )
+        raw_output = self.openstack(f'role assignment list --user {username} ')
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, self.ROLE_ASSIGNMENT_LIST_HEADERS)
 
         raw_output = self.openstack(
-            'role assignment list ' f'--role {role_name} '
+            f'role assignment list --role {role_name} '
         )
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, self.ROLE_ASSIGNMENT_LIST_HEADERS)
 
-        raw_output = self.openstack(
-            'role assignment list ' f'--system {system} '
-        )
+        raw_output = self.openstack(f'role assignment list --system {system} ')
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, self.ROLE_ASSIGNMENT_LIST_HEADERS)
 
@@ -61,22 +51,14 @@ class RoleAssignmentTests(common.IdentityTests):
         group = self._create_dummy_group()
         system = 'all'
         raw_output = self.openstack(
-            'role add '
-            f'--group {group} '
-            f'--system {system} '
-            f'{role_name}'
+            f'role add --group {group} --system {system} {role_name}'
         )
         self.addCleanup(
             self.openstack,
-            'role remove '
-            f'--group {group} '
-            f'--system {system} '
-            f'{role_name}',
+            f'role remove --group {group} --system {system} {role_name}',
         )
         self.assertEqual(0, len(raw_output))
-        raw_output = self.openstack(
-            'role assignment list ' f'--group {group} '
-        )
+        raw_output = self.openstack(f'role assignment list --group {group} ')
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, self.ROLE_ASSIGNMENT_LIST_HEADERS)
 
@@ -98,7 +80,7 @@ class RoleAssignmentTests(common.IdentityTests):
         )
         self.assertEqual(0, len(raw_output))
         raw_output = self.openstack(
-            'role assignment list ' f'--domain {self.domain_name} '
+            f'role assignment list --domain {self.domain_name} '
         )
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, self.ROLE_ASSIGNMENT_LIST_HEADERS)
@@ -121,23 +103,23 @@ class RoleAssignmentTests(common.IdentityTests):
         )
         self.assertEqual(0, len(raw_output))
         raw_output = self.openstack(
-            'role assignment list ' f'--project {self.project_name} '
+            f'role assignment list --project {self.project_name} '
         )
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, self.ROLE_ASSIGNMENT_LIST_HEADERS)
 
     def test_role_assignment_list_effective(self):
-        raw_output = self.openstack('role assignment list ' '--effective')
+        raw_output = self.openstack('role assignment list --effective')
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, self.ROLE_ASSIGNMENT_LIST_HEADERS)
 
     def test_role_assignment_list_auth_user(self):
-        raw_output = self.openstack('role assignment list ' '--auth-user')
+        raw_output = self.openstack('role assignment list --auth-user')
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, self.ROLE_ASSIGNMENT_LIST_HEADERS)
 
     def test_role_assignment_list_auth_project(self):
-        raw_output = self.openstack('role assignment list ' '--auth-project')
+        raw_output = self.openstack('role assignment list --auth-project')
         items = self.parse_listing(raw_output)
         self.assert_table_structure(items, self.ROLE_ASSIGNMENT_LIST_HEADERS)
 

openstackclient/tests/functional/identity/v3/test_service_provider.py

@@ -52,13 +52,9 @@ class ServiceProviderTests(common.IdentityTests):
         service_provider = self._create_dummy_sp(add_clean_up=True)
         new_description = data_utils.rand_name('newDescription')
         raw_output = self.openstack(
-            'service provider set '
-            '%(service-provider)s '
-            '--description %(description)s '
-            % {
-                'service-provider': service_provider,
-                'description': new_description,
-            }
+            f'service provider set '
+            f'{service_provider} '
+            f'--description {new_description}'
         )
         updated_value = self.parse_show_as_object(raw_output)
         self.assertEqual(new_description, updated_value.get('description'))