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

openstackclient/network/utils.py

@@ -11,13 +11,18 @@
 #   under the License.
 #
 
+from collections.abc import Iterable, Sequence
+from typing import Any, cast
+
 from osc_lib import exceptions
 
 from openstackclient.i18n import _
 
 
 # Transform compute security group rule for display.
-def transform_compute_security_group_rule(sg_rule):
+def transform_compute_security_group_rule(
+    sg_rule: dict[str, Any],
+) -> dict[str, Any]:
     info = {}
     info.update(sg_rule)
     from_port = info.pop('from_port')
@@ -45,14 +50,14 @@ def transform_compute_security_group_rule(sg_rule):
     return info
 
 
-def str2bool(strbool):
+def str2bool(strbool: str | None) -> bool | None:
     if strbool is None:
         return None
     return strbool.lower() == 'true'
 
 
-def str2list(strlist):
-    result = []
+def str2list(strlist: str | None) -> list[str]:
+    result: list[str] = []
     if strlist:
         result = strlist.split(';')
     return result
@@ -78,17 +83,20 @@ def str2dict(strdict: str) -> dict[str, str]:
         else:
             kvlist[i - 1] = f"{kvlist[i - 1]};{kv}"
     for kv in kvlist:
-        key, sep, value = kv.partition(':')
+        key, value = kv.split(':', 1)
         result[key] = value
     return result
 
 
-def format_security_group_rule_show(obj):
+def format_security_group_rule_show(
+    obj: dict[str, Any],
+) -> tuple[Sequence[str], Iterable[Any]]:
     data = transform_compute_security_group_rule(obj)
-    return zip(*sorted(data.items()))
+    col_headers, col_data = zip(*sorted(data.items()))
+    return col_headers, col_data
 
 
-def format_network_port_range(rule):
+def format_network_port_range(rule: dict[str, Any]) -> str:
     # Display port range or ICMP type and code. For example:
     # - ICMP type: 'type=3'
     # - ICMP type and code: 'type=3:code=0'
@@ -114,8 +122,8 @@ def format_network_port_range(rule):
     return port_range
 
 
-def format_remote_ip_prefix(rule):
-    remote_ip_prefix = rule['remote_ip_prefix']
+def format_remote_ip_prefix(rule: dict[str, Any]) -> str | None:
+    remote_ip_prefix = cast(str | None, rule['remote_ip_prefix'])
     if remote_ip_prefix is None:
         ethertype = rule['ether_type']
         if ethertype == 'IPv4':
@@ -125,7 +133,7 @@ def format_remote_ip_prefix(rule):
     return remote_ip_prefix
 
 
-def convert_ipvx_case(string):
+def convert_ipvx_case(string: str) -> str:
     if string.lower() == 'ipv4':
         return 'IPv4'
     if string.lower() == 'ipv6':
@@ -133,7 +141,7 @@ def convert_ipvx_case(string):
     return string
 
 
-def is_icmp_protocol(protocol):
+def is_icmp_protocol(protocol: str | None) -> bool:
     # NOTE(rtheis): Neutron has deprecated protocol icmpv6.
     # However, while the OSC CLI doesn't document the protocol,
     # the code must still handle it. In addition, handle both
@@ -144,12 +152,14 @@ def is_icmp_protocol(protocol):
         return False
 
 
-def convert_to_lowercase(string):
+def convert_to_lowercase(string: str) -> str:
     return string.lower()
 
 
-def get_protocol(parsed_args, default_protocol='any'):
-    protocol = default_protocol
+def get_protocol(
+    parsed_args: Any, default_protocol: str = 'any'
+) -> str | None:
+    protocol: str | None = default_protocol
     if parsed_args.protocol is not None:
         protocol = parsed_args.protocol
     if hasattr(parsed_args, "proto") and parsed_args.proto is not None:
@@ -159,7 +169,7 @@ def get_protocol(parsed_args, default_protocol='any'):
     return protocol
 
 
-def get_ethertype(parsed_args, protocol):
+def get_ethertype(parsed_args: Any, protocol: str | None) -> str:
     ethertype = 'IPv4'
     if parsed_args.ethertype is not None:
         ethertype = parsed_args.ethertype
@@ -168,16 +178,20 @@ def get_ethertype(parsed_args, protocol):
     return ethertype
 
 
-def is_ipv6_protocol(protocol):
+def is_ipv6_protocol(protocol: str | None) -> bool:
     # NOTE(rtheis): Neutron has deprecated protocol icmpv6.
     # However, while the OSC CLI doesn't document the protocol,
     # the code must still handle it. In addition, handle both
     # protocol names and numbers.
-    if (
-        protocol is not None
-        and protocol.startswith('ipv6-')
-        or protocol in ['icmpv6', '41', '43', '44', '58', '59', '60']
-    ):
+    if (protocol is not None and protocol.startswith('ipv6-')) or protocol in [
+        'icmpv6',
+        '41',
+        '43',
+        '44',
+        '58',
+        '59',
+        '60',
+    ]:
         return True
     else:
         return False

openstackclient/network/v2/address_group.py

