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

openstackclient/identity/v3/user.py

@@ -15,23 +15,27 @@
 
 """Identity v3 User action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import copy
 import logging
-import typing as ty
+from typing import Any
 
 from openstack import exceptions as sdk_exc
+from openstack.identity.v3 import user as _user
+from openstack import utils as sdk_utils
 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
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _format_user(user):
+def _format_user(user: _user.User) -> tuple[tuple[str, ...], tuple[Any, ...]]:
     columns = (
         'default_project_id',
         'domain_id',
@@ -60,8 +64,10 @@ def _format_user(user):
     )
 
 
-def _get_options_for_user(identity_client, parsed_args):
-    options: dict[str, ty.Any] = {}
+def _get_options_for_user(
+    identity_client: Any, parsed_args: argparse.Namespace
+) -> dict[str, Any]:
+    options: dict[str, Any] = {}
     if parsed_args.ignore_lockout_failure_attempts:
         options['ignore_lockout_failure_attempts'] = True
     if parsed_args.no_ignore_lockout_failure_attempts:
@@ -91,7 +97,7 @@ def _get_options_for_user(identity_client, parsed_args):
     return options
 
 
-def _add_user_options(parser):
+def _add_user_options(parser: argparse.ArgumentParser) -> None:
     # Add additional user options
 
     parser.add_argument(
@@ -191,7 +197,7 @@ def _add_user_options(parser):
 class CreateUser(command.ShowOne):
     _description = _("Create new user")
 
-    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',
@@ -250,10 +256,14 @@ class CreateUser(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_id = None
         if parsed_args.domain:
@@ -333,7 +343,7 @@ class CreateUser(command.ShowOne):
 class DeleteUser(command.Command):
     _description = _("Delete user(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(
             'users',
@@ -348,8 +358,10 @@ class DeleteUser(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'
+        )
 
         domain = None
         if parsed_args.domain:
@@ -393,7 +405,7 @@ class DeleteUser(command.Command):
 class ListUser(command.Lister):
     _description = _("List users")
 
-    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',
@@ -437,10 +449,21 @@ class ListUser(command.Lister):
                 '--project and --group'
             ),
         )
+        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[Sequence[str], Iterable[tuple[Any, ...]]]:
+        if parsed_args.project and (
+            parsed_args.limit is not None or parsed_args.marker is not None
+        ):
+            msg = _('--limit and --marker are not supported with --project')
+            raise exceptions.CommandError(msg)
+
+        identity_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.identity, '3'
+        )
 
         domain = None
         if parsed_args.domain:
@@ -460,6 +483,15 @@ class ListUser(command.Lister):
         if parsed_args.is_enabled is not None:
             enabled = parsed_args.is_enabled
 
+        pagination_kwargs: dict[str, Any] = {}
+        if parsed_args.limit is not None:
+            pagination_kwargs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            pagination_kwargs['max_items'] = parsed_args.max_items
+        if parsed_args.marker is not None:
+            pagination_kwargs['marker'] = parsed_args.marker
+
+        data: list[_user.User]
         if parsed_args.project:
             if domain is not None:
                 project = identity_client.find_project(
@@ -489,21 +521,28 @@ class ListUser(command.Lister):
             for user_id in user_ids:
                 user = identity_client.find_user(user_id, ignore_missing=False)
                 data.append(user)
-
         elif parsed_args.group:
-            data = identity_client.group_users(
-                domain_id=domain,
-                group=group,
+            assert group is not None
+            data = list(
+                identity_client.group_users(
+                    domain_id=domain, group=group, **pagination_kwargs
+                )
             )
         else:
             if parsed_args.is_enabled is not None:
-                data = identity_client.users(
-                    domain_id=domain,
-                    is_enabled=enabled,
+                data = list(
+                    identity_client.users(
+                        domain_id=domain,
+                        is_enabled=enabled,
+                        **pagination_kwargs,
+                    )
                 )
             else:
-                data = identity_client.users(
-                    domain_id=domain,
+                data = list(
+                    identity_client.users(
+                        domain_id=domain,
+                        **pagination_kwargs,
+                    )
                 )
 
         # Column handling
@@ -541,7 +580,7 @@ class ListUser(command.Lister):
 class SetUser(command.Command):
     _description = _("Set user 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(
             'user',
@@ -603,8 +642,10 @@ class SetUser(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'
+        )
 
         if parsed_args.password_prompt:
             parsed_args.password = utils.get_password(self.app.stdin)
@@ -676,7 +717,7 @@ class SetPasswordUser(command.Command):
 
     required_scope = 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(
             '--password',
@@ -690,15 +731,20 @@ class SetPasswordUser(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'
+        )
         conn = self.app.client_manager.sdk_connection
         auth = conn.config.get_auth()
         if auth is None:
             # this will never happen
             raise exceptions.CommandError('invalid authentication info')
 
-        user_id = auth.get_user_id(conn.identity)
+        user_id = auth.get_user_id(conn.session)
+        if user_id is None:
+            # this will never happen
+            raise exceptions.CommandError('invalid authentication info')
 
         # FIXME(gyee): there are two scenarios:
         #
@@ -740,7 +786,7 @@ class SetPasswordUser(command.Command):
                 )
             )
 
-        identity_client.update_user(
+        identity_client.update_password(
             user=user_id,
             current_password=current_password,
             password=password,
@@ -750,7 +796,7 @@ class SetPasswordUser(command.Command):
 class ShowUser(command.ShowOne):
     _description = _("Display user 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(
             'user',
@@ -764,8 +810,12 @@ class ShowUser(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'
+        )
 
         user_str = common._get_token_resource(
             identity_client, 'user', parsed_args.user, parsed_args.domain

openstackclient/image/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 osc_lib import utils
 
@@ -27,7 +29,7 @@ API_NAME = 'image'
 API_VERSIONS = ('1', '2')
 
 
-def make_client(instance):
+def make_client(instance: Any) -> Any:
     """Returns an image service client."""
     LOG.debug(
         'Image client initialized using OpenStack SDK: %s',
@@ -36,7 +38,9 @@ def make_client(instance):
     return instance.sdk_connection.image
 
 
-def build_option_parser(parser):
+def build_option_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
     """Hook to add global options"""
     parser.add_argument(
         '--os-image-api-version',
@@ -48,6 +52,6 @@ def build_option_parser(parser):
     return parser
 
 
-def check_api_version(check_version):
+def check_api_version(check_version: str) -> bool:
     # SDK supports auto-negotiation for us: always return True
     return True

openstackclient/image/v1/image.py

@@ -19,7 +19,8 @@ import argparse
 import logging
 import os
 import sys
-import typing as ty
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from cliff import columns as cliff_columns
 from osc_lib.api import utils as api_utils
@@ -51,7 +52,7 @@ DISK_CHOICES = [
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {'is_protected': 'protected', 'owner_id': 'owner'}
     hidden_columns = [
         'location',
@@ -69,7 +70,7 @@ def _get_columns(item):
 
 
 class HumanReadableSizeColumn(cliff_columns.FormattableColumn[int]):
-    def human_readable(self):
+    def human_readable(self) -> str:
         """Return a formatted visibility string
 
         :rtype:
