python-openstackclient 6.4.0__py3-none-any.whl → 6.5.0__py3-none-any.whl

openstackclient/image/v2/image.py

@@ -992,6 +992,43 @@ class RemoveProjectImage(command.Command):
         image_client.remove_member(member=project_id, image=image.id)
 
 
+class ShowProjectImage(command.ShowOne):
+    _description = _("Show a particular project associated with image")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "image",
+            metavar="<image>",
+            help=_("Image (name or ID)"),
+        )
+        parser.add_argument(
+            "member",
+            metavar="<project>",
+            help=_("Project to show (name or ID)"),
+        )
+        identity_common.add_project_domain_option_to_parser(parser)
+        return parser
+
+    def take_action(self, parsed_args):
+        image_client = self.app.client_manager.image
+
+        image = image_client.find_image(
+            parsed_args.image,
+            ignore_missing=False,
+        )
+
+        obj = image_client.get_member(
+            image=image.id,
+            member=parsed_args.member,
+        )
+
+        display_columns, columns = _get_member_columns(obj)
+        data = utils.get_item_properties(obj, columns, formatters={})
+
+        return (display_columns, data)
+
+
 class SaveImage(command.Command):
     _description = _("Save an image locally")
 

openstackclient/image/v2/metadef_namespaces.py

@@ -42,6 +42,7 @@ def _format_namespace(namespace):
         'owner',
         'protected',
         'schema',
+        'updated_at',
         'visibility',
     ]
 
@@ -61,7 +62,7 @@ def _format_namespace(namespace):
     return info
 
 
-class CreateMetadefNameSpace(command.ShowOne):
+class CreateMetadefNamespace(command.ShowOne):
     _description = _("Create a metadef namespace")
 
     def get_parser(self, prog_name):
@@ -130,20 +131,21 @@ class CreateMetadefNameSpace(command.ShowOne):
             kwargs['visibility'] = parsed_args.visibility
 
         data = image_client.create_metadef_namespace(**kwargs)
+        info = _format_namespace(data)
 
-        return zip(*sorted(data.items()))
+        return zip(*sorted(info.items()))
 
 
-class DeleteMetadefNameSpace(command.Command):
+class DeleteMetadefNamespace(command.Command):
     _description = _("Delete metadef namespace")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            "namespace_name",
-            metavar="<namespace_name>",
+            "namespace",
+            metavar="<namespace>",
             nargs="+",
-            help=_("An identifier (a name) for the namespace"),
+            help=_("Metadef namespace(s) to delete (name)"),
         )
         return parser
 
@@ -151,9 +153,9 @@ class DeleteMetadefNameSpace(command.Command):
         image_client = self.app.client_manager.image
 
         result = 0
-        for i in parsed_args.namespace_name:
+        for ns in parsed_args.namespace:
             try:
-                namespace = image_client.get_metadef_namespace(i)
+                namespace = image_client.get_metadef_namespace(ns)
                 image_client.delete_metadef_namespace(namespace.id)
             except Exception as e:
                 result += 1
@@ -162,18 +164,18 @@ class DeleteMetadefNameSpace(command.Command):
                         "Failed to delete namespace with name or "
                         "ID '%(namespace)s': %(e)s"
                     ),
-                    {'namespace': i, 'e': e},
+                    {'namespace': ns, 'e': e},
                 )
 
         if result > 0:
-            total = len(parsed_args.namespace_name)
+            total = len(parsed_args.namespace)
             msg = _(
                 "%(result)s of %(total)s namespace failed " "to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
 
-class ListMetadefNameSpaces(command.Lister):
+class ListMetadefNamespace(command.Lister):
     _description = _("List metadef namespaces")
 
     def get_parser(self, prog_name):
@@ -215,7 +217,7 @@ class ListMetadefNameSpaces(command.Lister):
         )
 
 
-class SetMetadefNameSpace(command.Command):
+class SetMetadefNamespace(command.Command):
     _description = _("Set metadef namespace properties")
 
     def get_parser(self, prog_name):
