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

openstackclient/network/common.py

@@ -12,17 +12,16 @@
 #
 
 import abc
-import argparse
 import contextlib
 import logging
 import typing as ty
 
-import cliff.app
+from cliff import _argparse
 import openstack.exceptions
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.network import utils
 
@@ -68,8 +67,6 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
     present the options for both network types, often qualified accordingly.
     """
 
-    app: cliff.app.App
-
     @property
     def _network_type(self):
         """Discover whether the running cloud is using neutron or nova-network.
@@ -84,7 +81,7 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
         # Have we set it up yet for this command?
         if not hasattr(self, '_net_type'):
             try:
-                if self.app.client_manager.is_network_endpoint_enabled():
+                if self.app.client_manager.is_network_endpoint_enabled():  # type: ignore
                     net_type = _NET_TYPE_NEUTRON
                 else:
                     net_type = _NET_TYPE_COMPUTE
@@ -136,7 +133,7 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
             )
         )
 
-    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+    def get_parser(self, prog_name: str) -> _argparse.ArgumentParser:
         LOG.debug('get_parser(%s)', prog_name)
         parser = super().get_parser(prog_name)  # type: ignore
         parser = self.update_parser_common(parser)
@@ -163,11 +160,13 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
     def take_action(self, parsed_args):
         if self.is_neutron:
             return self.take_action_network(
-                self.app.client_manager.network, parsed_args
+                self.app.client_manager.network,  # type: ignore
+                parsed_args,
             )
         elif self.is_nova_network:
             return self.take_action_compute(
-                self.app.client_manager.compute, parsed_args
+                self.app.client_manager.compute,  # type: ignore
+                parsed_args,
             )
 
     def take_action_network(self, client, parsed_args):
