python-openstackclient 7.3.1__py3-none-any.whl → 8.0.0__py3-none-any.whl

openstackclient/network/client.py

@@ -9,7 +9,6 @@
 #   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #   License for the specific language governing permissions and limitations
 #   under the License.
-#
 
 import logging
 
@@ -17,16 +16,13 @@ from osc_lib import utils
 
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
+# global variables used when building the shell
 DEFAULT_API_VERSION = '2.0'
 API_VERSION_OPTION = 'os_network_api_version'
-API_NAME = "network"
-API_VERSIONS = {
-    "2.0": "openstack.connection.Connection",
-    "2": "openstack.connection.Connection",
-}
+API_NAME = 'network'
+API_VERSIONS = ('2.0', '2')
 
 
 def make_client(instance):
@@ -50,9 +46,7 @@ def build_option_parser(parser):
         '--os-network-api-version',
         metavar='<network-api-version>',
         default=utils.env('OS_NETWORK_API_VERSION'),
-        help=_(
-            "Network API version, default=%s " "(Env: OS_NETWORK_API_VERSION)"
-        )
+        help=_("Network API version, default=%s (Env: OS_NETWORK_API_VERSION)")
         % DEFAULT_API_VERSION,
     )
     return parser

openstackclient/network/common.py

@@ -12,9 +12,12 @@
 #
 
 import abc
+import argparse
 import contextlib
 import logging
+import typing as ty
 
+import cliff.app
 import openstack.exceptions
 from osc_lib.cli import parseractions
 from osc_lib.command import command
@@ -65,6 +68,8 @@ 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.
@@ -131,9 +136,9 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
             )
         )
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         LOG.debug('get_parser(%s)', prog_name)
-        parser = super().get_parser(prog_name)
+        parser = super().get_parser(prog_name)  # type: ignore
         parser = self.update_parser_common(parser)
         LOG.debug('common parser: %s', parser)
         if self.is_neutron or self.is_docs_build:
@@ -162,7 +167,7 @@ class NetDetectionMixin(metaclass=abc.ABCMeta):
             )
         elif self.is_nova_network:
             return self.take_action_compute(
-                self.app.client_manager.sdk_connection.compute, parsed_args
+                self.app.client_manager.compute, parsed_args
             )
 
     def take_action_network(self, client, parsed_args):
@@ -211,7 +216,7 @@ class NetworkAndComputeDelete(NetworkAndComputeCommand, metaclass=abc.ABCMeta):
                     )
                 else:
                     self.take_action_compute(
-                        self.app.client_manager.sdk_connection.compute,
+                        self.app.client_manager.compute,
                         parsed_args,
                     )
             except Exception as e:
@@ -269,7 +274,7 @@ class NetworkAndComputeShowOne(
                 )
             else:
                 return self.take_action_compute(
-                    self.app.client_manager.sdk_connection.compute, parsed_args
+                    self.app.client_manager.compute, parsed_args
                 )
         except openstack.exceptions.HttpException as exc:
             msg = _("Error while executing command: %s") % exc.message
@@ -295,16 +300,15 @@ class NeutronCommandWithExtraArgs(command.Command):
     }
 
     def _get_property_converter(self, _property):
-        if 'type' not in _property:
-            converter = str
-        else:
+        if 'type' in _property:
             converter = self._allowed_types_dict.get(_property['type'])