@@ -223,7 +225,7 @@ class SetMetadefNameSpace(command.Command):
         parser.add_argument(
             "namespace",
             metavar="<namespace>",
-            help=_("Namespace (name) for the namespace"),
+            help=_("Metadef namespace to modify (name)"),
         )
         parser.add_argument(
             "--display-name",
@@ -241,14 +243,16 @@ class SetMetadefNameSpace(command.Command):
             action="store_const",
             const="public",
             dest="visibility",
-            help=_("Set namespace visibility 'public'"),
+            help=_("Metadef namespace is accessible to the public"),
         )
         visibility_group.add_argument(
             "--private",
             action="store_const",
             const="private",
             dest="visibility",
-            help=_("Set namespace visibility 'private'"),
+            help=_(
+                "Metadef namespace is inaccessible to the public (default)"
+            ),
         )
         protected_group = parser.add_mutually_exclusive_group()
         protected_group.add_argument(
@@ -289,24 +293,24 @@ class SetMetadefNameSpace(command.Command):
         image_client.update_metadef_namespace(namespace, **kwargs)
 
 
-class ShowMetadefNameSpace(command.ShowOne):
+class ShowMetadefNamespace(command.ShowOne):
     _description = _("Show a metadef namespace")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            "namespace_name",
-            metavar="<namespace_name>",
-            help=_("Namespace (name) for the namespace"),
+            "namespace",
+            metavar="<namespace>",
+            help=_("Metadef namespace to show (name)"),
         )
         return parser
 
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
 
-        namespace_name = parsed_args.namespace_name
+        namespace = parsed_args.namespace
 
-        data = image_client.get_metadef_namespace(namespace_name)
+        data = image_client.get_metadef_namespace(namespace)
         info = _format_namespace(data)
 
         return zip(*sorted(info.items()))

openstackclient/image/v2/metadef_objects.py

@@ -55,7 +55,7 @@ class CreateMetadefObjects(command.ShowOne):
         parser.add_argument(
             "--namespace",
             metavar="<namespace>",
-            help=_("Metadef namespace to create the metadef object in (name)"),
+            help=_("Metadef namespace to create the object in (name)"),
         )
         parser.add_argument(
             "name",
@@ -81,31 +81,29 @@ class CreateMetadefObjects(command.ShowOne):
 
 
 class ShowMetadefObjects(command.ShowOne):
-    _description = _(
-        "Describe a specific metadata definitions object inside a namespace"
-    )
+    _description = _("Show a particular metadef object")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            "namespace_name",
-            metavar="<namespace_name>",
-            help=_("Namespace (name) for the namespace"),
+            "namespace",
+            metavar="<namespace>",
+            help=_("Metadef namespace of the object (name)"),
         )
         parser.add_argument(
-            "object_name",
-            metavar="<object_name>",
-            help=_("Name of an object."),
+            "object",
+            metavar="<object>",
+            help=_("Metadef object to show"),
         )
         return parser
 
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
 
-        namespace_name = parsed_args.namespace_name
-        object_name = parsed_args.object_name
+        namespace = parsed_args.namespace
+        object = parsed_args.object
 
-        data = image_client.get_metadef_object(object_name, namespace_name)
+        data = image_client.get_metadef_object(object, namespace)
 
         fields, value = _format_object(data)
 
@@ -113,35 +111,33 @@ class ShowMetadefObjects(command.ShowOne):
 
 
 class DeleteMetadefObject(command.Command):
-    _description = _(
-        "Delete a specific metadata definitions object inside a namespace"
-    )
+    _description = _("Delete metadata definitions object(s)")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            "namespace_name",
-            metavar="<namespace_name>",
-            help=_("Namespace (name) for the namespace"),
+            "namespace",
+            metavar="<namespace>",
+            help=_("Metadef namespace of the object (name)"),
         )
         parser.add_argument(
-            "object_name",
-            metavar="<object_name>",
+            "objects",
+            metavar="<object>",
             nargs="+",
-            help=_("Name of an object."),
+            help=_("Metadef object(s) to delete (name)"),
         )
         return parser
 
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
 
-        namespace_name = parsed_args.namespace_name
+        namespace = parsed_args.namespace
 
         result = 0
-        for i in parsed_args.object_name:
+        for obj in parsed_args.objects:
             try:
-                object = image_client.get_metadef_object(i, namespace_name)
-                image_client.delete_metadef_object(object, namespace_name)
+                object = image_client.get_metadef_object(obj, namespace)
+                image_client.delete_metadef_object(object, namespace)
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -149,11 +145,11 @@ class DeleteMetadefObject(command.Command):
                         "Failed to delete object with name or "
                         "ID '%(object)s': %(e)s"
                     ),
-                    {'object': i, 'e': e},
+                    {'object': obj, 'e': e},
                 )
 
         if result > 0:
