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

openstackclient/identity/v3/mapping.py

@@ -15,9 +15,14 @@
 
 """Identity v3 federation mapping action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import json
 import logging
+from typing import Any
 
+from openstack.identity.v3 import mapping as _mapping
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -28,10 +33,21 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
+def _format_mapping(
+    mapping: _mapping.Mapping,
+) -> tuple[tuple[str, ...], tuple[Any, ...]]:
+    columns = ('id', 'rules', 'schema_version')
+    column_headers = ('id', 'rules', 'schema_version')
+    return (
+        column_headers,
+        utils.get_item_properties(mapping, columns),
+    )
+
+
 class _RulesReader:
     _description = _("Helper class capable of reading rules from files")
 
-    def _read_rules(self, path):
+    def _read_rules(self, path: str) -> Any:
         """Read and parse rules from path
 
         Expect the file to contain a valid JSON structure.
@@ -82,7 +98,9 @@ class _RulesReader:
             return rules
 
     @staticmethod
-    def add_federated_schema_version_option(parser):
+    def add_federated_schema_version_option(
+        parser: argparse.ArgumentParser,
+    ) -> None:
         parser.add_argument(
             '--schema-version',
             metavar='<schema_version>',
@@ -100,7 +118,7 @@ class _RulesReader:
 class CreateMapping(command.ShowOne, _RulesReader):
     _description = _("Create new mapping")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'mapping',
@@ -116,24 +134,27 @@ class CreateMapping(command.ShowOne, _RulesReader):
         _RulesReader.add_federated_schema_version_option(parser)
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.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'
+        )
 
         rules = self._read_rules(parsed_args.rules)
-        mapping = identity_client.federation.mappings.create(
-            mapping_id=parsed_args.mapping,
+        mapping = identity_client.create_mapping(
+            id=parsed_args.mapping,
             rules=rules,
             schema_version=parsed_args.schema_version,
         )
 
-        mapping._info.pop('links', None)
-        return zip(*sorted(mapping._info.items()))
+        return _format_mapping(mapping)
 
 
 class DeleteMapping(command.Command):
     _description = _("Delete mapping(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(
             'mapping',
@@ -143,12 +164,14 @@ class DeleteMapping(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.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.mapping:
             try:
-                identity_client.federation.mappings.delete(i)
+                identity_client.delete_mapping(i, ignore_missing=False)
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -171,12 +194,16 @@ class DeleteMapping(command.Command):
 class ListMapping(command.Lister):
     _description = _("List mappings")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         # NOTE(marek-denis): Since rules can be long and tedious I have decided
         # to only list ids of the mappings. If somebody wants to check the
         # rules, (s)he should show specific ones.
-        identity_client = self.app.client_manager.identity
-        data = identity_client.federation.mappings.list()
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
+        data = identity_client.mappings()
         columns = ('ID', 'schema_version')
         items = [utils.get_item_properties(s, columns) for s in data]
         return (columns, items)
@@ -185,7 +212,7 @@ class ListMapping(command.Lister):
 class SetMapping(command.Command, _RulesReader):
     _description = _("Set mapping 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(
             'mapping',
@@ -201,24 +228,24 @@ class SetMapping(command.Command, _RulesReader):
         _RulesReader.add_federated_schema_version_option(parser)
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.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'
+        )
 
         rules = self._read_rules(parsed_args.rules)
 
-        mapping = identity_client.federation.mappings.update(
+        identity_client.update_mapping(
             mapping=parsed_args.mapping,
             rules=rules,
             schema_version=parsed_args.schema_version,
         )
 
-        mapping._info.pop('links', None)
-
 
 class ShowMapping(command.ShowOne):
     _description = _("Display mapping 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(
             'mapping',
@@ -227,10 +254,13 @@ class ShowMapping(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.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'
+        )
 
-        mapping = identity_client.federation.mappings.get(parsed_args.mapping)
+        mapping = identity_client.get_mapping(parsed_args.mapping)
 
-        mapping._info.pop('links', None)
-        return zip(*sorted(mapping._info.items()))
+        return _format_mapping(mapping)

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,14 +15,20 @@
 
 """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.identity.v3 import project as _project
+from openstack import utils as sdk_utils
 from osc_lib.cli import parseractions
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common
 from openstackclient.identity.v3 import tag
@@ -30,10 +36,12 @@ from openstackclient.identity.v3 import tag
 LOG = logging.getLogger(__name__)
 
 
-def _format_project(project):
+def _format_project(
+    project: _project.Project,
+) -> tuple[tuple[str, ...], tuple[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(
+    column_headers, columns = utils.get_osc_show_columns_for_sdk_resource(
         project,
         {'is_enabled': 'enabled'},
         ['links', 'location', 'parents_as_ids', 'subtree_as_ids'],
@@ -48,7 +56,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 +112,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 +193,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 +208,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 +246,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',
@@ -287,10 +301,15 @@ class ListProject(command.Lister):
             help=_('List only disabled projects'),
         )
         tag.add_tag_filtering_option_to_parser(parser, _('projects'))
+        pagination.add_marker_pagination_option_to_parser(parser)
         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:
@@ -334,6 +353,13 @@ class ListProject(command.Lister):
         if parsed_args.is_enabled is not None:
             kwargs['is_enabled'] = parsed_args.is_enabled
 
+        if parsed_args.limit is not None:
+            kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            kwargs['max_items'] = parsed_args.max_items
+        if parsed_args.marker is not None:
+            kwargs['marker'] = parsed_args.marker
+
         tag.get_tag_filtering_args(parsed_args, kwargs)
 
         if parsed_args.my_projects:
@@ -341,22 +367,23 @@ class ListProject(command.Lister):
             kwargs = {}
             user = self.app.client_manager.auth_ref.user_id
 
-        if user:
-            data = identity_client.user_projects(user, **kwargs)
-        else:
+        if not user:
             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)
+                    assert user is not None, 'this should not happen'
+                    data = list(identity_client.user_projects(user))
                 else:
                     raise
+        else:
+            data = list(identity_client.user_projects(user, **kwargs))
 
         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 +394,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 +445,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 +510,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 +536,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 +569,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,19 +13,25 @@
 
 """Identity v3 Region action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack.identity.v3 import region as _region
+from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _format_region(region):
+def _format_region(
+    region: _region.Region,
+) -> tuple[tuple[str, ...], tuple[Any, ...]]:
     columns = ('id', 'description', 'parent_region_id')
     column_headers = ('region', 'description', 'parent_region')
     return (
@@ -37,7 +43,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 +64,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 +83,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 +93,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 +120,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 +129,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 +160,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 +179,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 +196,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 +205,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)