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

openstackclient/identity/v3/policy.py

@@ -15,7 +15,10 @@
 
 """Identity v3 Policy action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -30,7 +33,7 @@ LOG = logging.getLogger(__name__)
 class CreatePolicy(command.ShowOne):
     _description = _("Create new policy")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--type',
@@ -48,7 +51,9 @@ class CreatePolicy(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         blob = utils.read_blob_file_contents(parsed_args.rules)
 
         identity_client = self.app.client_manager.identity
@@ -58,13 +63,14 @@ class CreatePolicy(command.ShowOne):
 
         policy._info.pop('links')
         policy._info.update({'rules': policy._info.pop('blob')})
-        return zip(*sorted(policy._info.items()))
+        col_headers, col_data = zip(*sorted(policy._info.items()))
+        return col_headers, col_data
 
 
 class DeletePolicy(command.Command):
     _description = _("Delete policy(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(
             'policy',
@@ -74,7 +80,7 @@ class DeletePolicy(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
         result = 0
         for i in parsed_args.policy:
@@ -102,7 +108,7 @@ class DeletePolicy(command.Command):
 class ListPolicy(command.Lister):
     _description = _("List policies")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--long',
@@ -112,7 +118,9 @@ class ListPolicy(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         columns: tuple[str, ...] = ('ID', 'Type')
         column_headers: tuple[str, ...] = columns
         if parsed_args.long:
@@ -135,7 +143,7 @@ class ListPolicy(command.Lister):
 class SetPolicy(command.Command):
     _description = _("Set policy 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(
             'policy',
@@ -154,7 +162,7 @@ class SetPolicy(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         identity_client = self.app.client_manager.identity
         blob = None
 
@@ -173,7 +181,7 @@ class SetPolicy(command.Command):
 class ShowPolicy(command.ShowOne):
     _description = _("Display policy 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(
             'policy',
@@ -182,7 +190,9 @@ class ShowPolicy(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
         policy = utils.find_resource(
             identity_client.policies, parsed_args.policy
@@ -190,4 +200,5 @@ class ShowPolicy(command.ShowOne):
 
         policy._info.pop('links')
         policy._info.update({'rules': policy._info.pop('blob')})
-        return zip(*sorted(policy._info.items()))
+        col_headers, col_data = zip(*sorted(policy._info.items()))
+        return col_headers, col_data

openstackclient/identity/v3/project.py

@@ -15,9 +15,13 @@
 
 """Project action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from openstack import exceptions as sdk_exc
+from openstack import utils as sdk_utils
 from osc_lib.cli import parseractions
 from osc_lib import exceptions
 from osc_lib import utils
@@ -30,7 +34,7 @@ from openstackclient.identity.v3 import tag
 LOG = logging.getLogger(__name__)
 
 
