python-openstackclient 10.0.0__py3-none-any.whl → 10.1.0__py3-none-any.whl

openstackclient/common/availability_zone.py

@@ -130,7 +130,7 @@ class ListAvailabilityZone(command.Lister):
             data = list(compute_client.availability_zones(details=True))
         except sdk_exceptions.ForbiddenException:  # policy doesn't allow
             try:
-                data = compute_client.availability_zones(details=False)
+                data = list(compute_client.availability_zones(details=False))
             except Exception:
                 raise
 

openstackclient/common/module.py

@@ -16,6 +16,7 @@
 """Module action implementation"""
 
 import argparse
+import importlib.metadata
 import sys
 from collections.abc import Iterable, Sequence
 from typing import Any
@@ -93,36 +94,29 @@ class ListModule(command.ShowOne):
     ) -> tuple[Sequence[str], Iterable[Any]]:
         data = {}
         # Get module versions
-        mods = sys.modules
-        for k in mods.keys():
-            k = k.split('.')[0]
+        package_distributions = importlib.metadata.packages_distributions()
+        for k in sys.modules.keys():
+            module = k.split('.')[0]
             # Skip private modules and the modules that had been added,
             # like: keystoneclient, keystoneclient.exceptions and
             # keystoneclient.auth
-            if not k.startswith('_') and k not in data:
-                # TODO(dtroyer): Need a better way to decide which modules to
-                #                show for the default (not --all) invocation.
-                #                It should be just the things we actually care
-                #                about like client and plugin modules...
-                if (
-                    parsed_args.all
-                    or
-                    # Handle xxxclient and openstacksdk
-                    (k.endswith('client') or k == 'openstack')
-                ):
-                    try:
-                        # NOTE(RuiChen): openstacksdk bug/1588823 exist,
-                        #                no good way to add __version__ for
-                        #                openstack module properly, hard code
-                        #                looks bad, but openstacksdk module
-                        #                information is important.
-                        if k == 'openstack':
-                            data[k] = mods[k].version.__version__
-                        else:
-                            data[k] = mods[k].__version__
-                    except Exception:  # noqa: S110
-                        # Catch all exceptions, just skip it
-                        pass
+            if module.startswith('_') or module in data:
+                continue
+
+            # TODO(dtroyer): Need a better way to decide which modules to
+            #                show for the default (not --all) invocation.
+            #                It should be just the things we actually care
+            #                about like client and plugin modules...
+            # Handle xxxclient and openstacksdk
+            if parsed_args.all or (
+                module.endswith('client') or module == 'openstack'
+            ):
+                try:
+                    package = package_distributions[module][0]
+                    data[module] = importlib.metadata.version(package)
+                except Exception:  # noqa: S110
+                    # Catch all exceptions, just skip it
+                    pass
 
         col_headers, col_data = zip(*sorted(data.items()))
         return col_headers, col_data

openstackclient/common/pagination.py

@@ -21,8 +21,11 @@ from openstackclient.i18n import _
 # useful
 
 
+# TODO(stephenfin): include_max_items should not be necessary once we need to
+# migrate remaining users to openstacksdk
 def add_marker_pagination_option_to_parser(
     parser: argparse.ArgumentParser,
+    include_max_items: bool = True,
 ) -> None:
     """Add marker-based pagination options to the parser.
 
@@ -39,8 +42,11 @@ def add_marker_pagination_option_to_parser(
         type=int,
         action=parseractions.NonNegativeAction,
         help=_(
-            'The maximum number of entries to return. If the value exceeds '
-            'the server-defined maximum, then the maximum value will be used.'
+            'The maximum number of entries to return per page. If the value '
+            'exceeds the server-defined maximum, then the server-defined '
+            'value will be used. Note that this controls the page size, not '
+            'the total number of entries returned. Use --max-items to limit '
+            'the total number of entries returned.'
         ),
     )
     parser.add_argument(
@@ -52,10 +58,26 @@ def add_marker_pagination_option_to_parser(
             'This should be a value that was returned in a previous request.'
         ),
     )
+    if include_max_items:
+        parser.add_argument(
+            '--max-items',
+            metavar='<max-items>',
+            type=int,
+            action=parseractions.NonNegativeAction,
+            default=None,
+            help=_(
+                'The maximum number of entries to return in total, paging '
+                'through multiple requests if needed. Use --limit to control '
+                'the page size.'
+            ),
+        )
 
 
+# TODO(stephenfin): include_max_items should not be necessary once we need to
+# migrate remaining users to openstacksdk
 def add_offset_pagination_option_to_parser(
     parser: argparse.ArgumentParser,
+    include_max_items: bool = True,
 ) -> None:
     """Add offset-based pagination options to the parser.
 