+        else:
+            converter = str
 
         if not converter:
             raise exceptions.CommandError(
                 _(
-                    "Type {property_type} of property {name} "
-                    "is not supported"
+                    "Type {property_type} of property {name} is not supported"
                 ).format(
                     property_type=_property['type'], name=_property['name']
                 )
@@ -312,7 +316,7 @@ class NeutronCommandWithExtraArgs(command.Command):
         return converter
 
     def _parse_extra_properties(self, extra_properties):
-        result = {}
+        result: dict[str, ty.Any] = {}
         if extra_properties:
             for _property in extra_properties:
                 converter = self._get_property_converter(_property)
@@ -345,7 +349,7 @@ class NeutronCommandWithExtraArgs(command.Command):
 
 class NeutronUnsetCommandWithExtraArgs(NeutronCommandWithExtraArgs):
     def _parse_extra_properties(self, extra_properties):
-        result = {}
+        result: dict[str, ty.Any] = {}
         if extra_properties:
             for _property in extra_properties:
                 result[_property['name']] = None

openstackclient/network/utils.py

@@ -23,7 +23,7 @@ def transform_compute_security_group_rule(sg_rule):
     from_port = info.pop('from_port')
     to_port = info.pop('to_port')
     if isinstance(from_port, int) and isinstance(to_port, int):
-        port_range = {'port_range': "%u:%u" % (from_port, to_port)}
+        port_range = {'port_range': f"{from_port}:{to_port}"}
     elif from_port is None and to_port is None:
         port_range = {'port_range': ""}
     else:
@@ -58,12 +58,12 @@ def str2list(strlist):
     return result
 
 
-def str2dict(strdict):
+def str2dict(strdict: str) -> dict[str, str]:
     """Convert key1:value1;key2:value2;... string into dictionary.
 
     :param strdict: string in the form of key1:value1;key2:value2
     """
-    result = {}
+    result: dict[str, str] = {}
     if not strdict:
         return result
     i = 0

openstackclient/network/v2/address_group.py

@@ -28,10 +28,9 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -76,8 +75,7 @@ class CreateAddressGroup(command.ShowOne, common.NeutronCommandWithExtraArgs):
             action='append',
             default=[],
             help=_(
-                "IP address or CIDR "
-                "(repeat option to set multiple addresses)"
+                "IP address or CIDR (repeat option to set multiple addresses)"
             ),
         )
         parser.add_argument(
@@ -139,7 +137,7 @@ class DeleteAddressGroup(command.Command):
         if result > 0:
             total = len(parsed_args.address_group)
             msg = _(
-                "%(result)s of %(total)s address groups failed " "to delete."
+                "%(result)s of %(total)s address groups failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -159,8 +157,7 @@ class ListAddressGroup(command.Lister):
             '--project',
             metavar="<project>",
             help=_(
-                "List address groups according to their project "
-                "(name or ID)"
+                "List address groups according to their project (name or ID)"
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)
@@ -233,8 +230,7 @@ class SetAddressGroup(common.NeutronCommandWithExtraArgs):
             action='append',
             default=[],
             help=_(
-                "IP address or CIDR "
-                "(repeat option to set multiple addresses)"
+                "IP address or CIDR (repeat option to set multiple addresses)"
             ),
         )
         return parser

openstackclient/network/v2/address_scope.py

@@ -144,7 +144,7 @@ class DeleteAddressScope(command.Command):
         if result > 0:
             total = len(parsed_args.address_scope)
             msg = _(
-                "%(result)s of %(total)s address scopes failed " "to delete."
+                "%(result)s of %(total)s address scopes failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -176,8 +176,7 @@ class ListAddressScope(command.Lister):
             '--project',
             metavar="<project>",
             help=_(
-                "List address scopes according to their project "
-                "(name or ID)"
+                "List address scopes according to their project (name or ID)"
             ),
         )
         identity_common.add_project_domain_option_to_parser(parser)

openstackclient/network/v2/default_security_group_rule.py

@@ -28,10 +28,9 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['location', 'name', 'revision_number']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 

openstackclient/network/v2/floating_ip.py

@@ -13,6 +13,7 @@
 """IP Floating action implementations"""
 
 from openstack import exceptions as sdk_exceptions
+from osc_lib.cli import format_columns
 from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
@@ -22,15 +23,14 @@ from openstackclient.identity import common as identity_common
 from openstackclient.network import common
 
 _formatters = {
-    'port_details': utils.format_dict,
+    'port_details': format_columns.DictColumn,
 }
 
 
 def _get_network_columns(item):
-    column_map = {}
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -123,7 +123,7 @@ class CreateFloatingIP(
             '--port',
             metavar='<port>',
             help=self.enhance_help_neutron(
-                _("Port to be associated with the floating IP " "(name or ID)")
+                _("Port to be associated with the floating IP (name or ID)")
             ),
         )
         parser.add_argument(
@@ -268,10 +268,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             '--floating-ip-address',
             metavar='<ip-address>',
             help=self.enhance_help_neutron(
-                _(
-                    "List floating IP(s) according to given floating IP "
-                    "address"
-                )
+                _("List floating IP(s) according to given floating IP address")
             ),
         )
         parser.add_argument(
@@ -308,10 +305,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             '--router',
             metavar='<router>',
             help=self.enhance_help_neutron(
-                _(
-                    "List floating IP(s) according to given router (name or "
-                    "ID)"
-                )
+                _("List floating IP(s) according to given router (name or ID)")
             ),
         )
         _tag.add_tag_filtering_option_to_parser(
@@ -324,7 +318,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
         network_client = self.app.client_manager.network
         identity_client = self.app.client_manager.identity
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'floating_ip_address',
             'fixed_ip_address',
@@ -332,7 +326,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             'floating_network_id',
             'project_id',
         )
-        headers = (
+        headers: tuple[str, ...] = (
             'ID',
             'Floating IP Address',
             'Fixed IP Address',
@@ -341,7 +335,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
             'Project',
         )
         if parsed_args.long:
-            columns = columns + (
+            columns += (
                 'router_id',
                 'status',
                 'description',
@@ -349,7 +343,7 @@ class ListFloatingIP(common.NetworkAndComputeLister):
                 'dns_name',
                 'dns_domain',
             )
-            headers = headers + (
+            headers += (
                 'Router',
                 'Status',
                 'Description',
@@ -409,14 +403,14 @@ class ListFloatingIP(common.NetworkAndComputeLister):
         )
 
     def take_action_compute(self, client, parsed_args):
-        columns = (
+        columns: tuple[str, ...] = (
             'ID',
             'IP',
             'Fixed IP',
             'Instance ID',
             'Pool',
         )
-        headers = (
+        headers: tuple[str, ...] = (
             'ID',
             'Floating IP Address',
             'Fixed IP Address',
@@ -458,8 +452,7 @@ class SetFloatingIP(common.NeutronCommandWithExtraArgs):
             metavar='<ip-address>',
             dest='fixed_ip_address',
             help=_(
-                "Fixed IP of the port "
-                "(required only if port has multiple IPs)"
+                "Fixed IP of the port (required only if port has multiple IPs)"
             ),
         )
         parser.add_argument(
@@ -578,7 +571,7 @@ class UnsetFloatingIP(common.NeutronCommandWithExtraArgs):
             parsed_args.floating_ip,
             ignore_missing=False,
         )
-        attrs = {}
+        attrs: dict[str, None] = {}
         if parsed_args.port:
             attrs['port_id'] = None
         if parsed_args.qos_policy:

openstackclient/network/v2/floating_ip_port_forwarding.py

@@ -14,6 +14,7 @@
 """Floating IP Port Forwarding action implementations"""
 
 import logging
+import typing as ty
 
 from osc_lib.command import command
 from osc_lib import exceptions
@@ -85,10 +86,9 @@ def validate_port(port):
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -149,7 +149,7 @@ class CreateFloatingIPPortForwarding(
             '--description',
             metavar='<description>',
             help=_(
-                "A text to describe/contextualize the use of the "
+                "Text to describe/contextualize the use of the "
                 "port forwarding configuration"
             ),
         )
@@ -165,7 +165,7 @@ class CreateFloatingIPPortForwarding(
         return parser
 
     def take_action(self, parsed_args):
-        attrs = {}
+        attrs: dict[str, ty.Any] = {}
         client = self.app.client_manager.network
         floating_ip = client.find_ip(
             parsed_args.floating_ip,
@@ -243,7 +243,7 @@ class DeleteFloatingIPPortForwarding(command.Command):
         if result > 0:
             total = len(parsed_args.port_forwarding_id)
             msg = _(
-                "%(result)s of %(total)s Port forwarding failed " "to delete."
+                "%(result)s of %(total)s Port forwarding failed to delete."
             ) % {'result': result, 'total': total}
             raise exceptions.CommandError(msg)
 
@@ -280,7 +280,7 @@ class ListFloatingIPPortForwarding(command.Lister):
         )
         parser.add_argument(
             '--protocol',
-            metavar='protocol',
+            metavar='<protocol>',
             help=_("Filter the list result by the port protocol"),
         )
 
@@ -409,7 +409,7 @@ class SetFloatingIPPortForwarding(common.NeutronCommandWithExtraArgs):
             '--description',
             metavar='<description>',
             help=_(
-                "A text to describe/contextualize the use of "
+                "Text to describe/contextualize the use of "
                 "the port forwarding configuration"
             ),
         )

openstackclient/network/v2/ip_availability.py

@@ -26,10 +26,9 @@ _formatters = {
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['id', 'name', 'location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 

openstackclient/network/v2/l3_conntrack_helper.py

@@ -25,10 +25,9 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -66,8 +65,7 @@ class CreateConntrackHelper(command.ShowOne):
             required=True,
             metavar='<protocol>',
             help=_(
-                'The network protocol for the netfilter conntrack target '
-                'rule'
+                'The network protocol for the netfilter conntrack target rule'
             ),
         )
         parser.add_argument(
@@ -99,7 +97,7 @@ class DeleteConntrackHelper(command.Command):
         parser.add_argument(
             'router',
             metavar='<router>',
-            help=_('Router that the conntrack helper belong to'),
+            help=_('Router that the conntrack helper belongs to'),
         )
         parser.add_argument(
             'conntrack_helper_id',
@@ -147,7 +145,7 @@ class ListConntrackHelper(command.Lister):
         parser.add_argument(
             'router',
             metavar='<router>',
-            help=_('Router that the conntrack helper belong to'),
+            help=_('Router that the conntrack helper belongs to'),
         )
         parser.add_argument(
             '--helper',
@@ -158,8 +156,7 @@ class ListConntrackHelper(command.Lister):
             '--protocol',
             metavar='<protocol>',
             help=_(
-                'The network protocol for the netfilter conntrack target '
-                'rule'
+                'The network protocol for the netfilter conntrack target rule'
             ),
         )
         parser.add_argument(
@@ -210,7 +207,7 @@ class SetConntrackHelper(command.Command):
         parser.add_argument(
             'router',
             metavar='<router>',
-            help=_('Router that the conntrack helper belong to'),
+            help=_('Router that the conntrack helper belongs to'),
         )
         parser.add_argument(
             'conntrack_helper_id',
@@ -226,8 +223,7 @@ class SetConntrackHelper(command.Command):
             '--protocol',
             metavar='<protocol>',
             help=_(
-                'The network protocol for the netfilter conntrack target '
-                'rule'
+                'The network protocol for the netfilter conntrack target rule'
             ),
         )
         parser.add_argument(
@@ -257,7 +253,7 @@ class ShowConntrackHelper(command.ShowOne):
         parser.add_argument(
             'router',
             metavar='<router>',
-            help=_('Router that the conntrack helper belong to'),
+            help=_('Router that the conntrack helper belongs to'),
         )
         parser.add_argument(
             'conntrack_helper_id',

openstackclient/network/v2/local_ip.py

@@ -28,10 +28,9 @@ LOG = logging.getLogger(__name__)
 
 
 def _get_columns(item):
-    column_map = {}
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -74,30 +73,32 @@ class CreateLocalIP(command.ShowOne):
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
         parser.add_argument(
-            '--name', metavar="<name>", help=_("New local IP name")
+            '--name', metavar="<name>", help=_("New Local IP name")
         )
         parser.add_argument(
             '--description',
             metavar="<description>",
-            help=_("New local IP description"),
+            help=_("Description for Local IP"),
         )
         parser.add_argument(
             '--network',
             metavar='<network>',
-            help=_("Network to allocate Local IP (name or ID)"),
+            help=_("Network to allocate Local IP from (name or ID)"),
         )
         parser.add_argument(
             '--local-port',
             metavar='<local-port>',
-            help=_("Port to allocate Local IP (name or ID)"),
+            help=_("Port to allocate Local IP from (name or ID)"),
         )
         parser.add_argument(
             "--local-ip-address",
             metavar="<local-ip-address>",
-            help=_("IP address or CIDR "),
+            help=_("IP address or CIDR for Local IP"),
         )
         parser.add_argument(
-            '--ip-mode', metavar='<ip-mode>', help=_("local IP ip mode")
+            '--ip-mode',
+            metavar='<ip-mode>',
+            help=_("IP mode to use for Local IP"),
         )
 
         identity_common.add_project_domain_option_to_parser(parser)
@@ -116,7 +117,7 @@ class CreateLocalIP(command.ShowOne):
 
 
 class DeleteLocalIP(command.Command):
-    _description = _("Delete local IP(s)")
+    _description = _("Delete Local IP(s)")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -149,14 +150,15 @@ class DeleteLocalIP(command.Command):
 
         if result > 0:
             total = len(parsed_args.local_ip)
-            msg = _(
-                "%(result)s of %(total)s local IPs failed " "to delete."
-            ) % {'result': result, 'total': total}
+            msg = _("%(result)s of %(total)s local IPs failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 
 class SetLocalIP(command.Command):
-    _description = _("Set local ip properties")
+    _description = _("Set Local IP properties")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -171,7 +173,7 @@ class SetLocalIP(command.Command):
         parser.add_argument(
             '--description',
             metavar="<description>",
-            help=_('Set local IP description'),
+            help=_('Set Local IP description'),
         )
         return parser
 
@@ -188,7 +190,7 @@ class SetLocalIP(command.Command):
 
 
 class ListLocalIP(command.Lister):
-    _description = _("List local IPs")
+    _description = _("List Local IPs")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
@@ -196,36 +198,32 @@ class ListLocalIP(command.Lister):
         parser.add_argument(
             '--name',
             metavar='<name>',
-            help=_("List only local IPs of given name in output"),
+            help=_("List only Local IPs of given name in output"),
         )
         parser.add_argument(
             '--project',
             metavar="<project>",
-            help=_(
-                "List Local IPs according to their project " "(name or ID)"
-            ),
+            help=_("List Local IPs according to their project (name or ID)"),
         )
         parser.add_argument(
             '--network',
             metavar='<network>',
-            help=_(
-                "List Local IP(s) according to " "given network (name or ID)"
-            ),
+            help=_("List Local IP(s) according to given 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 Local IP(s) according to given 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 Local IP(s) according to given Local IP Address"),
         )
         parser.add_argument(
             '--ip-mode',
             metavar='<ip_mode>',
-            help=_("List Local IP(s) according to " "given IP mode"),
+            help=_("List Local IP(s) according to given IP mode"),
         )
 
         identity_common.add_project_domain_option_to_parser(parser)
@@ -295,7 +293,7 @@ class ListLocalIP(command.Lister):
 
 
 class ShowLocalIP(command.ShowOne):
-    _description = _("Display local IP details")
+    _description = _("Display Local IP details")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)