-def _format_project(project):
+def _format_project(project: Any) -> tuple[tuple[str, ...], Any]:
     # NOTE(0weng): Projects allow unknown attributes in the body, so extract
     # the column names separately.
     (column_headers, columns) = utils.get_osc_show_columns_for_sdk_resource(
@@ -48,7 +52,7 @@ def _format_project(project):
 class CreateProject(command.ShowOne):
     _description = _("Create new 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(
             'name',
@@ -104,8 +108,12 @@ class CreateProject(command.ShowOne):
         tag.add_tag_option_to_parser_for_create(parser, _('project'))
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
 
@@ -181,7 +189,7 @@ class DeleteProject(command.Command):
         "regardless."
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'projects',
@@ -196,8 +204,10 @@ class DeleteProject(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         errors = 0
         for project in parsed_args.projects:
@@ -232,7 +242,7 @@ class DeleteProject(command.Command):
 class ListProject(command.Lister):
     _description = _("List projects")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--domain',
@@ -289,8 +299,12 @@ class ListProject(command.Lister):
         tag.add_tag_filtering_option_to_parser(parser, _('projects'))
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         column_headers: tuple[str, ...] = ('ID', 'Name')
         if parsed_args.long:
@@ -342,21 +356,21 @@ class ListProject(command.Lister):
             user = self.app.client_manager.auth_ref.user_id
 
         if user:
-            data = identity_client.user_projects(user, **kwargs)
+            data = list(identity_client.user_projects(user, **kwargs))
         else:
             try:
-                data = identity_client.projects(**kwargs)
+                data = list(identity_client.projects(**kwargs))
             except sdk_exc.ForbiddenException:
                 # NOTE(adriant): if no filters, assume a forbidden is non-admin
                 # wanting their own project list.
                 if not kwargs:
                     user = self.app.client_manager.auth_ref.user_id
-                    data = identity_client.user_projects(user)
+                    data = list(identity_client.user_projects(user))
                 else:
                     raise
 
         if parsed_args.sort:
-            data = utils.sort_items(data, parsed_args.sort)
+            data = list(utils.sort_items(data, parsed_args.sort))
 
         return (
             column_headers,
@@ -367,7 +381,7 @@ class ListProject(command.Lister):
 class SetProject(command.Command):
     _description = _("Set project 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(
             'project',
@@ -418,8 +432,10 @@ class SetProject(command.Command):
         tag.add_tag_option_to_parser_for_set(parser, _('project'))
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
         if parsed_args.name:
@@ -481,7 +497,7 @@ class SetProject(command.Command):
 class ShowProject(command.ShowOne):
     _description = _("Display project 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(
             'project',
@@ -507,10 +523,14 @@ class ShowProject(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
-        kwargs = {}
+        kwargs: dict[str, Any] = {}
 
         domain = None
         if parsed_args.domain:
@@ -536,8 +556,8 @@ class ShowProject(command.ShowOne):
         if parsed_args.children:
             kwargs['subtree_as_ids'] = True
 
-        project = identity_client.find_project(
+        project_obj = identity_client.find_project(
             project, **kwargs, ignore_missing=False
         )
 
-        return _format_project(project)
+        return _format_project(project_obj)

openstackclient/identity/v3/region.py

@@ -13,8 +13,12 @@
 
 """Identity v3 Region action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+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 _
 LOG = logging.getLogger(__name__)
 
 
-def _format_region(region):
+def _format_region(region: Any) -> tuple[tuple[str, ...], Any]:
     columns = ('id', 'description', 'parent_region_id')
     column_headers = ('region', 'description', 'parent_region')
     return (
@@ -37,7 +41,7 @@ def _format_region(region):
 class CreateRegion(command.ShowOne):
     _description = _("Create new region")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         # NOTE(stevemar): The API supports an optional region ID, but that
         # seems like poor UX, we will only support user-defined IDs.
@@ -58,8 +62,12 @@ class CreateRegion(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         region = identity_client.create_region(
             id=parsed_args.region,
@@ -73,7 +81,7 @@ class CreateRegion(command.ShowOne):
 class DeleteRegion(command.Command):
     _description = _("Delete region(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(
             'region',
@@ -83,8 +91,10 @@ class DeleteRegion(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         result = 0
         for i in parsed_args.region:
             try:
@@ -108,7 +118,7 @@ class DeleteRegion(command.Command):
 class ListRegion(command.Lister):
     _description = _("List regions")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--parent-region',
@@ -117,8 +127,12 @@ class ListRegion(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
         if parsed_args.parent_region:
@@ -144,7 +158,7 @@ class ListRegion(command.Lister):
 class SetRegion(command.Command):
     _description = _("Set region 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(
             'region',
@@ -163,8 +177,10 @@ class SetRegion(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
         if parsed_args.description:
@@ -178,7 +194,7 @@ class SetRegion(command.Command):
 class ShowRegion(command.ShowOne):
     _description = _("Display region 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(
             'region',
@@ -187,8 +203,12 @@ class ShowRegion(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         region = identity_client.get_region(parsed_args.region)
 

openstackclient/identity/v3/registered_limit.py

@@ -13,8 +13,12 @@
 
 """Registered limits action implementations."""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -25,7 +29,9 @@ from openstackclient.identity import common as common_utils
 LOG = logging.getLogger(__name__)
 
 
-def _format_registered_limit(registered_limit):
+def _format_registered_limit(
+    registered_limit: Any,
+) -> tuple[tuple[str, ...], Any]:
     columns = (
         'default_limit',
         'description',
@@ -51,7 +57,7 @@ def _format_registered_limit(registered_limit):
 class CreateRegisteredLimit(command.ShowOne):
     _description = _("Create a registered limit")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--description',
@@ -86,8 +92,12 @@ class CreateRegisteredLimit(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
 
@@ -114,7 +124,7 @@ class CreateRegisteredLimit(command.ShowOne):
 class DeleteRegisteredLimit(command.Command):
     _description = _("Delete a registered limit")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'registered_limits',
@@ -127,8 +137,10 @@ class DeleteRegisteredLimit(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         errors = 0
         for registered_limit_id in parsed_args.registered_limits:
@@ -160,7 +172,7 @@ class DeleteRegisteredLimit(command.Command):
 class ListRegisteredLimit(command.Lister):
     _description = _("List registered limits")
 
-    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',
@@ -182,8 +194,12 @@ class ListRegisteredLimit(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
         if parsed_args.service:
@@ -217,7 +233,7 @@ class ListRegisteredLimit(command.Lister):
 class SetRegisteredLimit(command.ShowOne):
     _description = _("Update information about a registered limit")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'registered_limit_id',
@@ -267,8 +283,12 @@ class SetRegisteredLimit(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         kwargs = {}
         if parsed_args.service:
@@ -300,7 +320,7 @@ class SetRegisteredLimit(command.ShowOne):
 class ShowRegisteredLimit(command.ShowOne):
     _description = _("Display registered limit 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(
             'registered_limit_id',
@@ -309,8 +329,12 @@ class ShowRegisteredLimit(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.sdk_connection.identity
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
         registered_limit = identity_client.get_registered_limit(
             parsed_args.registered_limit_id
         )