@@ -13,7 +13,10 @@
 
 """Address group action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 import netaddr
 from osc_lib import exceptions
@@ -27,19 +30,21 @@ from openstackclient.network import common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
 
 
-def _format_addresses(addresses):
+def _format_addresses(addresses: list[str]) -> list[str]:
     return [str(netaddr.IPNetwork(addr)) for addr in addresses]
 
 
-def _get_attrs(client_manager, parsed_args):
-    attrs = {}
+def _get_attrs(
+    client_manager: Any, parsed_args: argparse.Namespace
+) -> dict[str, Any]:
+    attrs: dict[str, Any] = {}
     attrs['name'] = parsed_args.name
     if parsed_args.description:
         attrs['description'] = parsed_args.description
@@ -59,7 +64,7 @@ def _get_attrs(client_manager, parsed_args):
 class CreateAddressGroup(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new Address Group")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'name', metavar="<name>", help=_("New address group name")
@@ -87,7 +92,9 @@ class CreateAddressGroup(command.ShowOne, common.NeutronCommandWithExtraArgs):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         client = self.app.client_manager.network
         attrs = _get_attrs(self.app.client_manager, parsed_args)
 
@@ -105,7 +112,7 @@ class CreateAddressGroup(command.ShowOne, common.NeutronCommandWithExtraArgs):
 class DeleteAddressGroup(command.Command):
     _description = _("Delete address group(s)")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'address_group',
@@ -116,7 +123,7 @@ class DeleteAddressGroup(command.Command):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.network
         result = 0
 
@@ -145,7 +152,7 @@ class DeleteAddressGroup(command.Command):
 class ListAddressGroup(command.Lister):
     _description = _("List address groups")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -165,7 +172,9 @@ class ListAddressGroup(command.Lister):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         client = self.app.client_manager.network
         columns = (
             'id',
@@ -210,7 +219,7 @@ class ListAddressGroup(command.Lister):
 class SetAddressGroup(common.NeutronCommandWithExtraArgs):
     _description = _("Set address group properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'address_group',
@@ -236,7 +245,7 @@ class SetAddressGroup(common.NeutronCommandWithExtraArgs):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.network
         obj = client.find_address_group(
             parsed_args.address_group, ignore_missing=False
@@ -261,7 +270,7 @@ class SetAddressGroup(common.NeutronCommandWithExtraArgs):
 class ShowAddressGroup(command.ShowOne):
     _description = _("Display address group details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'address_group',
@@ -271,7 +280,9 @@ class ShowAddressGroup(command.ShowOne):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         client = self.app.client_manager.network
         obj = client.find_address_group(
             parsed_args.address_group, ignore_missing=False
@@ -285,7 +296,7 @@ class ShowAddressGroup(command.ShowOne):
 class UnsetAddressGroup(command.Command):
     _description = _("Unset address group properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'address_group',
@@ -304,7 +315,7 @@ class UnsetAddressGroup(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.network
         obj = client.find_address_group(
             parsed_args.address_group, ignore_missing=False

openstackclient/network/v2/address_scope.py

@@ -13,7 +13,10 @@
 
 """Address scope action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib import exceptions
 from osc_lib import utils
@@ -26,7 +29,7 @@ from openstackclient.network import common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(item: Any) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'is_shared': 'shared',
     }
@@ -36,8 +39,10 @@ def _get_columns(item):
     )
 
 
-def _get_attrs(client_manager, parsed_args):
-    attrs = {}
+def _get_attrs(
+    client_manager: Any, parsed_args: argparse.Namespace
+) -> dict[str, Any]:
+    attrs: dict[str, Any] = {}
     attrs['name'] = parsed_args.name
     attrs['ip_version'] = parsed_args.ip_version
     if parsed_args.share:
@@ -61,7 +66,7 @@ def _get_attrs(client_manager, parsed_args):
 class CreateAddressScope(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new Address Scope")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'name', metavar="<name>", help=_("New address scope name")
@@ -96,7 +101,9 @@ class CreateAddressScope(command.ShowOne, common.NeutronCommandWithExtraArgs):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         client = self.app.client_manager.network
         attrs = _get_attrs(self.app.client_manager, parsed_args)
         attrs.update(
@@ -112,7 +119,7 @@ class CreateAddressScope(command.ShowOne, common.NeutronCommandWithExtraArgs):
 class DeleteAddressScope(command.Command):
     _description = _("Delete address scope(s)")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'address_scope',
@@ -123,7 +130,7 @@ class DeleteAddressScope(command.Command):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.network
         result = 0
 
@@ -154,7 +161,7 @@ class DeleteAddressScope(command.Command):
 class ListAddressScope(command.Lister):
     _description = _("List address scopes")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -196,7 +203,9 @@ class ListAddressScope(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         client = self.app.client_manager.network
         columns = (
             'id',
@@ -249,7 +258,7 @@ class ListAddressScope(command.Lister):
 class SetAddressScope(common.NeutronCommandWithExtraArgs):
     _description = _("Set address scope properties")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'address_scope',
@@ -273,7 +282,7 @@ class SetAddressScope(common.NeutronCommandWithExtraArgs):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         client = self.app.client_manager.network
         obj = client.find_address_scope(
             parsed_args.address_scope, ignore_missing=False
@@ -294,7 +303,7 @@ class SetAddressScope(common.NeutronCommandWithExtraArgs):
 class ShowAddressScope(command.ShowOne):
     _description = _("Display address scope details")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'address_scope',
@@ -304,7 +313,9 @@ class ShowAddressScope(command.ShowOne):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         client = self.app.client_manager.network
         obj = client.find_address_scope(
             parsed_args.address_scope, ignore_missing=False