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

openstackclient/network/v2/network_trunk.py

@@ -23,10 +23,10 @@ from cliff import columns as cliff_columns
 from osc_lib.cli import format_columns
 from osc_lib.cli import identity as identity_utils
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils as osc_utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
@@ -36,7 +36,7 @@ TRUNKS = 'trunks'
 SUB_PORTS = 'sub_ports'
 
 
-class AdminStateColumn(cliff_columns.FormattableColumn):
+class AdminStateColumn(cliff_columns.FormattableColumn[bool]):
     def human_readable(self):
         return 'UP' if self._value else 'DOWN'
 
@@ -88,9 +88,12 @@ class CreateNetworkTrunk(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.network
-        attrs = _get_attrs_for_trunk(self.app.client_manager, parsed_args)
-        obj = client.create_trunk(**attrs)
+        network_client = self.app.client_manager.network
+        identity_client = self.app.client_manager.identity
+        attrs = _get_attrs_for_trunk(
+            network_client, identity_client, parsed_args
+        )
+        obj = network_client.create_trunk(**attrs)
         display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(
             obj, columns, formatters=_formatters
@@ -112,12 +115,15 @@ class DeleteNetworkTrunk(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.network
+        network_client = self.app.client_manager.network
         result = 0
         for trunk in parsed_args.trunk:
             try:
-                trunk_id = client.find_trunk(trunk).id
-                client.delete_trunk(trunk_id)
+                trunk_id = network_client.find_trunk(
+                    trunk,
+                    ignore_missing=False,
+                ).id
+                network_client.delete_trunk(trunk_id)
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -150,8 +156,8 @@ class ListNetworkTrunk(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.network
-        data = client.trunks()
+        network_client = self.app.client_manager.network
+        data = network_client.trunks()
         headers: tuple[str, ...] = ('ID', 'Name', 'Parent Port', 'Description')
         columns: tuple[str, ...] = ('id', 'name', 'port_id', 'description')
         if parsed_args.long:
@@ -215,11 +221,17 @@ class SetNetworkTrunk(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.network
-        trunk_id = client.find_trunk(parsed_args.trunk)
-        attrs = _get_attrs_for_trunk(self.app.client_manager, parsed_args)
+        network_client = self.app.client_manager.network
+        identity_client = self.app.client_manager.identity
+        trunk_id = network_client.find_trunk(
+            parsed_args.trunk,
+            ignore_missing=False,
+        )
+        attrs = _get_attrs_for_trunk(
+            network_client, identity_client, parsed_args
+        )
         try:
-            client.update_trunk(trunk_id, **attrs)
+            network_client.update_trunk(trunk_id, **attrs)
         except Exception as e:
             msg = _("Failed to set trunk '%(t)s': %(e)s") % {
                 't': parsed_args.trunk,
@@ -228,10 +240,10 @@ class SetNetworkTrunk(command.Command):
             raise exceptions.CommandError(msg)
         if parsed_args.set_subports:
             subport_attrs = _get_attrs_for_subports(
-                self.app.client_manager, parsed_args
+                network_client, parsed_args
             )
             try:
-                client.add_trunk_subports(trunk_id, subport_attrs)
+                network_client.add_trunk_subports(trunk_id, subport_attrs)
             except Exception as e:
                 msg = _("Failed to add subports to trunk '%(t)s': %(e)s") % {
                     't': parsed_args.trunk,
@@ -251,9 +263,12 @@ class ShowNetworkTrunk(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.network
-        trunk_id = client.find_trunk(parsed_args.trunk).id
-        obj = client.get_trunk(trunk_id)
+        network_client = self.app.client_manager.network
+        trunk_id = network_client.find_trunk(
+            parsed_args.trunk,
+            ignore_missing=False,
+        ).id
+        obj = network_client.get_trunk(trunk_id)
         display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(
             obj, columns, formatters=_formatters
@@ -270,14 +285,17 @@ class ListNetworkSubport(command.Lister):
             '--trunk',
             required=True,
             metavar="<trunk>",
-            help=_("List subports belonging to this trunk (name or ID)"),
+            help=_("List only subports belonging to this trunk (name or ID)"),
         )
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.network
-        trunk_id = client.find_trunk(parsed_args.trunk)
-        data = client.get_trunk_subports(trunk_id)
+        network_client = self.app.client_manager.network
+        trunk_id = network_client.find_trunk(
+            parsed_args.trunk,
+            ignore_missing=False,
+        )
+        data = network_client.get_trunk_subports(trunk_id)
         headers: tuple[str, ...] = (
             'Port',
             'Segmentation Type',
@@ -324,10 +342,13 @@ class UnsetNetworkTrunk(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.network
-        attrs = _get_attrs_for_subports(self.app.client_manager, parsed_args)
-        trunk_id = client.find_trunk(parsed_args.trunk)
-        client.delete_trunk_subports(trunk_id, attrs)
+        network_client = self.app.client_manager.network
+        attrs = _get_attrs_for_subports(network_client, parsed_args)
+        trunk_id = network_client.find_trunk(
+            parsed_args.trunk,
+            ignore_missing=False,
+        )
+        network_client.delete_trunk_subports(trunk_id, attrs)
 
 
 _formatters = {
@@ -343,7 +364,7 @@ def _get_columns(item):
     )
 
 
-def _get_attrs_for_trunk(client_manager, parsed_args):
+def _get_attrs_for_trunk(network_client, identity_client, parsed_args):
     attrs: dict[str, ty.Any] = {}
     if parsed_args.name is not None:
         attrs['name'] = str(parsed_args.name)
@@ -354,18 +375,18 @@ def _get_attrs_for_trunk(client_manager, parsed_args):
     if parsed_args.disable:
         attrs['admin_state_up'] = False
     if 'parent_port' in parsed_args and parsed_args.parent_port is not None:
-        port_id = client_manager.network.find_port(parsed_args.parent_port)[
-            'id'
-        ]
+        port_id = network_client.find_port(
+            parsed_args.parent_port,
+            ignore_missing=False,
+        ).id
         attrs['port_id'] = port_id
     if 'add_subports' in parsed_args and parsed_args.add_subports is not None:
         attrs[SUB_PORTS] = _format_subports(
-            client_manager, parsed_args.add_subports
+            network_client, parsed_args.add_subports
         )
 
     # "trunk set" command doesn't support setting project.
     if 'project' in parsed_args and parsed_args.project is not None:
-        identity_client = client_manager.identity
         project_id = identity_utils.find_project(
             identity_client,
             parsed_args.project,
@@ -376,12 +397,15 @@ def _get_attrs_for_trunk(client_manager, parsed_args):
     return attrs
 
 
-def _format_subports(client_manager, subports):
+def _format_subports(network_client, subports):
     attrs = []
     for subport in subports:
         subport_attrs = {}
         if subport.get('port'):
-            port_id = client_manager.network.find_port(subport['port'])['id']
+            port_id = network_client.find_port(
+                subport['port'],
+                ignore_missing=False,
+            ).id
             subport_attrs['port_id'] = port_id
         if subport.get('segmentation-id'):
             try:
@@ -400,21 +424,20 @@ def _format_subports(client_manager, subports):
     return attrs
 
 
-def _get_attrs_for_subports(client_manager, parsed_args):
+def _get_attrs_for_subports(network_client, parsed_args):
     attrs = []
     if 'set_subports' in parsed_args and parsed_args.set_subports is not None:
-        attrs = _format_subports(client_manager, parsed_args.set_subports)
+        attrs = _format_subports(network_client, parsed_args.set_subports)
     if (
         'unset_subports' in parsed_args
         and parsed_args.unset_subports is not None
     ):
         subports_list = []
         for subport in parsed_args.unset_subports:
-            port_id = client_manager.network.find_port(subport)['id']
+            port_id = network_client.find_port(
+                subport,
+                ignore_missing=False,
+            )['id']
             subports_list.append({'port_id': port_id})
         attrs = subports_list
     return attrs
-
-
-def _get_id(client, id_or_name, resource):
-    return client.find_resource(resource, str(id_or_name))['id']

openstackclient/network/v2/port.py

@@ -22,11 +22,11 @@ import typing as ty
 from cliff import columns as cliff_columns
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -34,7 +34,7 @@ from openstackclient.network import common
 LOG = logging.getLogger(__name__)
 
 
-class AdminStateColumn(cliff_columns.FormattableColumn):
+class AdminStateColumn(cliff_columns.FormattableColumn[bool]):
     def human_readable(self):
         return 'UP' if self._value else 'DOWN'
 
@@ -636,11 +636,11 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.network
-        _network = client.find_network(
+        network_client = self.app.client_manager.network
+        network = network_client.find_network(
             parsed_args.network, ignore_missing=False
         )
-        parsed_args.network = _network.id
+        parsed_args.network = network.id
         _prepare_fixed_ips(self.app.client_manager, parsed_args)
         attrs = _get_attrs(self.app.client_manager, parsed_args)
 
@@ -654,7 +654,7 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
 
         if parsed_args.security_groups is not None:
             attrs['security_group_ids'] = [
-                client.find_security_group(sg, ignore_missing=False).id
+                network_client.find_security_group(sg, ignore_missing=False).id
                 for sg in parsed_args.security_groups
             ]
 
@@ -667,7 +667,7 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
             attrs["extra_dhcp_opts"] = _convert_extra_dhcp_options(parsed_args)
 
         if parsed_args.qos_policy:
-            attrs['qos_policy_id'] = client.find_qos_policy(
+            attrs['qos_policy_id'] = network_client.find_qos_policy(
                 parsed_args.qos_policy, ignore_missing=False
             ).id
 
@@ -675,7 +675,9 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
             _validate_port_hints(parsed_args.hint)
             expanded_hints = _expand_port_hint_aliases(parsed_args.hint)
             try:
-                client.find_extension('port-hints', ignore_missing=False)
+                network_client.find_extension(
+                    'port-hints', ignore_missing=False
+                )
             except Exception as e:
                 msg = _('Not supported by Network API: %(e)s') % {'e': e}
                 raise exceptions.CommandError(msg)
@@ -686,7 +688,7 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
                 in expanded_hints['openvswitch']['other_config']
             ):
                 try:
-                    client.find_extension(
+                    network_client.find_extension(
                         'port-hint-ovs-tx-steering', ignore_missing=False
                     )
                 except Exception as e:
@@ -695,7 +697,9 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
             attrs['hints'] = expanded_hints
 
         set_tags_in_post = bool(
-            client.find_extension('tag-ports-during-bulk-creation')
+            network_client.find_extension(
+                'tag-ports-during-bulk-creation', ignore_missing=True
+            )
         )
         if set_tags_in_post:
             if parsed_args.no_tag:
@@ -707,14 +711,12 @@ class CreatePort(command.ShowOne, common.NeutronCommandWithExtraArgs):
             self._parse_extra_properties(parsed_args.extra_properties)
         )
 
-        with common.check_missing_extension_if_error(
-            self.app.client_manager.network, attrs
-        ):
-            obj = client.create_port(**attrs)
+        with common.check_missing_extension_if_error(network_client, attrs):
+            obj = network_client.create_port(**attrs)
 
         if not set_tags_in_post:
             # tags cannot be set when created, so tags need to be set later.
-            _tag.update_tags_for_set(client, obj, parsed_args)
+            _tag.update_tags_for_set(network_client, obj, parsed_args)
 
         display_columns, columns = _get_columns(obj)
         data = utils.get_item_properties(obj, columns, formatters=_formatters)
@@ -808,7 +810,7 @@ class ListPort(command.Lister):
         parser.add_argument(
             '--mac-address',
             metavar='<mac-address>',
-            help=_("List only ports with this MAC address"),
+            help=_("List only ports with the specified MAC address"),
         )
         parser.add_argument(
             '--long',
@@ -819,12 +821,12 @@ class ListPort(command.Lister):
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=_("List ports according to their project (name or ID)"),
+            help=_("List only ports with the specified project (name or ID)"),
         )
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List ports according to their name"),
+            help=_("List only ports with the specified name"),
         )
         parser.add_argument(
             '--security-group',
@@ -842,7 +844,7 @@ class ListPort(command.Lister):
             metavar='<status>',
             choices=('ACTIVE', 'BUILD', 'DOWN', 'ERROR'),
             help=_(
-                "List ports according to their status "
+                "List only ports with the specified status "
                 "('ACTIVE', 'BUILD', 'DOWN', 'ERROR')"
             ),
         )
@@ -859,7 +861,7 @@ class ListPort(command.Lister):
                 "Desired IP and/or subnet for filtering ports "
                 "(name or ID): subnet=<subnet>,ip-address=<ip-address>,"
                 "ip-substring=<ip-substring> "
-                "(repeat option to set multiple fixed IP addresses)"
+                "(repeat option to filter multiple fixed IP addresses)"
             ),
         )
         _tag.add_tag_filtering_option_to_parser(parser, _('ports'))

openstackclient/network/v2/router.py

@@ -23,11 +23,11 @@ import typing as ty
 from cliff import columns as cliff_columns
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -35,12 +35,12 @@ from openstackclient.network import common
 LOG = logging.getLogger(__name__)
 
 
-class AdminStateColumn(cliff_columns.FormattableColumn):
+class AdminStateColumn(cliff_columns.FormattableColumn[bool]):
     def human_readable(self):
         return 'UP' if self._value else 'DOWN'
 
 
-class RouterInfoColumn(cliff_columns.FormattableColumn):
+class RouterInfoColumn(cliff_columns.FormattableColumn[ty.Any]):
     def human_readable(self):
         try:
             return json.dumps(self._value)
@@ -48,7 +48,7 @@ class RouterInfoColumn(cliff_columns.FormattableColumn):
             return ''
 
 
-class RoutesColumn(cliff_columns.FormattableColumn):
+class RoutesColumn(cliff_columns.FormattableColumn[ty.Any]):
     def human_readable(self):
         # Map the route keys to match --route option.
         for route in self._value or []:
@@ -89,7 +89,12 @@ def _get_columns(item):
 
 
 def is_multiple_gateways_supported(n_client):
-    return n_client.find_extension("external-gateway-multihoming") is not None
+    return (
+        n_client.find_extension(
+            "external-gateway-multihoming", ignore_missing=True
+        )
+        is not None
+    )
 
 
 def _passed_multiple_gateways(extension_supported, external_gateways):
@@ -236,7 +241,9 @@ def _get_attrs(client_manager, parsed_args):
 
     # "router set" command doesn't support setting flavor_id.
     if 'flavor_id' in parsed_args and parsed_args.flavor_id is not None:
-        flavor = n_client.find_flavor(parsed_args.flavor_id)
+        flavor = n_client.find_flavor(
+            parsed_args.flavor_id, ignore_missing=False
+        )
         attrs['flavor_id'] = flavor.id
     elif 'flavor' in parsed_args and parsed_args.flavor is not None:
         flavor = n_client.find_flavor(parsed_args.flavor, ignore_missing=False)
@@ -719,13 +726,17 @@ class ListRouter(command.Lister):
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=_("List routers according to their project (name or ID)"),
+            help=_(
+                "List only routers with the specified project (name or ID)"
+            ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
         parser.add_argument(
             '--agent',
             metavar='<agent-id>',
-            help=_("List routers hosted by an agent (ID only)"),
+            help=_(
+                "List only routers hosted by the specified agent (ID only)"
+            ),
         )
         _tag.add_tag_filtering_option_to_parser(parser, _('routers'))
 

openstackclient/network/v2/security_group.py

@@ -14,13 +14,14 @@
 """Security Group action implementations"""
 
 import argparse
+import typing as ty
 
 from cliff import columns as cliff_columns
-from osc_lib.command import command
 from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
 from openstackclient.api import compute_v2
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -65,12 +66,12 @@ def _format_compute_security_group_rules(sg_rules):
     return utils.format_list(rules, separator='\n')
 
 
-class NetworkSecurityGroupRulesColumn(cliff_columns.FormattableColumn):
+class NetworkSecurityGroupRulesColumn(cliff_columns.FormattableColumn[ty.Any]):
     def human_readable(self):
         return _format_network_security_group_rules(self._value)
 
 
-class ComputeSecurityGroupRulesColumn(cliff_columns.FormattableColumn):
+class ComputeSecurityGroupRulesColumn(cliff_columns.FormattableColumn[ty.Any]):
     def human_readable(self):
         return _format_compute_security_group_rules(self._value)
 
@@ -246,7 +247,10 @@ class ListSecurityGroup(common.NetworkAndComputeLister):
             '--project',
             metavar='<project>',
             help=self.enhance_help_neutron(
-                _("List security groups according to the project (name or ID)")
+                _(
+                    "List only security groups with the specified project "
+                    "(name or ID)"
+                )
             ),
         )
         identity_common.add_project_domain_option_to_parser(
@@ -259,14 +263,14 @@ class ListSecurityGroup(common.NetworkAndComputeLister):
             action='store_true',
             dest='shared',
             default=None,
-            help=_("List security groups shared between projects"),
+            help=_("List only security groups shared between projects"),
         )
         shared_group.add_argument(
             '--no-share',
             action='store_false',
             dest='shared',
             default=None,
-            help=_("List security groups not shared between projects"),
+            help=_("List only security groups not shared between projects"),
         )
 
         _tag.add_tag_filtering_option_to_parser(

openstackclient/network/v2/security_group_rule.py

@@ -387,7 +387,8 @@ class ListSecurityGroupRule(common.NetworkAndComputeLister):
             type=network_utils.convert_to_lowercase,
             help=self.enhance_help_neutron(
                 _(
-                    "List rules by the IP protocol (ah, dhcp, egp, esp, gre, "
+                    "List only rules with the specified IP protocol "
+                    "(ah, dhcp, egp, esp, gre, "
                     "icmp, igmp, ipv6-encap, ipv6-frag, ipv6-icmp, "
                     "ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, "
                     "sctp, tcp, udp, udplite, vrrp and integer "
@@ -401,7 +402,10 @@ class ListSecurityGroupRule(common.NetworkAndComputeLister):
             metavar='<ethertype>',
             type=network_utils.convert_to_lowercase,
             help=self.enhance_help_neutron(
-                _("List rules by the Ethertype (IPv4 or IPv6)")
+                _(
+                    "List only rules with the specified Ethertype "
+                    "(IPv4 or IPv6)"
+                )
             ),
         )
         direction_group = parser.add_mutually_exclusive_group()
@@ -409,14 +413,14 @@ class ListSecurityGroupRule(common.NetworkAndComputeLister):
             '--ingress',
             action='store_true',
             help=self.enhance_help_neutron(
-                _("List rules applied to incoming network traffic")
+                _("List only rules applied to incoming network traffic")
             ),
         )
         direction_group.add_argument(
             '--egress',
             action='store_true',
             help=self.enhance_help_neutron(
-                _("List rules applied to outgoing network traffic")
+                _("List only rules applied to outgoing network traffic")
             ),
         )
         parser.add_argument(
@@ -430,7 +434,9 @@ class ListSecurityGroupRule(common.NetworkAndComputeLister):
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=self.enhance_help_neutron(_("Owner's project (name or ID)")),
+            help=self.enhance_help_neutron(
+                _("List only rules with the specified project (name or ID)")
+            ),
         )
         identity_common.add_project_domain_option_to_parser(
             parser, enhance_help=self.enhance_help_neutron