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

openstackclient/image/v2/image.py

@@ -17,11 +17,12 @@
 
 import argparse
 from base64 import b64encode
+from collections.abc import Iterable, Sequence
 import copy
 import logging
 import os
 import sys
-import typing as ty
+from typing import Any
 import urllib.parse
 
 from openstack import exceptions as sdk_exceptions
@@ -73,7 +74,7 @@ MEMBER_STATUS_CHOICES = ["accepted", "pending", "rejected", "all"]
 LOG = logging.getLogger(__name__)
 
 
-def _format_image(image, human_readable=False):
+def _format_image(image: Any, human_readable: bool = False) -> dict[str, Any]:
     """Format an image to make it more consistent with OSC operations."""
 
     info = {}
@@ -137,7 +138,7 @@ _formatters = {
 }
 
 
-def _get_member_columns(item):
+def _get_member_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {'image_id': 'image_id'}
     hidden_columns = ['id', 'location', 'name']
     return utils.get_osc_show_columns_for_sdk_resource(
@@ -147,7 +148,7 @@ def _get_member_columns(item):
     )
 
 
-def get_data_from_stdin():
+def get_data_from_stdin() -> Any:
     # distinguish cases where:
     # (1) stdin is not valid (as in cron jobs):
     #    openstack ... <&-
@@ -166,10 +167,10 @@ def get_data_from_stdin():
         image = sys.stdin
         if hasattr(sys.stdin, 'buffer'):
             image = sys.stdin.buffer
-        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)
 
         return image
     else:
@@ -177,7 +178,7 @@ def get_data_from_stdin():
         return None
 
 
-def _add_is_protected_args(parser):
+def _add_is_protected_args(parser: argparse.ArgumentParser) -> None:
     protected_group = parser.add_mutually_exclusive_group()
     protected_group.add_argument(
         "--protected",
@@ -195,7 +196,7 @@ def _add_is_protected_args(parser):
     )
 
 
