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

openstackclient/common/clientmanager.py

@@ -20,14 +20,14 @@ from collections.abc import Callable
 import importlib
 import logging
 import sys
-import typing as ty
+from typing import TYPE_CHECKING, Any, Protocol, TypeVar, runtime_checkable
 
 from osc_lib.cli import client_config
 from osc_lib import clientmanager
 from osc_lib import shell
 import stevedore
 
-if ty.TYPE_CHECKING:
+if TYPE_CHECKING:
     from keystoneauth1 import access as ksa_access
     from openstack.compute.v2 import _proxy as compute_proxy
     from openstack.image.v2 import _proxy as image_proxy
@@ -37,7 +37,7 @@ if ty.TYPE_CHECKING:
 
 LOG = logging.getLogger(__name__)
 
-PLUGIN_MODULES: list[ty.Any] = []
+PLUGIN_MODULES: list[Any] = []
 
 USER_AGENT = 'python-openstackclient'
 
@@ -50,7 +50,7 @@ class ClientManager(clientmanager.ClientManager):
     in osc-lib so we need to maintain a transition period.
     """
 
-    if ty.TYPE_CHECKING:
+    if TYPE_CHECKING:
         # we know this will be set by us and will not be nullable
         auth_ref: ksa_access.AccessInfo
 
@@ -62,18 +62,18 @@ class ClientManager(clientmanager.ClientManager):
         # services...
         # TODO(stephenfin): We also need to migrate object storage...
         compute: compute_proxy.Proxy
-        identity: ty.Any
+        identity: Any
         image: image_proxy.Proxy
         network: network_proxy.Proxy
         object_store: object_store_v1.APIv1
-        volume: ty.Any
+        volume: Any
 
     def __init__(
         self,
-        cli_options=None,
-        api_version=None,
-        pw_func=None,
-    ):
+        cli_options: Any = None,
+        api_version: Any = None,
+        pw_func: Any = None,
+    ) -> None:
         super().__init__(
             cli_options=cli_options,
             api_version=api_version,
@@ -89,7 +89,7 @@ class ClientManager(clientmanager.ClientManager):
         # store original auth_type
         self._original_auth_type = cli_options.auth_type
 
-    def setup_auth(self):
+    def setup_auth(self) -> None:
         """Set up authentication"""
 
         if self._auth_setup_completed:
@@ -125,7 +125,7 @@ class ClientManager(clientmanager.ClientManager):
 
         return super().setup_auth()
 
-    def _fallback_load_auth_plugin(self, e):
+    def _fallback_load_auth_plugin(self, e: Exception) -> None:
         # NOTES(RuiChen): Hack to avoid auth plugins choking on data they don't
         #                 expect, delete fake token and endpoint, then try to
         #                 load auth plugin again with user specified options.
@@ -150,52 +150,77 @@ class ClientManager(clientmanager.ClientManager):
         else:
             raise e
 
-    def is_network_endpoint_enabled(self):
+    def is_network_endpoint_enabled(self) -> bool:
         """Check if the network endpoint is enabled"""
         # NOTE(dtroyer): is_service_available() can also return None if
         #                there is no Service Catalog, callers here are
         #                not expecting that so fold None into True to
         #                use Network API by default
-        return self.is_service_available('network') is not False
+        return (
+            self.is_service_available(
+                'network', self.region_name, self.interface
+            )
+            is not False
+        )
 
-    def is_compute_endpoint_enabled(self):
+    def is_compute_endpoint_enabled(self) -> bool:
         """Check if Compute endpoint is enabled"""
-        return self.is_service_available('compute') is not False
+        return (
+            self.is_service_available(
+                'compute', self.region_name, self.interface
+            )
+            is not False
+        )
 
     # TODO(stephenfin): Drop volume_client argument in OSC 8.0 or later.
-    def is_volume_endpoint_enabled(self, volume_client=None):
+    def is_volume_endpoint_enabled(self, volume_client: Any = None) -> bool:
         """Check if volume endpoint is enabled"""
         # We check against the service type and all aliases defined by the
         # Service Types Authority
         # https://service-types.openstack.org/service-types.json
         return (
-            self.is_service_available('block-storage') is not False
-            or self.is_service_available('volume') is not False
-            or self.is_service_available('volumev3') is not False
-            or self.is_service_available('volumev2') is not False
-            or self.is_service_available('block-store') is not False
+            self.is_service_available(
+                'block-storage', self.region_name, self.interface
+            )
+            is not False
+            or self.is_service_available(
+                'volume', self.region_name, self.interface
+            )
+            is not False
+            or self.is_service_available(
+                'volumev3', self.region_name, self.interface
+            )
+            is not False
+            or self.is_service_available(
+                'volumev2', self.region_name, self.interface
+            )
+            is not False
+            or self.is_service_available(
+                'block-store', self.region_name, self.interface
+            )
+            is not False
         )
 
 
 # Plugin Support
 
-ArgumentParserT = ty.TypeVar('ArgumentParserT', bound=argparse.ArgumentParser)
+ArgumentParserT = TypeVar('ArgumentParserT', bound=argparse.ArgumentParser)
 
 
-@ty.runtime_checkable  # Optional: allows usage with isinstance()
-class PluginModule(ty.Protocol):
+@runtime_checkable  # Optional: allows usage with isinstance()
+class PluginModule(Protocol):
     DEFAULT_API_VERSION: str
     API_VERSION_OPTION: str
     API_NAME: str
     API_VERSIONS: tuple[str]
 
-    make_client: Callable[..., ty.Any]
+    make_client: Callable[..., Any]
     build_option_parser: Callable[[ArgumentParserT], ArgumentParserT]
     check_api_version: Callable[[str], bool]
 
 
 def _on_load_failure_callback(
-    manager: stevedore.ExtensionManager,
+    manager: stevedore.ExtensionManager[PluginModule],
     ep: importlib.metadata.EntryPoint,
     err: BaseException,
 ) -> None:
@@ -204,7 +229,7 @@ def _on_load_failure_callback(
     )
 
 
-def get_plugin_modules(group):
+def get_plugin_modules(group: str) -> list[Any]:
     """Find plugin entry points"""
     mod_list = []
     mgr: stevedore.ExtensionManager[PluginModule]
@@ -238,7 +263,9 @@ def get_plugin_modules(group):
     return mod_list
 
 
-def build_plugin_option_parser(parser):
+def build_plugin_option_parser(
+    parser: ArgumentParserT,
+) -> ArgumentParserT:
     """Add plugin options to the parser"""
 
     # Loop through extensions to get parser additions

openstackclient/common/configuration.py

@@ -13,6 +13,10 @@
 
 """Configuration action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
 from keystoneauth1.loading import base
 
 from openstackclient import command