@@ -203,6 +202,8 @@ class NetworkAndComputeDelete(NetworkAndComputeCommand, metaclass=abc.ABCMeta):
     following the rules in doc/source/command-errors.rst.
     """
 
+    resource: str
+
     def take_action(self, parsed_args):
         ret = 0
         resources = getattr(parsed_args, self.resource, [])

openstackclient/network/v2/address_group.py

@@ -16,10 +16,10 @@
 import logging
 
 import netaddr
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -151,13 +151,14 @@ class ListAddressGroup(command.Lister):
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only address groups of given name in output"),
+            help=_("List only address groups with the specified name"),
         )
         parser.add_argument(
             '--project',
             metavar="<project>",
             help=_(
-                "List address groups according to their project (name or ID)"
+                "List only address groups with the specified project "
+                "(name or ID)"
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)

openstackclient/network/v2/address_scope.py

@@ -15,10 +15,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -160,7 +160,7 @@ class ListAddressScope(command.Lister):
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only address scopes of given name in output"),
+            help=_("List only address scopes with the specified name"),
         )
         parser.add_argument(
             '--ip-version',
@@ -169,14 +169,16 @@ class ListAddressScope(command.Lister):
             metavar='<ip-version>',
             dest='ip_version',
             help=_(
-                "List address scopes of given IP version networks (4 or 6)"
+                "List only address scopes with the specified IP version "
+                "networks (4 or 6)"
             ),
         )
         parser.add_argument(
             '--project',
             metavar="<project>",
             help=_(
-                "List address scopes according to their project (name or ID)"
+                "List only address scopes with the specified project "
+                "(name or ID)"
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
@@ -185,12 +187,12 @@ class ListAddressScope(command.Lister):
         shared_group.add_argument(
             '--share',
             action='store_true',
-            help=_("List address scopes shared between projects"),
+            help=_("List only address scopes shared between projects"),
         )
         shared_group.add_argument(
             '--no-share',
             action='store_true',
-            help=_("List address scopes not shared between projects"),
+            help=_("List only address scopes not shared between projects"),
         )
         return parser
 

openstackclient/network/v2/default_security_group_rule.py

@@ -16,10 +16,10 @@
 import logging
 
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.network import common
 from openstackclient.network import utils as network_utils
@@ -150,7 +150,7 @@ class CreateDefaultSecurityGroupRule(
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.sdk_connection.network
+        client = self.app.client_manager.network
         # Build the create attributes.
         attrs = {}
         attrs['protocol'] = network_utils.get_protocol(parsed_args)
@@ -248,7 +248,7 @@ class DeleteDefaultSecurityGroupRule(command.Command):
 
     def take_action(self, parsed_args):
         result = 0
-        client = self.app.client_manager.sdk_connection.network
+        client = self.app.client_manager.network
         for r in parsed_args.rule:
             try:
                 obj = client.find_default_security_group_rule(
@@ -300,7 +300,8 @@ class ListDefaultSecurityGroupRule(command.Lister):
             metavar='<protocol>',
             type=network_utils.convert_to_lowercase,
             help=_(
-                "List rules by the IP protocol (ah, dhcp, egp, esp, gre, "
+                "List only default 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 "
@@ -319,7 +320,7 @@ class ListDefaultSecurityGroupRule(command.Lister):
             '--ingress',
             action='store_true',
             help=_(
-                "List default rules which will be applied to incoming "
+                "List only default rules which will be applied to incoming "
                 "network traffic"
             ),
         )
@@ -327,14 +328,14 @@ class ListDefaultSecurityGroupRule(command.Lister):
             '--egress',
             action='store_true',
             help=_(
-                "List default rules which will be applied to outgoing "
+                "List only default rules which will be applied to outgoing "
                 "network traffic"
             ),
         )
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.sdk_connection.network
+        client = self.app.client_manager.network
         column_headers = (
             'ID',
             'IP Protocol',
@@ -403,7 +404,7 @@ class ShowDefaultSecurityGroupRule(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        client = self.app.client_manager.sdk_connection.network
+        client = self.app.client_manager.network
         obj = client.find_default_security_group_rule(
             parsed_args.rule, ignore_missing=False
         )

openstackclient/network/v2/floating_ip.py

@@ -247,7 +247,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             action='append',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given network "
+                    "List only floating IP(s) with the specified network "
                     "(name or ID) "
                     "(repeat option to fiter on multiple networks)"
                 )
@@ -260,7 +260,8 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             action='append',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given port (name or ID) "
+                    "List only floating IP(s) with the specified port "
+                    "(name or ID) "
                     "(repeat option to fiter on multiple ports)"
                 )
             ),
@@ -269,14 +270,20 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             '--fixed-ip-address',
             metavar='<ip-address>',
             help=self.enhance_help_neutron(
-                _("List floating IP(s) according to given fixed IP address")
+                _(
+                    "List only floating IP(s) with the specified fixed IP "
+                    "address"
+                )
             ),
         )
         parser.add_argument(
             '--floating-ip-address',
             metavar='<ip-address>',
             help=self.enhance_help_neutron(
-                _("List floating IP(s) according to given floating IP address")
+                _(
+                    "List only floating IP(s) with the specified floating IP "
+                    "address"
+                )
             ),
         )
         parser.add_argument(
@@ -285,8 +292,8 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             choices=['ACTIVE', 'DOWN'],
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given status ('ACTIVE', "
-                    "'DOWN')"
+                    "List only floating IP(s) with the specified status "
+                    "('ACTIVE', 'DOWN')"
                 )
             ),
         )
@@ -295,8 +302,8 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             metavar='<project>',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given project "
-                    "(name or ID) "
+                    "List only floating IP(s) with the specified project "
+                    "(name or ID)"
                 )
             ),
         )
@@ -308,7 +315,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             action='append',
             help=self.enhance_help_neutron(
                 _(
-                    "List floating IP(s) according to given router "
+                    "List only floating IP(s) with the specified router "
                     "(name or ID) "
                     "(repeat option to fiter on multiple routers)"
                 )

openstackclient/network/v2/floating_ip_port_forwarding.py

@@ -16,10 +16,10 @@
 import logging
 import typing as ty
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.network import common
 
@@ -265,8 +265,8 @@ class ListFloatingIPPortForwarding(command.Lister):
             '--port',
             metavar='<port>',
             help=_(
-                "Filter the list result by the ID or name of "
-                "the internal network port"
+                "List only floating IP port forwardings with the "
+                "specified internal network port (name or ID)"
             ),
         )
         parser.add_argument(
@@ -274,14 +274,17 @@ class ListFloatingIPPortForwarding(command.Lister):
             metavar='<port-number>',
             dest='external_protocol_port',
             help=_(
-                "Filter the list result by the "
-                "protocol port number of the floating IP"
+                "List only floating IP port forwardings with the "
+                "specified external protocol port number"
             ),
         )
         parser.add_argument(
             '--protocol',
             metavar='<protocol>',
-            help=_("Filter the list result by the port protocol"),
+            help=_(
+                "List only floating IP port forwardings with the "
+                "specified protocol number"
+            ),
         )
 
         return parser

openstackclient/network/v2/ip_availability.py

@@ -14,9 +14,9 @@
 """IP Availability Info implementations"""
 
 from osc_lib.cli import format_columns
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -47,14 +47,17 @@ class ListIPAvailability(command.Lister):
             metavar='<ip-version>',
             dest='ip_version',
             help=_(
-                "List IP availability of given IP version "
-                "networks (default is 4)"
+                "List only IP availability with the specified IP version "
+                "networks (4 or 6, default is 4)"
             ),
         )
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=_("List IP availability of given project (name or ID)"),
+            help=_(
+                "List only IP availability with the specified project "
+                "(name or ID)"
+            ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
         return parser

openstackclient/network/v2/l3_conntrack_helper.py

@@ -15,10 +15,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
@@ -150,19 +150,26 @@ class ListConntrackHelper(command.Lister):
         parser.add_argument(
             '--helper',
             metavar='<helper>',
-            help=_('The netfilter conntrack helper module'),
+            help=_(
+                'List only helpers using the specified netfilter conntrack '
+                'helper module'
+            ),
         )
         parser.add_argument(
             '--protocol',
             metavar='<protocol>',
             help=_(
-                'The network protocol for the netfilter conntrack target rule'
+                'List only helpers with the specified network protocol for '
+                'the netfilter conntrack target rule'
             ),
         )
         parser.add_argument(
             '--port',
             metavar='<port>',
-            help=_('The network port for the netfilter conntrack target rule'),
+            help=_(
+                'List only helpers with the specified network port for '
+                'the netfilter conntrack target rule (name or ID)'
+            ),
         )
 
         return parser

openstackclient/network/v2/local_ip.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -198,32 +198,38 @@ class ListLocalIP(command.Lister):
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only Local IPs of given name in output"),
+            help=_("List only local IP(s) with the specified name"),
         )
         parser.add_argument(
             '--project',
             metavar="<project>",
-            help=_("List Local IPs according to their project (name or ID)"),
+            help=_(
+                "List only local IP(s) with the specified project (name or ID)"
+            ),
         )
         parser.add_argument(
             '--network',
             metavar='<network>',
-            help=_("List Local IP(s) according to given network (name or ID)"),
+            help=_(
+                "List only local IP(s) with the specified network (name or ID)"
+            ),
         )
         parser.add_argument(
             '--local-port',
             metavar='<local-port>',
-            help=_("List Local IP(s) according to given port (name or ID)"),
+            help=_(
+                "List only local IP(s) with the specified port (name or ID)"
+            ),
         )
         parser.add_argument(
             '--local-ip-address',
             metavar='<local-ip-address>',
-            help=_("List Local IP(s) according to given Local IP Address"),
+            help=_("List only local IP(s) with the specified IP address"),
         )
         parser.add_argument(
             '--ip-mode',
             metavar='<ip_mode>',
-            help=_("List Local IP(s) according to given IP mode"),
+            help=_("List only local IP(s) with the specified IP mode"),
         )
 
         identity_common.add_project_domain_option_to_parser(parser)

openstackclient/network/v2/local_ip_association.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -150,18 +150,21 @@ class ListLocalIPAssociation(command.Lister):
             '--fixed-port',
             metavar='<fixed-port>',
             help=_(
-                "Filter the list result by the ID or name of the fixed port"
+                "List only local IP assocations with the specified fixed IP "
+                "port (name or ID)"
             ),
         )
         parser.add_argument(
             '--fixed-ip',
             metavar='<fixed-ip>',
-            help=_("Filter the list result by fixed ip"),
+            help=_(
+                "List only local IP associations with the specified fixed IP"
+            ),
         )
         parser.add_argument(
             '--host',
             metavar='<host>',
-            help=_("Filter the list result by given host"),
+            help=_("List only local IP associations with the specified host"),
         )
         identity_common.add_project_domain_option_to_parser(parser)
 

openstackclient/network/v2/ndp_proxy.py

@@ -17,10 +17,10 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -143,30 +143,37 @@ class ListNDPProxy(command.Lister):
             '--router',
             metavar='<router>',
             help=_(
-                "List only NDP proxies belonging to this router (name or ID)"
+                "List only NDP proxies associated with the specifed router "
+                "(name or ID)"
             ),
         )
         parser.add_argument(
             '--port',
             metavar='<port>',
             help=_(
-                "List only NDP proxies associated to this port (name or ID)"
+                "List only NDP proxies associated with the specified port "
+                "(name or ID)"
             ),
         )
         parser.add_argument(
             '--ip-address',
             metavar='<ip-address>',
-            help=_("List only NDP proxies associated to this IPv6 address"),
+            help=_(
+                "List only NDP proxies associated with the specified "
+                "IPv6 address"
+            ),
         )
         parser.add_argument(
             '--project',
             metavar='<project>',
-            help=_("List only NDP proxies of given project (name or ID)"),
+            help=_(
+                "List only NDP proxies with the specified project (name or ID)"
+            ),
         )
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only NDP proxies of given name"),
+            help=_("List only NDP proxies with the specified name"),
         )
 
         identity_common.add_project_domain_option_to_parser(parser)