-def _add_visibility_args(parser):
+def _add_visibility_args(parser: argparse.ArgumentParser) -> None:
     public_group = parser.add_mutually_exclusive_group()
     public_group.add_argument(
         "--public",
@@ -241,7 +242,7 @@ def _add_visibility_args(parser):
 class AddProjectToImage(command.ShowOne):
     _description = _("Associate project with 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(
             "image",
@@ -256,7 +257,9 @@ class AddProjectToImage(command.ShowOne):
         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
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         image_client = self.app.client_manager.image
         identity_client = self.app.client_manager.identity
 
@@ -287,7 +290,7 @@ class CreateImage(command.ShowOne):
 
     deadopts = ('size', 'location', 'copy-from', 'checksum', 'store')
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         # TODO(bunting): There are additional arguments that v1 supported
         # that v2 either doesn't support or supports weirdly.
@@ -440,13 +443,15 @@ class CreateImage(command.ShowOne):
             )
         return parser
 
-    def _take_action_image(self, parsed_args):
+    def _take_action_image(
+        self, parsed_args: argparse.Namespace
+    ) -> dict[str, Any]:
         identity_client = self.app.client_manager.identity
         image_client = self.app.client_manager.image
 
         # Build an attribute dict from the parsed args, only include
         # attributes that were actually set on the command line
-        kwargs: dict[str, ty.Any] = {'allow_duplicates': True}
+        kwargs: dict[str, Any] = {'allow_duplicates': True}
         copy_attrs = (
             'name',
             'id',
@@ -592,8 +597,12 @@ class CreateImage(command.ShowOne):
         image = image_client.get_image(image)
         return _format_image(image)
 
-    def _take_action_volume(self, parsed_args):
-        volume_client = self.app.client_manager.sdk_connection.volume
+    def _take_action_volume(
+        self, parsed_args: argparse.Namespace
+    ) -> dict[str, Any]:
+        volume_client = sdk_utils.ensure_service_version(
+            self.app.client_manager.sdk_connection.volume, '3'
+        )
 
         unsupported_opts = {
             # 'name',  # 'name' is a positional argument and will always exist
@@ -622,12 +631,12 @@ class CreateImage(command.ShowOne):
                 )
                 # TODO(stephenfin): These should be an error in a future
                 # version
-                LOG.warning(msg % opt_name)
+                LOG.warning(msg, opt_name)
 
         source_volume = volume_client.find_volume(
             parsed_args.volume, ignore_missing=False
         )
-        kwargs: dict[str, ty.Any] = {
+        kwargs: dict[str, Any] = {
             'visibility': None,
             'protected': None,
         }
@@ -643,7 +652,7 @@ class CreateImage(command.ShowOne):
             kwargs['visibility'] = parsed_args.visibility or 'private'
             kwargs['protected'] = parsed_args.is_protected or False
 
-        response = volume_client.upload_volume_to_image(
+        response: dict[str, Any] = volume_client.upload_volume_to_image(
             source_volume.id,
             parsed_args.name,
             force=parsed_args.force,
@@ -659,7 +668,9 @@ class CreateImage(command.ShowOne):
 
         return info
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         for deadopt in self.deadopts:
             if getattr(parsed_args, deadopt.replace('-', '_'), None):
                 msg = _(
@@ -673,13 +684,14 @@ class CreateImage(command.ShowOne):
         else:
             info = self._take_action_image(parsed_args)
 
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 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",
@@ -696,7 +708,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:
@@ -732,7 +744,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(
@@ -861,7 +873,9 @@ class ListImage(command.Lister):
         pagination.add_marker_pagination_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         identity_client = self.app.client_manager.identity
         image_client = self.app.client_manager.image
 
@@ -962,7 +976,7 @@ class ListImage(command.Lister):
 class ListImageProjects(command.Lister):
     _description = _("List projects associated with 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(
             "image",
@@ -972,7 +986,9 @@ class ListImageProjects(command.Lister):
         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
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         image_client = self.app.client_manager.image
         columns: tuple[str, ...] = ("Image ID", "Member ID", "Status")
 
@@ -998,7 +1014,7 @@ class ListImageProjects(command.Lister):
 class RemoveProjectImage(command.Command):
     _description = _("Disassociate project with 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(
             "image",
@@ -1013,7 +1029,7 @@ class RemoveProjectImage(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:
         image_client = self.app.client_manager.image
         identity_client = self.app.client_manager.identity
 
@@ -1034,7 +1050,7 @@ class RemoveProjectImage(command.Command):
 class ShowProjectImage(command.ShowOne):
     _description = _("Show a particular project associated with 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(
             "image",
@@ -1049,7 +1065,9 @@ class ShowProjectImage(command.ShowOne):
         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
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         image_client = self.app.client_manager.image
 
         image = image_client.find_image(
@@ -1071,7 +1089,7 @@ class ShowProjectImage(command.ShowOne):
 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",
@@ -1096,7 +1114,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,
@@ -1120,7 +1138,7 @@ class SetImage(command.Command):
 
     deadopts = ('visibility',)
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         # TODO(bunting): There are additional arguments that v1 supported
         # --size - does not exist in v2
@@ -1296,7 +1314,7 @@ class SetImage(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
         image_client = self.app.client_manager.image
 
@@ -1421,7 +1439,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",
@@ -1436,7 +1454,9 @@ 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(
@@ -1445,13 +1465,14 @@ class ShowImage(command.ShowOne):
         )
 
         info = _format_image(image, parsed_args.human_readable)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class UnsetImage(command.Command):
     _description = _("Unset image tags and 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",
@@ -1482,7 +1503,7 @@ class UnsetImage(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,
@@ -1501,7 +1522,7 @@ class UnsetImage(command.Command):
                     )
                     tagret += 1
 
-        kwargs: dict[str, ty.Any] = {}
+        kwargs: dict[str, Any] = {}
         if parsed_args.properties:
             for k in parsed_args.properties:
                 if k in image:
@@ -1512,7 +1533,7 @@ class UnsetImage(command.Command):
                     # out, what was changed inside
                     # NOTE: ping gtema to improve that in SDK
                     new_props = kwargs.get(
-                        'properties', image.get('properties').copy()
+                        'properties', image['properties'].copy()
                     )
                     new_props.pop(k, None)
                     kwargs['properties'] = new_props
@@ -1569,7 +1590,7 @@ class StageImage(command.Command):
         "(Glance 16.0.0 (Queens))"
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -1599,7 +1620,7 @@ class StageImage(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(
@@ -1619,7 +1640,7 @@ class StageImage(command.Command):
         else:
             fp = get_data_from_stdin()
 
-        kwargs: dict[str, ty.Any] = {}
+        kwargs: dict[str, Any] = {}
 
         if parsed_args.progress and parsed_args.filename:
             # NOTE(stephenfin): we only show a progress bar if the user
@@ -1645,7 +1666,7 @@ class ImportImage(command.ShowOne):
         "(Glance 16.0.0 (Queens))"
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -1719,6 +1740,7 @@ class ImportImage(command.ShowOne):
         )
         stores_group.add_argument(
             '--all-stores',
+            action='store_true',
             help=_(
                 "Make image available to all stores "
                 "(either '--store' or '--all-stores' required with the "
@@ -1755,7 +1777,9 @@ class ImportImage(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
 
         try:
@@ -1885,7 +1909,8 @@ class ImportImage(command.ShowOne):
         )
 
         info = _format_image(image)
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class StoresInfo(command.Lister):
@@ -1893,7 +1918,7 @@ class StoresInfo(command.Lister):
         "Get available backends (only valid with Multi-Backend support)"
     )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--detail",
@@ -1906,7 +1931,9 @@ class StoresInfo(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         image_client = self.app.client_manager.image
         try:
             columns: tuple[str, ...] = ("id", "description", "is_default")

openstackclient/image/v2/info.py

@@ -11,6 +11,10 @@
 # under the License.
 
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
 from osc_lib.cli import format_columns
 
 from openstackclient import command
@@ -20,7 +24,9 @@ from openstackclient.i18n import _
 class ImportInfo(command.ShowOne):
     _description = _("Show available import methods")
 
-    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
 
         import_info = image_client.get_import_info()

openstackclient/image/v2/metadef_namespaces.py

@@ -15,7 +15,10 @@
 
 """Image V2 Action Implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
@@ -31,7 +34,7 @@ _formatters = {
 LOG = logging.getLogger(__name__)
 
 
-def _format_namespace(namespace):
+def _format_namespace(namespace: Any) -> dict[str, Any]:
     info = {}
 
     fields_to_show = [
@@ -41,6 +44,7 @@ def _format_namespace(namespace):
         'namespace',
         'owner',
         'protected',
+        'tags',
         'schema',
         'updated_at',
         'visibility',
@@ -65,7 +69,7 @@ def _format_namespace(namespace):
 class CreateMetadefNamespace(command.ShowOne):
     _description = _("Create a metadef namespace")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "namespace",
@@ -114,7 +118,9 @@ class CreateMetadefNamespace(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
         filter_keys = ['namespace', 'display_name', 'description']
         kwargs = {}
@@ -133,13 +139,14 @@ class CreateMetadefNamespace(command.ShowOne):
         data = image_client.create_metadef_namespace(**kwargs)
         info = _format_namespace(data)
 
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class DeleteMetadefNamespace(command.Command):
     _description = _("Delete metadef namespace")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "namespace",
@@ -149,7 +156,7 @@ class DeleteMetadefNamespace(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
 
         result = 0
@@ -179,7 +186,7 @@ class DeleteMetadefNamespace(command.Command):
 class ListMetadefNamespace(command.Lister):
     _description = _("List metadef namespaces")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--resource-types",
@@ -193,7 +200,9 @@ class ListMetadefNamespace(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
         filter_keys = ['resource_types', 'visibility']
         kwargs = {}
@@ -221,7 +230,7 @@ class ListMetadefNamespace(command.Lister):
 class SetMetadefNamespace(command.Command):
     _description = _("Set metadef namespace 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(
             "namespace",
@@ -270,9 +279,20 @@ class SetMetadefNamespace(command.Command):
             dest="is_protected",
             help=_("Allow metadef namespace to be deleted (default)"),
         )
+        parser.add_argument(
+            "--tag",
+            metavar="<tag>",
+            action='append',
+            default=[],
+            dest='tags',
+            help=_(
+                "Set a tag on this metadef namespace "
+                "(repeat option to set multiple tags)"
+            ),
+        )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         image_client = self.app.client_manager.image
 
         namespace = parsed_args.namespace
@@ -293,11 +313,26 @@ class SetMetadefNamespace(command.Command):
 
         image_client.update_metadef_namespace(namespace, **kwargs)
 
+        errors = 0
+        for tag in parsed_args.tags:
+            try:
+                image_client.add_tag_to_metadef_namespace(namespace, tag)
+            except Exception:
+                LOG.error(_("Tag set failed for tag %s"), tag)
+                errors += 1
+
+        if errors > 0:
+            msg = _("Failed to set %(errors)s of %(total)s tags.") % {
+                'errors': errors,
+                'total': len(parsed_args.tags),
+            }
+            raise exceptions.CommandError(msg)
+
 
 class ShowMetadefNamespace(command.ShowOne):
     _description = _("Show a metadef namespace")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "namespace",
@@ -306,7 +341,9 @@ class ShowMetadefNamespace(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
 
         namespace = parsed_args.namespace
@@ -314,4 +351,63 @@ class ShowMetadefNamespace(command.ShowOne):
         data = image_client.get_metadef_namespace(namespace)
         info = _format_namespace(data)
 
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
+
+
+class UnsetMetadefNamespace(command.Command):
+    _description = _("Unset metadef namespace tags")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "namespace",
+            metavar="<namespace>",
+            help=_("Metadef namespace to modify (name)"),
+        )
+        tag_group = parser.add_mutually_exclusive_group(required=True)
+        tag_group.add_argument(
+            "--tag",
+            metavar="<tag>",
+            action='append',
+            default=[],
+            dest='tags',
+            help=_(
+                "Unset a tag on this metadef namespace "
+                "(repeat option to unset multiple tags)"
+            ),
+        )
+        tag_group.add_argument(
+            "--all-tags",
+            action="store_true",
+            default=False,
+            help=_("Unset all metadef tags"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        image_client = self.app.client_manager.image
+
+        namespace = image_client.get_metadef_namespace(parsed_args.namespace)
+
+        errors = 0
+        if parsed_args.all_tags:
+            namespace = image_client.remove_tags_from_metadef_namespace(
+                namespace
+            )
+        elif parsed_args.tags:
+            for tag in parsed_args.tags:
+                try:
+                    image_client.remove_tag_from_metadef_namespace(
+                        namespace, tag
+                    )
+                except Exception:
+                    LOG.error(_("tag unset failed for tag %s"), tag)
+                    errors += 1
+
+        if errors > 0:
+            msg = _("Failed to unset %(errors)s of %(total)s tags.") % {
+                'errors': errors,
+                'total': len(parsed_args.tags),
+            }
+            raise exceptions.CommandError(msg)