@@ -26,7 +30,7 @@ class ShowConfiguration(command.ShowOne):
 
     auth_required = False
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         mask_group = parser.add_mutually_exclusive_group()
         mask_group.add_argument(
@@ -44,7 +48,9 @@ class ShowConfiguration(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         info = self.app.client_manager.get_configuration()
 
         # Assume a default secret list in case we do not have an auth_plugin
@@ -68,4 +74,5 @@ class ShowConfiguration(command.ShowOne):
                 if secret_opt in info:
                     info[secret_opt] = REDACTED
 
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data

openstackclient/common/envvars.py

@@ -15,7 +15,7 @@ import os
 from openstackclient.i18n import _
 
 
-def bool_from_str(value, strict=False):
+def bool_from_str(value: bool | str, strict: bool = False) -> bool:
     true_strings = ('1', 't', 'true', 'on', 'y', 'yes')
     false_strings = ('0', 'f', 'false', 'off', 'n', 'no')
 
@@ -39,7 +39,7 @@ def bool_from_str(value, strict=False):
     raise ValueError(msg)
 
 
-def boolenv(*vars, default=False):
+def boolenv(*vars: str, default: bool = False) -> bool:
     """Search for the first defined of possibly many bool-like env vars.
 
     Returns the first environment variable defined in vars, or returns the

openstackclient/common/extension.py

@@ -15,7 +15,10 @@
 
 """Extension action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib import utils
 
@@ -25,7 +28,9 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _get_extension_columns(item):
+def _get_extension_columns(
+    item: Any,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'updated': 'updated_at',
     }
@@ -38,7 +43,7 @@ def _get_extension_columns(item):
 class ListExtension(command.Lister):
     _description = _("List API extensions")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--compute',
@@ -72,7 +77,9 @@ class ListExtension(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         columns: tuple[str, ...] = ('Name', 'Alias', 'Description')
         if parsed_args.long:
             columns += ('Namespace', 'Updated At', 'Links')
@@ -139,7 +146,7 @@ class ListExtension(command.Lister):
 class ShowExtension(command.ShowOne):
     _description = _("Show API extension")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'extension',
@@ -152,7 +159,9 @@ class ShowExtension(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         client = self.app.client_manager.network
 
         extension = client.find_extension(

openstackclient/common/limits.py

@@ -15,7 +15,10 @@
 
 """Limits Action Implementation"""
 
+import argparse
 import itertools
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib import utils
 
@@ -24,8 +27,8 @@ from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
 
-def _format_absolute_limit(absolute_limits):
-    info = {}
+def _format_absolute_limit(absolute_limits: Any) -> dict[str, Any]:
+    info: dict[str, Any] = {}
 
     for key in set(absolute_limits):
         if key in ('id', 'name', 'location'):
@@ -36,7 +39,7 @@ def _format_absolute_limit(absolute_limits):
     return info
 
 
-def _format_rate_limit(rate_limits):
+def _format_rate_limit(rate_limits: Any) -> Any:
     # flatten this:
     #
     #   {'uri': '<uri>', 'limit': [{'value': '<value>', ...], ...}
@@ -52,7 +55,7 @@ def _format_rate_limit(rate_limits):
 class ShowLimits(command.Lister):
     _description = _("Show compute and block storage limits")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         type_group = parser.add_mutually_exclusive_group(required=True)
         type_group.add_argument(
@@ -100,7 +103,9 @@ class ShowLimits(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         project_id = None
         if parsed_args.project is not None:
             identity_client = self.app.client_manager.identity

openstackclient/common/module.py

@@ -15,7 +15,11 @@
 
 """Module action implementation"""
 
+import argparse
+import importlib.metadata
 import sys
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib import utils
 
@@ -28,7 +32,7 @@ class ListCommand(command.Lister):
 
     auth_required = False
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--group',
@@ -41,7 +45,9 @@ class ListCommand(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         cm = self.app.command_manager
         groups = cm.get_command_groups()
         groups = sorted(groups)
@@ -61,7 +67,7 @@ class ListCommand(command.Lister):
                 # TODO(bapalm): Fix this when cliff properly supports
                 # handling the detection rather than using the hard-code below.
                 if parsed_args.formatter == 'table':
-                    command_names = utils.format_list(command_names, "\n")  # type: ignore
+                    command_names = utils.format_list(command_names, "\n")  # type: ignore[assignment]
 
                 commands.append((group, command_names))
 
@@ -73,7 +79,7 @@ class ListModule(command.ShowOne):
 
     auth_required = False
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--all',
@@ -83,38 +89,34 @@ class ListModule(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> 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
-
-        return zip(*sorted(data.items()))
+            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

@@ -10,6 +10,8 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import argparse
+
 from osc_lib.cli import parseractions
 
 from openstackclient.i18n import _
@@ -19,7 +21,12 @@ from openstackclient.i18n import _
 # useful
 
 
-def add_marker_pagination_option_to_parser(parser):
+# 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.
 
     APIs that use marker-based paging use the marker and limit query parameters
@@ -35,8 +42,11 @@ def add_marker_pagination_option_to_parser(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(
@@ -48,9 +58,27 @@ def add_marker_pagination_option_to_parser(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.'
+            ),
+        )
 
 
-def add_offset_pagination_option_to_parser(parser):
+# 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.
 
     APIs that use offset-based paging use the offset and limit query parameters
@@ -65,8 +93,11 @@ def add_offset_pagination_option_to_parser(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(
@@ -80,3 +111,16 @@ def add_offset_pagination_option_to_parser(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/progressbar.py

@@ -14,6 +14,7 @@
 #    under the License.
 
 import sys
+from typing import Any
 
 
 class _ProgressBarBase:
@@ -28,24 +29,24 @@ class _ProgressBarBase:
     :note: The progress will be displayed only if sys.stdout is a tty.
     """
 
-    def __init__(self, wrapped, totalsize):
+    def __init__(self, wrapped: Any, totalsize: int) -> None:
         self._wrapped = wrapped
         self._totalsize = float(totalsize)
         self._show_progress = sys.stdout.isatty() and self._totalsize != 0
-        self._percent = 0
+        self._percent = 0.0
 
-    def _display_progress_bar(self, size_read):
+    def _display_progress_bar(self, size_read: int) -> None:
         if self._show_progress:
             self._percent += size_read / self._totalsize
             # Output something like this: [==========>             ] 49%
             sys.stdout.write(
                 '\r[{:<30}] {:.0%}'.format(
-                    '=' * int(round(self._percent * 29)) + '>', self._percent
+                    '=' * round(self._percent * 29) + '>', self._percent
                 )
             )
             sys.stdout.flush()
 
-    def __getattr__(self, attr):
+    def __getattr__(self, attr: str) -> Any:
         # Forward other attribute access to the wrapped object.
         return getattr(self._wrapped, attr)
 
@@ -57,7 +58,7 @@ class VerboseFileWrapper(_ProgressBarBase):
     wrapped file's read method is called.
     """
 
-    def read(self, *args, **kwargs):
+    def read(self, *args: Any, **kwargs: Any) -> Any:
         data = self._wrapped.read(*args, **kwargs)
         if data:
             self._display_progress_bar(len(data))

openstackclient/common/project_cleanup.py

@@ -13,13 +13,15 @@
 #   under the License.
 #
 
+import argparse
 import getpass
 import logging
 import os
 import queue
-import typing as ty
+from typing import Any
 
 from cliff.formatters import table
+from openstack import utils as sdk_utils
 
 from openstackclient import command
 from openstackclient.i18n import _
@@ -29,7 +31,7 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-def ask_user_yesno(msg):
+def ask_user_yesno(msg: str) -> bool:
     """Ask user Y/N question
 
     :param str msg: question text
@@ -46,7 +48,7 @@ def ask_user_yesno(msg):
 class ProjectCleanup(command.Command):
     _description = _("Clean resources associated with a project")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         action_group = parser.add_mutually_exclusive_group()
         action_group.add_argument(
@@ -89,7 +91,7 @@ class ProjectCleanup(command.Command):
         identity_common.add_project_domain_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         connection = self.app.client_manager.sdk_connection
 
         if parsed_args.auth_project:
@@ -97,13 +99,16 @@ class ProjectCleanup(command.Command):
             # as-is
             pass
         elif parsed_args.project:
-            project = connection.identity.find_project(
+            identity_client = sdk_utils.ensure_service_version(
+                connection.identity, '3'
+            )
+            project = identity_client.find_project(
                 name_or_id=parsed_args.project, ignore_missing=False
             )
             connection = connection.connect_as_project(project)
 
         if connection:
-            status_queue: queue.Queue[ty.Any] = queue.Queue()
+            status_queue: queue.Queue[Any] = queue.Queue()
             parsed_args.max_width = int(
                 os.environ.get('CLIFF_MAX_TERM_WIDTH', 0)
             )