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

openstackclient/image/v2/metadef_namespaces.py

@@ -15,8 +15,12 @@
 
 """Image V2 Action Implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack.image.v2 import metadef_namespace as _metadef_namespace
 from osc_lib.cli import format_columns
 from osc_lib import exceptions
 from osc_lib import utils
@@ -31,7 +35,9 @@ _formatters = {
 LOG = logging.getLogger(__name__)
 
 
-def _format_namespace(namespace):
+def _format_namespace(
+    namespace: _metadef_namespace.MetadefNamespace,
+) -> dict[str, Any]:
     info = {}
 
     fields_to_show = [
@@ -41,23 +47,22 @@ def _format_namespace(namespace):
         'namespace',
         'owner',
         'protected',
+        'tags',
         'schema',
         'updated_at',
         'visibility',
     ]
 
-    namespace = namespace.to_dict(ignore_none=True, original_names=True)
+    data = namespace.to_dict(ignore_none=True, original_names=True)
 
     # split out the usual key and the properties which are top-level
-    for key in namespace:
+    for key in data:
         if key in fields_to_show:
-            info[key] = namespace.get(key)
+            info[key] = data.get(key)
         elif key == "resource_type_associations":
-            info[key] = [
-                resource_type['name'] for resource_type in namespace.get(key)
-            ]
+            info[key] = [resource_type['name'] for resource_type in data[key]]
         elif key == 'properties':
-            info['properties'] = list(namespace.get(key).keys())
+            info['properties'] = list(data[key].keys())
 
     return info
 
@@ -65,7 +70,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 +119,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 +140,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 +157,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 +187,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 +201,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 +231,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 +280,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 +314,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 +342,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 +352,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: str) -> argparse.ArgumentParser:
+        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: argparse.Namespace) -> None:
+        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)

openstackclient/image/v2/metadef_objects.py

@@ -15,8 +15,12 @@
 
 """Image V2 Action Implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack.image.v2 import metadef_object as _metadef_object
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -27,7 +31,9 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _format_object(md_object):
+def _format_object(
+    md_object: _metadef_object.MetadefObject,
+) -> tuple[tuple[str, ...], Iterable[Any]]:
     fields_to_show = (
         'created_at',
         'description',
@@ -40,17 +46,14 @@ def _format_object(md_object):
 
     return (
         fields_to_show,
-        utils.get_item_properties(
-            md_object,
-            fields_to_show,
-        ),
+        utils.get_item_properties(md_object, fields_to_show),
     )
 
 
 class CreateMetadefObjects(command.ShowOne):
     _description = _("Create a metadef object")
 
-    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",
@@ -64,7 +67,9 @@ class CreateMetadefObjects(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 = image_client.get_metadef_namespace(
@@ -83,7 +88,7 @@ class CreateMetadefObjects(command.ShowOne):
 class ShowMetadefObjects(command.ShowOne):
     _description = _("Show a particular metadef object")
 
-    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",
@@ -97,7 +102,9 @@ class ShowMetadefObjects(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
@@ -113,7 +120,7 @@ class ShowMetadefObjects(command.ShowOne):
 class DeleteMetadefObject(command.Command):
     _description = _("Delete metadata definitions object(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(
             "namespace",
@@ -131,13 +138,14 @@ class DeleteMetadefObject(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
 
         namespace = parsed_args.namespace
 
         if not parsed_args.objects:
-            return image_client.delete_all_metadef_objects(namespace)
+            image_client.delete_all_metadef_objects(namespace)
+            return
 
         result = 0
         for obj in parsed_args.objects:
@@ -166,7 +174,7 @@ class DeleteMetadefObject(command.Command):
 class ListMetadefObjects(command.Lister):
     _description = _("List metadef objects inside a specific 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",
@@ -175,7 +183,9 @@ class ListMetadefObjects(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
 
         namespace = parsed_args.namespace
@@ -198,7 +208,7 @@ class ListMetadefObjects(command.Lister):
 class SetMetadefObject(command.Command):
     _description = _("Update a metadef object")
 
-    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",
@@ -216,7 +226,7 @@ class SetMetadefObject(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
 
         object = image_client.get_metadef_object(
@@ -236,7 +246,7 @@ class ShowMetadefObjectProperty(command.ShowOne):
         "Describe a specific metadata definitions property inside an object."
     )
 
-    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",
@@ -254,7 +264,9 @@ class ShowMetadefObjectProperty(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_name = parsed_args.namespace
@@ -274,4 +286,5 @@ class ShowMetadefObjectProperty(command.ShowOne):
             }
             raise exceptions.CommandError(msg)
 
-        return zip(*sorted(prop.items()))
+        col_headers, col_data = zip(*sorted(prop.items()))
+        return col_headers, col_data

openstackclient/image/v2/metadef_properties.py

@@ -12,9 +12,13 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+import argparse
+from collections.abc import Iterable, Sequence
 import json
 import logging
+from typing import Any
 
+from openstack.image.v2 import metadef_property as _metadef_property
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -25,10 +29,12 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _format_property(prop):
-    prop = prop.to_dict(ignore_none=True, original_names=True)
+def _format_property(
+    prop: _metadef_property.MetadefProperty,
+) -> dict[str, Any]:
+    data = prop.to_dict(ignore_none=True, original_names=True)
     return {
-        key: prop[key]
+        key: data[key]
         for key in [
             'namespace_name',
             'name',
@@ -50,14 +56,14 @@ def _format_property(prop):
             'max_items',
             'allow_additional_items',
         ]
-        if key in prop
+        if key in data
     }
 
 
 class CreateMetadefProperty(command.ShowOne):
     _description = _("Create a metadef property")
 
-    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",
@@ -85,7 +91,9 @@ class CreateMetadefProperty(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
 
         kwargs = {
@@ -108,13 +116,14 @@ class CreateMetadefProperty(command.ShowOne):
         )
         info = _format_property(data)
 
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data
 
 
 class DeleteMetadefProperty(command.Command):
     _description = _("Delete metadef propert(ies)")
 
-    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",
@@ -133,7 +142,7 @@ class DeleteMetadefProperty(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
 
         if not parsed_args.properties:
@@ -174,7 +183,7 @@ class DeleteMetadefProperty(command.Command):
 class ListMetadefProperties(command.Lister):
     _description = _("List metadef 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",
@@ -183,7 +192,9 @@ class ListMetadefProperties(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
         props = image_client.metadef_properties(parsed_args.namespace)
         columns = ['name', 'title', 'type']
@@ -202,7 +213,7 @@ class ListMetadefProperties(command.Lister):
 class SetMetadefProperty(command.Command):
     _description = _("Update metadef namespace property")
 
-    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",
@@ -230,7 +241,7 @@ class SetMetadefProperty(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
 
         # We need to pass the values for *all* attributes as kwargs to
@@ -267,7 +278,7 @@ class SetMetadefProperty(command.Command):
 class ShowMetadefProperty(command.ShowOne):
     _description = _("Show a particular metadef property")
 
-    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",
@@ -281,7 +292,9 @@ class ShowMetadefProperty(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
         data = image_client.get_metadef_property(
             parsed_args.property,
@@ -289,4 +302,5 @@ class ShowMetadefProperty(command.ShowOne):
         )
         info = _format_property(data)
 
-        return zip(*sorted(info.items()))
+        col_headers, col_data = zip(*sorted(info.items()))
+        return col_headers, col_data

openstackclient/image/v2/metadef_resource_type_association.py

@@ -10,7 +10,10 @@
 #   License for the specific language governing permissions and limitations
 #   under the License.
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -21,7 +24,7 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
@@ -31,7 +34,7 @@ def _get_columns(item):
 class CreateMetadefResourceTypeAssociation(command.ShowOne):
     _description = _("Create metadef resource type association")
 
-    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",
@@ -56,7 +59,9 @@ class CreateMetadefResourceTypeAssociation(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
         kwargs = {}
 
@@ -79,7 +84,7 @@ class CreateMetadefResourceTypeAssociation(command.ShowOne):
 class DeleteMetadefResourceTypeAssociation(command.Command):
     _description = _("Delete metadef resource type association")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "metadef_namespace",
@@ -107,7 +112,7 @@ class DeleteMetadefResourceTypeAssociation(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
@@ -160,7 +165,7 @@ class DeleteMetadefResourceTypeAssociation(command.Command):
 class ListMetadefResourceTypeAssociations(command.Lister):
     _description = _("List metadef resource type associations")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "metadef_namespace",
@@ -169,7 +174,9 @@ class ListMetadefResourceTypeAssociations(command.Lister):
         )
         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
         data = image_client.metadef_resource_type_associations(
             parsed_args.metadef_namespace,

openstackclient/image/v2/metadef_resource_types.py

@@ -12,6 +12,10 @@
 
 """Image V2 Action Implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
 from osc_lib import utils
 
 from openstackclient import command
@@ -21,7 +25,9 @@ from openstackclient.i18n import _
 class ListMetadefResourceTypes(command.Lister):
     _description = _("List metadef resource types")
 
-    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
         data = image_client.metadef_resource_types()
         columns = ['Name']