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

openstackclient/compute/v2/server_volume.py

@@ -14,6 +14,10 @@
 
 """Compute v2 Server action implementations"""
 
+import argparse
+from collections.abc import Iterable
+from typing import Any
+
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
@@ -25,7 +29,7 @@ from openstackclient.i18n import _
 class ListServerVolume(command.Lister):
     """List all the volumes attached to a server."""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
@@ -33,7 +37,9 @@ class ListServerVolume(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
@@ -81,7 +87,7 @@ class ListServerVolume(command.Lister):
 class SetServerVolume(command.Command):
     """Update a volume attachment on the server."""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
@@ -113,7 +119,7 @@ class SetServerVolume(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    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
 

openstackclient/compute/v2/service.py

@@ -15,7 +15,10 @@
 
 """Service action implementations"""
 
+import argparse
+from collections.abc import Iterable
 import logging
+from typing import Any
 
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
@@ -31,7 +34,7 @@ LOG = logging.getLogger(__name__)
 class DeleteService(command.Command):
     _description = _("Delete compute service(s)")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "service",
@@ -51,7 +54,7 @@ class DeleteService(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
         result = 0
         for s in parsed_args.service:
@@ -84,7 +87,7 @@ value which can be used to uniquely identify the service in a multi-cell
 deployment."""
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--host",
@@ -107,7 +110,9 @@ deployment."""
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         compute_client = self.app.client_manager.compute
         columns: tuple[str, ...] = (
             "id",
@@ -146,7 +151,7 @@ deployment."""
 class SetService(command.Command):
     _description = _("Set compute service properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument("host", metavar="<host>", help=_("Name of host"))
         parser.add_argument(
@@ -192,7 +197,9 @@ class SetService(command.Command):
         return parser
 
     @staticmethod
-    def _find_service_by_host_and_binary(compute_client, host, binary):
+    def _find_service_by_host_and_binary(
+        compute_client: Any, host: str, binary: str
+    ) -> Any:
         """Utility method to find a compute service by host and binary
 
         :param host: the name of the compute service host
@@ -220,7 +227,7 @@ class SetService(command.Command):
             raise exceptions.CommandError(msg)
         return services[0]
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
 
         if (

openstackclient/compute/v2/usage.py

@@ -15,10 +15,11 @@
 
 """Usage action implementations"""
 
-from collections.abc import Collection
+import argparse
+from collections.abc import Collection, Iterable, Sequence
 import datetime
 import functools
-import typing as ty
+from typing import Any, cast
 
 from cliff import columns as cliff_columns
 from osc_lib import utils
@@ -40,32 +41,32 @@ class ProjectColumn(cliff_columns.FormattableColumn[str]):
     project_cache)`` to use this.
     """
 
-    def __init__(self, value, project_cache=None):
+    def __init__(self, value: str, project_cache: Any = None) -> None:
         super().__init__(value)
         self.project_cache = project_cache or {}
 
-    def human_readable(self):
+    def human_readable(self) -> str:
         project = self._value
         if not project:
             return ''
 
         if project in self.project_cache.keys():
-            return self.project_cache[project].name
+            return cast(str, self.project_cache[project].name)
 
         return project
 
 
-class CountColumn(cliff_columns.FormattableColumn[Collection[ty.Any]]):
-    def human_readable(self):
-        return len(self._value) if self._value is not None else None
+class CountColumn(cliff_columns.FormattableColumn[Collection[Any]]):
+    def human_readable(self) -> str:
+        return str(len(self._value)) if self._value is not None else ""
 
 
 class FloatColumn(cliff_columns.FormattableColumn[float]):
-    def human_readable(self):
-        return float(f"{self._value:.2f}")
+    def human_readable(self) -> str:
+        return f"{self._value:.2f}"
 
 
-def _formatters(project_cache):
+def _formatters(project_cache: Any) -> dict[str, Any]:
     return {
         'project_id': functools.partial(
             ProjectColumn, project_cache=project_cache
@@ -77,21 +78,21 @@ def _formatters(project_cache):
     }
 
 
-def _get_usage_marker(usage):
+def _get_usage_marker(usage: Any) -> str | None:
     marker = None
     if hasattr(usage, 'server_usages') and usage.server_usages:
         marker = usage.server_usages[-1]['instance_id']
     return marker
 
 
-def _get_usage_list_marker(usage_list):
+def _get_usage_list_marker(usage_list: Any) -> str | None:
     marker = None
     if usage_list:
         marker = _get_usage_marker(usage_list[-1])
     return marker
 
 
-def _merge_usage(usage, next_usage):
+def _merge_usage(usage: Any, next_usage: Any) -> None:
     usage.server_usages.extend(next_usage.server_usages)
     usage.total_hours += next_usage.total_hours
     usage.total_memory_mb_usage += next_usage.total_memory_mb_usage
@@ -99,7 +100,7 @@ def _merge_usage(usage, next_usage):
     usage.total_local_gb_usage += next_usage.total_local_gb_usage
 
 
-def _merge_usage_list(usages, next_usage_list):
+def _merge_usage_list(usages: Any, next_usage_list: Any) -> None:
     for next_usage in next_usage_list:
         if next_usage.project_id in usages:
             _merge_usage(usages[next_usage.project_id], next_usage)
@@ -110,7 +111,7 @@ def _merge_usage_list(usages, next_usage_list):
 class ListUsage(command.Lister):
     _description = _("List resource usage per project")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--start",
@@ -128,12 +129,14 @@ class ListUsage(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        def _format_project(project):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        def _format_project(project: str) -> str:
             if not project:
                 return ""
             if project in project_cache.keys():
-                return project_cache[project].name
+                return cast(str, project_cache[project].name)
             else:
                 return project
 
@@ -210,7 +213,7 @@ class ListUsage(command.Lister):
 class ShowUsage(command.ShowOne):
     _description = _("Show resource usage for a single project")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--project",
@@ -234,7 +237,9 @@ class ShowUsage(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         identity_client = self.app.client_manager.identity
         compute_client = self.app.client_manager.compute
         date_cli_format = "%Y-%m-%d"

openstackclient/identity/client.py

@@ -12,7 +12,9 @@
 #   License for the specific language governing permissions and limitations
 #   under the License.
 
+import argparse
 import logging
+from typing import Any
 
 from keystoneclient.v2_0 import client as identity_client_v2
 from osc_lib import utils
@@ -39,7 +41,7 @@ AUTH_VERSIONS = {
 }
 
 
-def make_client(instance):
+def make_client(instance: Any) -> Any:
     """Returns an identity service client."""
     identity_client = utils.get_client_class(
         API_NAME, instance._api_version[API_NAME], API_VERSIONS
@@ -56,7 +58,9 @@ def make_client(instance):
     return client
 
 
-def build_option_parser(parser):
+def build_option_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
     """Hook to add global options"""
     parser.add_argument(
         '--os-identity-api-version',
@@ -70,10 +74,11 @@ def build_option_parser(parser):
     return parser
 
 
+# We're not going to add type hints to this at this point
 class IdentityClientv2(identity_client_v2.Client):
     """Tweak the earlier client class to deal with some changes"""
 
-    def __getattr__(self, name):
+    def __getattr__(self, name: str) -> Any:
         # Map v3 'projects' back to v2 'tenants'
         if name == "projects":
             return self.tenants

openstackclient/identity/common.py

@@ -15,6 +15,10 @@
 
 """Common identity code"""
 
+import argparse
+from collections.abc import Callable
+from typing import Any, cast
+
 from keystoneclient import exceptions as identity_exc
 from keystoneclient.v3 import domains
 from keystoneclient.v3 import groups
@@ -27,7 +31,7 @@ from osc_lib import utils
 from openstackclient.i18n import _
 
 
-def find_service_in_list(service_list, service_id):
+def find_service_in_list(service_list: list[Any], service_id: str) -> Any:
     """Find a service by id in service list."""
 
     for service in service_list:
@@ -38,7 +42,7 @@ def find_service_in_list(service_list, service_id):
     )
 
 
-def find_service(identity_client, name_type_or_id):
+def find_service(identity_client: Any, name_type_or_id: str) -> Any:
     """Find a service by id, name or type."""
 
     try:
@@ -74,7 +78,7 @@ def find_service(identity_client, name_type_or_id):
         raise exceptions.CommandError(msg % name_type_or_id)
 
 
-def find_service_sdk(identity_client, name_type_or_id):
+def find_service_sdk(identity_client: Any, name_type_or_id: str) -> Any:
     """Find a service by id, name or type."""
 
     try:
@@ -107,7 +111,7 @@ def find_service_sdk(identity_client, name_type_or_id):
     return service
 
 
-def get_resource(manager, name_type_or_id):
+def get_resource(manager: Any, name_type_or_id: str) -> Any:
     # NOTE (vishakha): Due to bug #1799153 and for any another related case
     # where GET resource API does not support the filter by name,
     # osc_lib.utils.find_resource() method cannot be used because that method
@@ -126,7 +130,7 @@ def get_resource(manager, name_type_or_id):
         raise exceptions.CommandError(msg % name_type_or_id)
 
 
-def get_resource_by_id(manager, resource_id):
+def get_resource_by_id(manager: Any, resource_id: str) -> Any:
     """Get resource by ID
 
     Raises CommandError if the resource is not found
@@ -138,7 +142,12 @@ def get_resource_by_id(manager, resource_id):
         raise exceptions.CommandError(msg.format(resource_id))
 
 
-def _get_token_resource(client, resource, parsed_name, parsed_domain=None):
+def _get_token_resource(
+    client: Any,
+    resource: str,
+    parsed_name: str,
+    parsed_domain: str | None = None,
+) -> str:
     """Peek into the user's auth token to get resource IDs
 
     Look into a user's token to try and find the ID of a domain, project or
@@ -174,25 +183,28 @@ def _get_token_resource(client, resource, parsed_name, parsed_domain=None):
         if isinstance(obj, list):
             for item in obj:
                 if item['name'] == parsed_name:
-                    return item['id']
+                    return cast(str, item['id'])
                 if item['id'] == parsed_name:
                     return parsed_name
             return parsed_name
         return obj['id'] if obj['name'] == parsed_name else parsed_name
     # diaper defense in case parsing the token fails
-    except Exception:  # noqa
+    except Exception:
         return parsed_name
 
 
-def find_domain(identity_client, name_or_id):
+def find_domain(identity_client: Any, name_or_id: str) -> domains.Domain:
     return _find_identity_resource(
         identity_client.domains, name_or_id, domains.Domain
     )
 
 
 def find_domain_id_sdk(
-    identity_client, name_or_id, *, validate_actor_existence=True
-):
+    identity_client: Any,
+    name_or_id: str,
+    *,
+    validate_actor_existence: bool = True,
+) -> str:
     return _find_sdk_id(
         identity_client.find_domain,
         name_or_id=name_or_id,
@@ -200,7 +212,11 @@ def find_domain_id_sdk(
     )
 
 
-def find_group(identity_client, name_or_id, domain_name_or_id=None):
+def find_group(
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
+) -> groups.Group:
     if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.groups, name_or_id, groups.Group
@@ -216,12 +232,12 @@ def find_group(identity_client, name_or_id, domain_name_or_id=None):
 
 
 def find_group_id_sdk(
-    identity_client,
-    name_or_id,
-    domain_name_or_id=None,
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
     *,
-    validate_actor_existence=True,
-):
+    validate_actor_existence: bool = True,
+) -> str:
     if domain_name_or_id is None:
         return _find_sdk_id(
             identity_client.find_group,
@@ -242,7 +258,11 @@ def find_group_id_sdk(
     )
 
 
-def find_project(identity_client, name_or_id, domain_name_or_id=None):
+def find_project(
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
+) -> projects.Project:
     if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.projects, name_or_id, projects.Project
@@ -256,7 +276,42 @@ def find_project(identity_client, name_or_id, domain_name_or_id=None):
     )
 
 
-def find_user(identity_client, name_or_id, domain_name_or_id=None):
+def find_project_id_sdk(
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
+    *,
+    validate_actor_existence: bool = True,
+    validate_domain_actor_existence: bool | None = None,
+) -> str:
+    if domain_name_or_id is None:
+        return _find_sdk_id(
+            identity_client.find_project,
+            name_or_id=name_or_id,
+            validate_actor_existence=validate_actor_existence,
+        )
+
+    if validate_domain_actor_existence is None:
+        validate_domain_actor_existence = validate_actor_existence
+
+    domain_id = find_domain_id_sdk(
+        identity_client,
+        name_or_id=domain_name_or_id,
+        validate_actor_existence=validate_domain_actor_existence,
+    )
+    return _find_sdk_id(
+        identity_client.find_project,
+        name_or_id=name_or_id,
+        validate_actor_existence=validate_actor_existence,
+        domain_id=domain_id,
+    )
+
+
+def find_user(
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
+) -> users.User:
     if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.users, name_or_id, users.User
@@ -268,12 +323,12 @@ def find_user(identity_client, name_or_id, domain_name_or_id=None):
 
 
 def find_user_id_sdk(
-    identity_client,
-    name_or_id,
-    domain_name_or_id=None,
+    identity_client: Any,
+    name_or_id: str,
+    domain_name_or_id: str | None = None,
     *,
-    validate_actor_existence=True,
-):
+    validate_actor_existence: bool = True,
+) -> str:
     if domain_name_or_id is None:
         return _find_sdk_id(
             identity_client.find_user,
@@ -294,8 +349,11 @@ def find_user_id_sdk(
 
 
 def _find_identity_resource(
-    identity_client_manager, name_or_id, resource_type, **kwargs
-):
+    identity_client_manager: Any,
+    name_or_id: str,
+    resource_type: Any,
+    **kwargs: Any,
+) -> Any:
     """Find a specific identity resource.
 
     Using keystoneclient's manager, attempt to find a specific resource by its
@@ -334,8 +392,12 @@ def _find_identity_resource(
 
 
 def _find_sdk_id(
-    find_command, name_or_id, *, validate_actor_existence=True, **kwargs
-):
+    find_command: Callable[..., Any],
+    name_or_id: str,
+    *,
+    validate_actor_existence: bool = True,
+    **kwargs: Any,
+) -> str:
     try:
         resource = find_command(
             name_or_id=name_or_id, ignore_missing=False, **kwargs
@@ -346,10 +408,10 @@ def _find_sdk_id(
         if not validate_actor_existence:
             return name_or_id
         raise exceptions.CommandError from exc
-    return resource.id
+    return cast(str, resource.id)
 
 
-def add_user_domain_option_to_parser(parser):
+def add_user_domain_option_to_parser(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         '--user-domain',
         metavar='<user-domain>',
@@ -361,7 +423,7 @@ def add_user_domain_option_to_parser(parser):
     )
 
 
-def add_group_domain_option_to_parser(parser):
+def add_group_domain_option_to_parser(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         '--group-domain',
         metavar='<group-domain>',
@@ -373,21 +435,21 @@ def add_group_domain_option_to_parser(parser):
     )
 
 
-def add_project_domain_option_to_parser(parser, enhance_help=lambda _h: _h):
+def add_project_domain_option_to_parser(
+    parser: argparse.ArgumentParser,
+) -> None:
     parser.add_argument(
         '--project-domain',
         metavar='<project-domain>',
-        help=enhance_help(
-            _(
-                'Domain the project belongs to (name or ID). This '
-                'can be used in case collisions between project '
-                'names exist.'
-            )
+        help=_(
+            'Domain the project belongs to (name or ID). This '
+            'can be used in case collisions between project '
+            'names exist.'
         ),
     )
 
 
-def add_role_domain_option_to_parser(parser):
+def add_role_domain_option_to_parser(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         '--role-domain',
         metavar='<role-domain>',
@@ -399,7 +461,7 @@ def add_role_domain_option_to_parser(parser):
     )
 
 
-def add_inherited_option_to_parser(parser):
+def add_inherited_option_to_parser(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         '--inherited',
         action='store_true',
@@ -410,7 +472,7 @@ def add_inherited_option_to_parser(parser):
     )
 
 
-def add_resource_option_to_parser(parser):
+def add_resource_option_to_parser(parser: argparse.ArgumentParser) -> None:
     immutable_group = parser.add_mutually_exclusive_group()
     immutable_group.add_argument(
         '--immutable',

openstackclient/identity/v2_0/catalog.py

@@ -13,8 +13,10 @@
 
 """Identity v2 Service Catalog action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
-import typing as ty
+from typing import Any
 
 from cliff import columns as cliff_columns
 from osc_lib import exceptions
@@ -27,8 +29,8 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-class EndpointsColumn(cliff_columns.FormattableColumn[ty.Any]):
-    def human_readable(self):
+class EndpointsColumn(cliff_columns.FormattableColumn[Any]):
+    def human_readable(self) -> str:
         if not self._value:
             return ""
         ret = ''
@@ -47,7 +49,9 @@ class EndpointsColumn(cliff_columns.FormattableColumn[ty.Any]):
 class ListCatalog(command.Lister):
     _description = _("List services in the service catalog")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         # Trigger auth if it has not happened yet
         auth_ref = self.app.client_manager.auth_ref
         if not auth_ref:
@@ -75,7 +79,7 @@ class ListCatalog(command.Lister):
 class ShowCatalog(command.ShowOne):
     _description = _("Display service catalog details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'service',
@@ -84,7 +88,9 @@ class ShowCatalog(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         # Trigger auth if it has not happened yet
         auth_ref = self.app.client_manager.auth_ref
         if not auth_ref:
@@ -108,4 +114,5 @@ class ShowCatalog(command.ShowOne):
             LOG.error(_('service %s not found\n'), parsed_args.service)
             return ((), ())
 
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data