@@ -83,7 +84,7 @@ class HumanReadableSizeColumn(cliff_columns.FormattableColumn[int]):
 
 
 class VisibilityColumn(cliff_columns.FormattableColumn[bool]):
-    def human_readable(self):
+    def human_readable(self) -> str:
         """Return a formatted visibility string
 
         :rtype:
@@ -99,7 +100,7 @@ class VisibilityColumn(cliff_columns.FormattableColumn[bool]):
 class CreateImage(command.ShowOne):
     _description = _("Create/upload an image")
 
-    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",
@@ -239,7 +240,9 @@ class CreateImage(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         image_client = self.app.client_manager.image
 
         # Build an attribute dict from the parsed args, only include
@@ -299,7 +302,7 @@ class CreateImage(command.ShowOne):
                     volume_client.volumes,
                     parsed_args.volume,
                 )
-                response, body = volume_client.volumes.upload_to_image(
+                _response, body = volume_client.volumes.upload_to_image(
                     source_volume.id,
                     parsed_args.force,
                     parsed_args.name,
@@ -314,10 +317,10 @@ class CreateImage(command.ShowOne):
             else:
                 # Read file from stdin
                 if not sys.stdin.isatty():
-                    if os.name == "nt":
+                    if sys.platform == "win32":
                         import msvcrt
 
-                        msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)  # type: ignore
+                        msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
                     if hasattr(sys.stdin, 'buffer'):
                         kwargs['data'] = sys.stdin.buffer
                     else:
@@ -351,13 +354,15 @@ class CreateImage(command.ShowOne):
             info['properties'] = format_columns.DictColumn(
                 info.get('properties', {})
             )
-            return zip(*sorted(info.items()))
+            col_headers, col_data = zip(*sorted(info.items()))
+            return col_headers, col_data
+        return ((), ())
 
 
 class DeleteImage(command.Command):
     _description = _("Delete image(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(
             "images",
@@ -367,7 +372,7 @@ class DeleteImage(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         result = 0
         image_client = self.app.client_manager.image
         for image in parsed_args.images:
@@ -396,7 +401,7 @@ class DeleteImage(command.Command):
 class ListImage(command.Lister):
     _description = _("List available images")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         public_group = parser.add_mutually_exclusive_group()
         public_group.add_argument(
@@ -453,7 +458,9 @@ class ListImage(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         image_client = self.app.client_manager.image
 
         kwargs = {}
@@ -498,7 +505,7 @@ class ListImage(command.Lister):
 
         if parsed_args.property:
             # NOTE(dtroyer): coerce to a list to subscript it in py3
-            attr, value = list(parsed_args.property.items())[0]
+            attr, value = next(iter(parsed_args.property.items()))
             api_utils.simple_filter(
                 images,
                 attr=attr,
@@ -527,7 +534,7 @@ class ListImage(command.Lister):
 class SaveImage(command.Command):
     _description = _("Save an image locally")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--chunk-size",
@@ -551,7 +558,7 @@ class SaveImage(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         image_client = self.app.client_manager.image
         image = image_client.find_image(
             parsed_args.image, ignore_missing=False
@@ -572,7 +579,7 @@ class SaveImage(command.Command):
 class SetImage(command.Command):
     _description = _("Set image 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(
             "image",
@@ -702,7 +709,7 @@ class SetImage(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         image_client = self.app.client_manager.image
 
         kwargs = {}
@@ -785,10 +792,10 @@ class SetImage(command.Command):
                     # Read file from stdin
                     if sys.stdin.isatty() is not True:
                         if parsed_args.stdin:
-                            if os.name == "nt":
+                            if sys.platform == "win32":
                                 import msvcrt
 
-                                msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)  # type: ignore
+                                msvcrt.setmode(sys.stdin.fileno(), os.O_BINARY)
                             if hasattr(sys.stdin, 'buffer'):
                                 kwargs['data'] = sys.stdin.buffer
                             else:
@@ -819,7 +826,7 @@ class SetImage(command.Command):
 class ShowImage(command.ShowOne):
     _description = _("Display image 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(
             "--human-readable",
@@ -834,15 +841,15 @@ class ShowImage(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         image_client = self.app.client_manager.image
         image = image_client.find_image(
             parsed_args.image, ignore_missing=False
         )
 
-        formatters: dict[
-            str, type[cliff_columns.FormattableColumn[ty.Any]]
-        ] = {
+        formatters: dict[str, type[cliff_columns.FormattableColumn[Any]]] = {
             'properties': format_columns.DictColumn,
         }
         if parsed_args.human_readable:

openstackclient/image/v2/cache.py

@@ -13,9 +13,12 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import argparse
+from collections.abc import Iterable, Sequence
 import copy
 import datetime
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -27,7 +30,7 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _format_image_cache(cached_images):
+def _format_image_cache(cached_images: dict[str, Any]) -> list[dict[str, Any]]:
     """Format image cache to make it more consistent with OSC operations."""
 
     image_list = []
@@ -38,14 +41,14 @@ def _format_image_cache(cached_images):
                 image_obj['state'] = 'cached'
                 image_obj['last_accessed'] = (
                     datetime.datetime.fromtimestamp(
-                        image['last_accessed'], tz=datetime.timezone.utc
+                        image['last_accessed'], tz=datetime.UTC
                     )
                     .replace(tzinfo=None)
                     .isoformat()
                 )
                 image_obj['last_modified'] = (
                     datetime.datetime.fromtimestamp(
-                        image['last_modified'], tz=datetime.timezone.utc
+                        image['last_modified'], tz=datetime.UTC
                     )
                     .replace(tzinfo=None)
                     .isoformat()
@@ -70,11 +73,13 @@ def _format_image_cache(cached_images):
 class ListCachedImage(command.Lister):
     _description = _("Get Cache State")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         image_client = self.app.client_manager.image
 
         # List of Cache data received
@@ -111,7 +116,7 @@ class ListCachedImage(command.Lister):
 class QueueCachedImage(command.Command):
     _description = _("Queue image(s) for caching.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "images",
@@ -121,7 +126,7 @@ class QueueCachedImage(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         image_client = self.app.client_manager.image
 
         failures = 0
@@ -151,7 +156,7 @@ class QueueCachedImage(command.Command):
 class DeleteCachedImage(command.Command):
     _description = _("Delete image(s) from cache")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "images",
@@ -161,7 +166,7 @@ class DeleteCachedImage(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         failures = 0
         image_client = self.app.client_manager.image
         for image in parsed_args.images:
@@ -190,7 +195,7 @@ class DeleteCachedImage(command.Command):
 class ClearCachedImage(command.Command):
     _description = _("Clear all images from cache, queue or both")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--cache",
@@ -210,7 +215,7 @@ class ClearCachedImage(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         image_client = self.app.client_manager.image
 
         target = parsed_args.target