-            total = len(parsed_args.namespace_name)
+            total = len(parsed_args.namespace)
             msg = _("%(result)s of %(total)s object failed to delete.") % {
                 'result': result,
                 'total': total,
@@ -176,10 +172,10 @@ class ListMetadefObjects(command.Lister):
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
 
-        namespace_name = parsed_args.namespace
+        namespace = parsed_args.namespace
         columns = ['name', 'description']
 
-        md_objects = list(image_client.metadef_objects(namespace_name))
+        md_objects = list(image_client.metadef_objects(namespace))
         column_headers = columns
         return (
             column_headers,

openstackclient/image/v2/metadef_properties.py

@@ -13,6 +13,7 @@
 # under the License.
 
 import json
+import logging
 
 from osc_lib.command import command
 from osc_lib import exceptions
@@ -21,6 +22,9 @@ from osc_lib import utils
 from openstackclient.i18n import _
 
 
+LOG = logging.getLogger(__name__)
+
+
 def _format_property(prop):
     prop = prop.to_dict(ignore_none=True, original_names=True)
     return {
@@ -76,7 +80,7 @@ class CreateMetadefProperty(command.ShowOne):
             help=_("Valid JSON schema of the property"),
         )
         parser.add_argument(
-            "namespace_name",
+            "namespace",
             help=_("Name of namespace the property will belong."),
         )
         return parser
@@ -100,7 +104,7 @@ class CreateMetadefProperty(command.ShowOne):
             )
 
         data = image_client.create_metadef_property(
-            parsed_args.namespace_name, **kwargs
+            parsed_args.namespace, **kwargs
         )
         info = _format_property(data)
 
@@ -108,41 +112,55 @@ class CreateMetadefProperty(command.ShowOne):
 
 
 class DeleteMetadefProperty(command.Command):
-    _description = _("Delete a metadef property")
+    _description = _("Delete metadef propert(ies)")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            "namespace_name",
-            help=_("An identifier (a name) for the namespace"),
+            "namespace",
+            metavar="<namespace>",
+            help=_("Metadef namespace of the property (name)"),
         )
         parser.add_argument(
-            "property_name",
-            help=_("Property to delete"),
+            "properties",
+            metavar="<property>",
+            nargs="+",
+            help=_("Metadef propert(ies) to delete (name)"),
         )
         return parser
 
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
 
-        try:
-            image_client.delete_metadef_property(
-                parsed_args.property_name,
-                parsed_args.namespace_name,
-                ignore_missing=False,
-            )
-        except Exception as e:
-            raise exceptions.CommandError(
-                _(
-                    "Failed to delete property with name or "
-                    "ID '%(property)s' from namespace '%(namespace)s': %(e)s"
+        result = 0
+        for prop in parsed_args.properties:
+            try:
+                image_client.delete_metadef_property(
+                    prop,
+                    parsed_args.namespace,
+                    ignore_missing=False,
                 )
-                % {
-                    'property': parsed_args.property_name,
-                    'namespace': parsed_args.namespace_name,
-                    'e': e,
-                }
-            )
+            except Exception as e:
+                result += 1
+                LOG.error(
+                    _(
+                        "Failed to delete property with name or ID "
+                        "'%(property)s' from namespace '%(namespace)s': %(e)s"
+                    ),
+                    {
+                        'property': prop,
+                        'namespace': parsed_args.namespace,
+                        'e': e,
+                    },
+                )
+
+        if result > 0:
+            total = len(parsed_args.namespace)
+            msg = _("%(result)s of %(total)s properties failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
+            raise exceptions.CommandError(msg)
 
 
 class ListMetadefProperties(command.Lister):
@@ -151,15 +169,15 @@ class ListMetadefProperties(command.Lister):
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            "namespace_name",
-            metavar="<namespace_name>",
+            "namespace",
+            metavar="<namespace>",
             help=_("An identifier (a name) for the namespace"),
         )
         return parser
 
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
-        props = image_client.metadef_properties(parsed_args.namespace_name)
+        props = image_client.metadef_properties(parsed_args.namespace)
         columns = ['name', 'title', 'type']
         return (
             columns,
@@ -195,11 +213,11 @@ class SetMetadefProperty(command.Command):
             help=_("Valid JSON schema of the property"),
         )
         parser.add_argument(
-            "namespace_name",
+            "namespace",
             help=_("Namespace of the namespace to which the property belongs"),
         )
         parser.add_argument(
-            "property_name",
+            "property",
             help=_("Property to update"),
         )
         return parser
@@ -211,7 +229,8 @@ class SetMetadefProperty(command.Command):
         # update_metadef_property(), otherwise the attributes that are not
         # listed will be reset.
         data = image_client.get_metadef_property(
-            parsed_args.property_name, parsed_args.namespace_name
+            parsed_args.property,
+            parsed_args.namespace,
         )
         kwargs = _format_property(data)
         for key in ['name', 'title', 'type']:
@@ -231,23 +250,25 @@ class SetMetadefProperty(command.Command):
                 )
 
         image_client.update_metadef_property(
-            parsed_args.property_name, parsed_args.namespace_name, **kwargs
+            parsed_args.property,
+            parsed_args.namespace,
+            **kwargs,
         )
 
 
 class ShowMetadefProperty(command.ShowOne):