@@ -71,8 +93,11 @@ def add_offset_pagination_option_to_parser(
         type=int,
         action=parseractions.NonNegativeAction,
         help=_(
-            'The maximum number of entries to return. If the value exceeds '
-            'the server-defined maximum, then the maximum value will be used.'
+            'The maximum number of entries to return per page. If the value '
+            'exceeds the server-defined maximum, then the maximum value will '
+            'be used. Note that this controls the page size, not the total '
+            'number of entries returned. Use --max-items to limit the total '
+            'number of entries returned.'
         ),
     )
     parser.add_argument(
@@ -86,3 +111,16 @@ def add_offset_pagination_option_to_parser(
             'return.'
         ),
     )
+    if include_max_items:
+        parser.add_argument(
+            '--max-items',
+            metavar='<max-items>',
+            type=int,
+            action=parseractions.NonNegativeAction,
+            default=None,
+            help=_(
+                'The maximum number of entries to return in total, paging '
+                'through multiple requests if needed. Use --limit to control '
+                'the page size.'
+            ),
+        )

openstackclient/common/project_cleanup.py

@@ -105,8 +105,7 @@ class ProjectCleanup(command.Command):
             project = identity_client.find_project(
                 name_or_id=parsed_args.project, ignore_missing=False
             )
-            # FIXME(stephenfin): The type in SDK is wrong
-            connection = connection.connect_as_project(project)  # type: ignore
+            connection = connection.connect_as_project(project)
 
         if connection:
             status_queue: queue.Queue[Any] = queue.Queue()

openstackclient/common/quota.py