-    _description = _("Describe a specific property from a namespace")
+    _description = _("Show a particular metadef property")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            "namespace_name",
-            metavar="<namespace_name>",
-            help=_("Namespace (name) for the namespace"),
+            "namespace",
+            metavar="<namespace>",
+            help=_("Metadef namespace of the property (name)"),
         )
         parser.add_argument(
-            "property_name",
-            metavar="<property_name>",
+            "property",
+            metavar="<property>",
             help=_("Property to show"),
         )
         return parser
@@ -255,7 +276,8 @@ class ShowMetadefProperty(command.ShowOne):
     def take_action(self, parsed_args):
         image_client = self.app.client_manager.image
         data = image_client.get_metadef_property(
-            parsed_args.property_name, parsed_args.namespace_name
+            parsed_args.property,
+            parsed_args.namespace,
         )
         info = _format_property(data)
 

openstackclient/network/v2/default_security_group_rule.py

@@ -38,7 +38,12 @@ def _get_columns(item):
 class CreateDefaultSecurityGroupRule(
     command.ShowOne, common.NeutronCommandWithExtraArgs
 ):
-    _description = _("Create a new default security group rule")
+    """Add a new security group rule to the default security group template.
+
+    These rules will be applied to the default security groups created for any
+    new project. They will not be applied to any existing default security
+    groups.
+    """
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -225,7 +230,12 @@ class CreateDefaultSecurityGroupRule(
 
 
 class DeleteDefaultSecurityGroupRule(command.Command):
-    _description = _("Delete default security group rule(s)")
+    """Remove security group rule(s) from the default security group template.
+
+    These rules will not longer be applied to the default security groups
+    created for any new project. They will not be removed from any existing
+    default security groups.
+    """
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -265,7 +275,12 @@ class DeleteDefaultSecurityGroupRule(command.Command):
 
 
 class ListDefaultSecurityGroupRule(command.Lister):
-    _description = _("List default security group rules")
+    """List security group rules used for new default security groups.
+
+    This shows the rules that will be added to any new default security groups
+    created. These rules may differ for the rules present on existing default
+    security groups.
+    """
 
     def _format_network_security_group_rule(self, rule):
         """Transform the SDK DefaultSecurityGroupRule object to a dict
@@ -373,7 +388,11 @@ class ListDefaultSecurityGroupRule(command.Lister):
 
 
 class ShowDefaultSecurityGroupRule(command.ShowOne):
-    _description = _("Display default security group rule details")
+    """Show a security group rule used for new default security groups.
+
+    This shows a rule that will be added to any new default security groups
+    created. This rule may not be present on existing default security groups.
+    """
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)

openstackclient/network/v2/local_ip_association.py

@@ -124,7 +124,7 @@ class DeleteLocalIPAssociation(command.Command):
                         "fixed port "
                         "name or ID '%(fixed_port_id)s': %(e)s"
                     ),
-                    {'fixed port ID': fixed_port_id, 'e': e},
+                    {'fixed_port_id': fixed_port_id, 'e': e},
                 )
 
         if result > 0:

openstackclient/network/v2/ndp_proxy.py

@@ -129,7 +129,7 @@ class DeleteNDPProxy(command.Command):
         if result > 0:
             total = len(parsed_args.ndp_proxy)
             msg = _(
-                "%(result)s of %(total)s NDP Proxy failed " "to delete."
+                "%(result)s of %(total)s NDP proxies failed " "to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -142,12 +142,16 @@ class ListNDPProxy(command.Lister):
         parser.add_argument(
             '--router',
             metavar='<router>',
-            help=_("List only NDP proxies belong to this router (name or ID)"),
+            help=_(
+                "List only NDP proxies belonging to this router (name or ID)"
+            ),
         )
         parser.add_argument(
             '--port',
             metavar='<port>',
-            help=_("List only NDP proxies assocate to this port (name or ID)"),
+            help=_(
+                "List only NDP proxies associated to this port (name or ID)"
+            ),
         )
         parser.add_argument(
             '--ip-address',

openstackclient/network/v2/network.py

@@ -107,7 +107,7 @@ def _get_attrs_network(client_manager, parsed_args):
         attrs['availability_zone_hints'] = parsed_args.availability_zone_hints
 
     # set description
-    if parsed_args.description:
+    if parsed_args.description is not None:
         attrs['description'] = parsed_args.description
 
     # set mtu
@@ -139,7 +139,7 @@ def _get_attrs_network(client_manager, parsed_args):
     if 'no_qos_policy' in parsed_args and parsed_args.no_qos_policy:
         attrs['qos_policy_id'] = None
     # Update DNS network options
-    if parsed_args.dns_domain:
+    if parsed_args.dns_domain is not None:
         attrs['dns_domain'] = parsed_args.dns_domain
     return attrs