@@ -51,6 +51,7 @@ VOLUME_QUOTAS = {
     'backups': 'backups',
     'backup_gigabytes': 'backup-gigabytes',
     'gigabytes': 'gigabytes',
+    'groups': 'groups',
     'per_volume_gigabytes': 'per-volume-gigabytes',
     'snapshots': 'snapshots',
     'volumes': 'volumes',
@@ -70,6 +71,7 @@ NETWORK_QUOTAS = {
     'subnet': 'subnets',
     'port': 'ports',
     'router': 'routers',
+    'router_route': 'router-routes',
     'rbac_policy': 'rbac-policies',
     'subnetpool': 'subnetpools',
 }
@@ -78,6 +80,7 @@ NETWORK_KEYS = [
     'floating_ips',
     'networks',
     'rbac_policies',
+    'router_routes',
     'routers',
     'ports',
     'security_group_rules',
@@ -102,7 +105,7 @@ def _xform_get_quota(
     return res
 
 
-def get_project(app: Any, project: str | None) -> dict[str, str | None]:
+def get_project(app: Any, project: str | None) -> dict[str, str]:
     if project is not None:
         identity_client = sdk_utils.ensure_service_version(
             app.client_manager.sdk_connection.identity, '3'
@@ -112,14 +115,11 @@ def get_project(app: Any, project: str | None) -> dict[str, str | None]:
         )
         project_id = found_project.id
         project_name = found_project.name
-    elif app.client_manager.auth_ref:
+    else:
         # Get the project from the current auth
         auth_ref = app.client_manager.auth_ref
         project_id = auth_ref.project_id
         project_name = auth_ref.project_name
-    else:
-        project_id = None
-        project_name = None
 
     return {
         'id': project_id,
@@ -376,6 +376,7 @@ class ListQuota(command.Lister):
             'backups',
             'backup_gigabytes',
             'gigabytes',
+            'groups',
             'per_volume_gigabytes',
             'snapshots',
             'volumes',
@@ -385,6 +386,7 @@ class ListQuota(command.Lister):
             'Backups',
             'Backup Gigabytes',
             'Gigabytes',
+            'Groups',
             'Per Volume Gigabytes',
             'Snapshots',
             'Volumes',
@@ -439,6 +441,7 @@ class ListQuota(command.Lister):
             'networks',
             'ports',
             'rbac_policies',
+            'router_routes',
             'routers',
             'security_groups',
             'security_group_rules',
@@ -451,6 +454,7 @@ class ListQuota(command.Lister):
             'Networks',
             'Ports',
             'RBAC Policies',
+            'Router Routes',
             'Routers',
             'Security Groups',
             'Security Group Rules',

openstackclient/compute/v2/flavor.py

@@ -339,6 +339,8 @@ class ListFlavor(command.Lister):
 
         if parsed_args.limit:
             query_attrs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            query_attrs['max_items'] = parsed_args.max_items
 
         if parsed_args.limit or parsed_args.marker:
             # User passed explicit pagination request, switch off SDK
@@ -351,7 +353,7 @@ class ListFlavor(command.Lister):
         if parsed_args.min_ram:
             query_attrs['min_ram'] = parsed_args.min_ram
 
-        data = list(compute_client.flavors(**query_attrs))
+        data = list(compute_client.flavors(**query_attrs))  # type: ignore[arg-type]
         # Even if server supports 2.61 some policy might stop it sending us
         # extra_specs. So try to fetch them if they are absent
         for f in data:

openstackclient/compute/v2/hypervisor.py

@@ -122,6 +122,8 @@ class ListHypervisor(command.Lister):
                 )
                 raise exceptions.CommandError(msg)
             list_opts['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            list_opts['max_items'] = parsed_args.max_items
 
         if parsed_args.matching:
             list_opts['hypervisor_hostname_pattern'] = parsed_args.matching

openstackclient/compute/v2/keypair.py

@@ -23,6 +23,7 @@ from typing import Any
 
 from cryptography.hazmat.primitives.asymmetric import ed25519
 from cryptography.hazmat.primitives import serialization
+from openstack.compute.v2 import keypair as _keypair
 from openstack import resource
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
@@ -336,7 +337,10 @@ class ListKeypair(command.Lister):
                 raise exceptions.CommandError(msg)
 
             kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            kwargs['max_items'] = parsed_args.max_items
 
+        data: list[_keypair.Keypair]
         if parsed_args.project:
             if not sdk_utils.supports_microversion(compute_client, '2.10'):
                 msg = _(
@@ -386,9 +390,9 @@ class ListKeypair(command.Lister):
             )
             kwargs['user_id'] = user.id
 
-            data = compute_client.keypairs(**kwargs)
+            data = list(compute_client.keypairs(**kwargs))
         else:
-            data = compute_client.keypairs(**kwargs)
+            data = list(compute_client.keypairs(**kwargs))
 
         columns: tuple[str, ...] = ("Name", "Fingerprint")
 

openstackclient/compute/v2/server.py

@@ -2854,6 +2854,9 @@ class ListServer(command.Lister):
             search_opts['limit'] = parsed_args.limit
             search_opts['paginated'] = False
 
+        if parsed_args.max_items is not None:
+            search_opts['max_items'] = parsed_args.max_items
+
         LOG.debug('search options: %s', search_opts)
 
         if search_opts['changes-before']:
@@ -3102,8 +3105,8 @@ class ListServer(command.Lister):
             else:
                 try:
                     flavors_list = compute_client.flavors(is_public=None)
-                    for i in flavors_list:
-                        flavors[i.id] = i
+                    for f in flavors_list:
+                        flavors[f.id] = f
                 except Exception:  # noqa: S110
                     # retrieving flavor names is not crucial, so we swallow any
                     # exceptions
@@ -3124,29 +3127,33 @@ class ListServer(command.Lister):
             if 'id' in s.image and s.image.id is not None:
                 image = images.get(s.image['id'])
                 if image:
-                    s.image_name = image.name
+                    setattr(s, 'image_name', image.name)
                 s.image_id = s.image['id']
             else:
                 # NOTE(melwitt): An server booted from a volume will have no
                 # image associated with it. We fill in the Image Name and ID
                 # with "N/A (booted from volume)" to help users who want to be
                 # able to grep for boot-from-volume servers when using the CLI.
-                s.image_name = IMAGE_STRING_FOR_BFV
+                setattr(s, 'image_name', IMAGE_STRING_FOR_BFV)
                 s.image_id = IMAGE_STRING_FOR_BFV
 
             if not sdk_utils.supports_microversion(compute_client, '2.47'):
                 if s.flavor['id'] in flavors:
-                    s.flavor_name = flavors[s.flavor['id']].name
+                    setattr(s, 'flavor_name', flavors[s.flavor['id']].name)
                 s.flavor_id = s.flavor['id']
             else:
-                s.flavor_name = s.flavor['original_name']
+                setattr(s, 'flavor_name', s.flavor['original_name'])
 
         # Add a list with security group name as attribute
         for s in data:
             if hasattr(s, 'security_groups') and s.security_groups is not None:
-                s.security_groups_name = [x["name"] for x in s.security_groups]
+                setattr(
+                    s,
+                    'security_groups_name',
+                    [x["name"] for x in s.security_groups],
+                )
             else:
-                s.security_groups_name = []
+                setattr(s, 'security_groups_name', [])
 
         # The host_status field contains the status of the compute host the
         # server is on. It is only returned by the API when the nova-api
@@ -4256,7 +4263,9 @@ volume from a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``."""
 
     def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
-        volume_client = self.app.client_manager.sdk_connection.volume
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         server = compute_client.find_server(
             parsed_args.server,
@@ -4268,8 +4277,8 @@ volume from a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``."""
         )
 
         compute_client.delete_volume_attachment(
-            volume,
             server,
+            volume,
             ignore_missing=False,
         )
 
@@ -4919,8 +4928,8 @@ information for the server."""
         )
 
         if parsed_args.diagnostics:
-            data = compute_client.get_server_diagnostics(server)
-            col_headers, col_data = zip(*sorted(data.items()))
+            diagnostics = compute_client.get_server_diagnostics(server)
+            col_headers, col_data = zip(*sorted(diagnostics.items()))
             return col_headers, col_data
 
         topology = None

openstackclient/compute/v2/server_event.py

@@ -23,6 +23,7 @@ import uuid
 
 from cliff import columns
 import iso8601
+from openstack.compute.v2 import server_action as _server_action
 from openstack import exceptions as sdk_exceptions
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
@@ -67,7 +68,8 @@ class ServerActionEventColumn(columns.FormattableColumn[Any]):
     objects as we'd like.
     """
 
-    def _format_event(self, event: Any) -> dict[str, Any]:
+    @staticmethod
+    def _format_event(event: _server_action.ServerAction) -> dict[str, Any]:
         hidden_columns = ['id', 'name', 'location']
         _, columns = utils.get_osc_show_columns_for_sdk_resource(
             event, {}, hidden_columns
@@ -171,6 +173,9 @@ class ListServerEvent(command.Lister):
             kwargs['limit'] = parsed_args.limit
             kwargs['paginated'] = False
 
+        if parsed_args.max_items is not None:
+            kwargs['max_items'] = parsed_args.max_items
+
         if parsed_args.changes_since:
             if not sdk_utils.supports_microversion(compute_client, '2.58'):
                 msg = _(
@@ -295,6 +300,8 @@ class ShowServerEvent(command.ShowOne):
             parsed_args.request_id,
             server_id,
         )
+        # this is a bug is SDK
+        assert server_action is not None
 
         column_headers, columns = _get_server_event_columns(
             server_action,

openstackclient/compute/v2/server_group.py

@@ -219,6 +219,8 @@ class ListServerGroup(command.Lister):
 
         if parsed_args.limit:
             kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            kwargs['max_items'] = parsed_args.max_items
 
         data = compute_client.server_groups(**kwargs)
 

openstackclient/compute/v2/server_migration.py

@@ -207,6 +207,9 @@ class ListMigration(command.Lister):
             search_opts['limit'] = parsed_args.limit
             search_opts['paginated'] = False
 
+        if parsed_args.max_items is not None:
+            search_opts['max_items'] = parsed_args.max_items
+
         if parsed_args.changes_since:
             if not sdk_utils.supports_microversion(compute_client, "2.59"):
                 msg = _(

openstackclient/compute/v2/server_volume.py

@@ -121,7 +121,9 @@ class SetServerVolume(command.Command):
 
     def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
-        volume_client = self.app.client_manager.sdk_connection.volume
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         if parsed_args.delete_on_termination is not None:
             if not sdk_utils.supports_microversion(compute_client, '2.85'):

openstackclient/compute/v2/service.py

@@ -290,8 +290,10 @@ class SetService(command.Command):
                 msg = _('--os-compute-api-version 2.11 or later is required')
                 raise exceptions.CommandError(msg)
             try:
+                # FIXME(stephenfin): This is broken between 2.11 and 2.53. What
+                # is the expected ID here?
                 compute_client.update_service_forced_down(
-                    service_id,
+                    service_id,  # type: ignore[arg-type]
                     parsed_args.host,
                     parsed_args.service,
                     force_down,

openstackclient/compute/v2/usage.py

@@ -157,7 +157,7 @@ class ListUsage(command.Lister):
         )
 
         date_cli_format = "%Y-%m-%d"
-        now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
+        now = datetime.datetime.now(datetime.UTC).replace(tzinfo=None)
 
         if parsed_args.start:
             start = datetime.datetime.strptime(
@@ -243,7 +243,7 @@ class ShowUsage(command.ShowOne):
         identity_client = self.app.client_manager.identity
         compute_client = self.app.client_manager.compute
         date_cli_format = "%Y-%m-%d"
-        now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
+        now = datetime.datetime.now(datetime.UTC).replace(tzinfo=None)
 
         if parsed_args.start:
             start = datetime.datetime.strptime(

openstackclient/identity/common.py

@@ -25,6 +25,8 @@ from keystoneclient.v3 import groups
 from keystoneclient.v3 import projects
 from keystoneclient.v3 import users
 from openstack import exceptions as sdk_exceptions
+from openstack.identity import v3 as identity
+from openstack.identity.v3 import service as _service
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -78,7 +80,9 @@ def find_service(identity_client: Any, name_type_or_id: str) -> Any:
         raise exceptions.CommandError(msg % name_type_or_id)
 
 
-def find_service_sdk(identity_client: Any, name_type_or_id: str) -> Any:
+def find_service_sdk(
+    identity_client: identity.Proxy, name_type_or_id: str
+) -> _service.Service:
     """Find a service by id, name or type."""
 
     try:

openstackclient/identity/v3/access_rule.py

@@ -55,6 +55,9 @@ class DeleteAccessRule(command.Command):
             # this will never happen
             raise exceptions.CommandError('invalid authentication info')
         user_id = auth.get_user_id(conn.session)
+        if user_id is None:
+            # this will never happen
+            raise exceptions.CommandError('invalid authentication info')
 
         errors = 0
         for ac in parsed_args.access_rule:
@@ -146,6 +149,9 @@ class ShowAccessRule(command.ShowOne):
             # this will never happen
             raise exceptions.CommandError('invalid authentication info')
         user_id = auth.get_user_id(conn.session)
+        if user_id is None:
+            # this will never happen
+            raise exceptions.CommandError('invalid authentication info')
 
         access_rule = identity_client.get_access_rule(
             user_id, parsed_args.access_rule

openstackclient/identity/v3/application_credential.py

@@ -24,6 +24,9 @@ from typing import Any
 import uuid
 
 from cliff import columns as cliff_columns
+from openstack.identity.v3 import (
+    application_credential as _application_credential,
+)
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
@@ -43,8 +46,10 @@ class RolesColumn(cliff_columns.FormattableColumn[Any]):
 
 
 def _format_application_credential(
-    application_credential: Any, *, include_secret: bool = False
-) -> tuple[tuple[str, ...], Any]:
+    application_credential: _application_credential.ApplicationCredential,
+    *,
+    include_secret: bool = False,
+) -> tuple[tuple[str, ...], Iterable[Any]]:
     column_headers: tuple[str, ...] = (
         'ID',
         'Name',
@@ -78,7 +83,9 @@ def _format_application_credential(
 
 
 def _format_application_credentials(
-    application_credentials: Any,
+    application_credentials: Iterable[
+        _application_credential.ApplicationCredential
+    ],
 ) -> tuple[tuple[str, ...], Any]:
     column_headers = (
         'ID',

openstackclient/identity/v3/credential.py

@@ -20,6 +20,7 @@ from collections.abc import Iterable, Sequence
 import logging
 from typing import Any
 
+from openstack.identity.v3 import credential as _credential
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
@@ -28,11 +29,12 @@ from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _format_credential(credential: Any) -> tuple[tuple[str, ...], Any]:
+def _format_credential(
+    credential: _credential.Credential,
+) -> tuple[tuple[str, ...], Iterable[Any]]:
     columns = (
         'blob',
         'id',

openstackclient/identity/v3/domain.py

@@ -21,6 +21,7 @@ import logging
 from typing import Any
 
 from openstack import exceptions as sdk_exceptions
+from openstack.identity.v3 import domain as _domain
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
@@ -29,11 +30,12 @@ from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _format_domain(domain: Any) -> tuple[tuple[str, ...], Any]:
+def _format_domain(
+    domain: _domain.Domain,
+) -> tuple[tuple[str, ...], tuple[Any, ...]]:
     columns = (
         'id',
         'name',