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

openstackclient/network/v2/l3_conntrack_helper.py

@@ -13,27 +13,34 @@
 
 """L3 Conntrack Helper action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import l3_conntrack_helper as _l3_conntrack_helper
 from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _l3_conntrack_helper.ConntrackHelper,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
 
 
-def _get_attrs(client, parsed_args):
+def _get_attrs(client: Any, parsed_args: argparse.Namespace) -> dict[str, Any]:
     router = client.find_router(parsed_args.router, ignore_missing=False)
-    attrs = {'router_id': router.id}
+    attrs: dict[str, Any] = {'router_id': router.id}
     if parsed_args.helper:
         attrs['helper'] = parsed_args.helper
     if parsed_args.protocol:
@@ -47,7 +54,7 @@ def _get_attrs(client, parsed_args):
 class CreateConntrackHelper(command.ShowOne):
     _description = _("Create a new L3 conntrack helper")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
@@ -78,7 +85,9 @@ class CreateConntrackHelper(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
 
         attrs = _get_attrs(client, parsed_args)
@@ -92,7 +101,7 @@ class CreateConntrackHelper(command.ShowOne):
 class DeleteConntrackHelper(command.Command):
     _description = _("Delete L3 conntrack helper")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
@@ -108,7 +117,7 @@ class DeleteConntrackHelper(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
 
@@ -140,7 +149,7 @@ class DeleteConntrackHelper(command.Command):
 class ListConntrackHelper(command.Lister):
     _description = _("List L3 conntrack helpers")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'router',
@@ -171,10 +180,13 @@ class ListConntrackHelper(command.Lister):
                 'the netfilter conntrack target rule (name or ID)'
             ),
         )
+        pagination.add_marker_pagination_option_to_parser(parser)
 
         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',
@@ -190,7 +202,15 @@ class ListConntrackHelper(command.Lister):
             'Protocol',
             'Port',
         )
+
         attrs = _get_attrs(client, parsed_args)
+        if parsed_args.marker is not None:
+            attrs['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            attrs['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            attrs['max_items'] = parsed_args.max_items
+
         data = client.conntrack_helpers(attrs.pop('router_id'), **attrs)
 
         return (
@@ -209,7 +229,7 @@ class ListConntrackHelper(command.Lister):
 class SetConntrackHelper(command.Command):
     _description = _("Set L3 conntrack helper 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(
             'router',
@@ -241,7 +261,7 @@ class SetConntrackHelper(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
         attrs = _get_attrs(client, parsed_args)
         if attrs:
@@ -255,7 +275,7 @@ class SetConntrackHelper(command.Command):
 class ShowConntrackHelper(command.ShowOne):
     _description = _("Display L3 conntrack helper 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(
             'router',
@@ -270,7 +290,9 @@ class ShowConntrackHelper(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
         router = client.find_router(parsed_args.router, ignore_missing=False)
         obj = client.get_conntrack_helper(

openstackclient/network/v2/local_ip.py

@@ -15,8 +15,12 @@
 
 """Node Local IP action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import local_ip as _local_ip
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -27,15 +31,19 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _local_ip.LocalIP,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
 
 
-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] = {}
     network_client = client_manager.network
 
     if parsed_args.name:
@@ -70,7 +78,7 @@ def _get_attrs(client_manager, parsed_args):
 class CreateLocalIP(command.ShowOne):
     _description = _("Create Local IP")
 
-    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 Local IP name")
@@ -105,7 +113,9 @@ class CreateLocalIP(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
         attrs = _get_attrs(self.app.client_manager, parsed_args)
 
@@ -119,7 +129,7 @@ class CreateLocalIP(command.ShowOne):
 class DeleteLocalIP(command.Command):
     _description = _("Delete Local IP(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(
             'local_ip',
@@ -130,7 +140,7 @@ class DeleteLocalIP(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
 
@@ -160,7 +170,7 @@ class DeleteLocalIP(command.Command):
 class SetLocalIP(command.Command):
     _description = _("Set Local IP 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(
             'local_ip',
@@ -177,7 +187,7 @@ class SetLocalIP(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_local_ip(parsed_args.local_ip, ignore_missing=False)
         attrs = {}
@@ -192,7 +202,7 @@ class SetLocalIP(command.Command):
 class ListLocalIP(command.Lister):
     _description = _("List Local IPs")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -236,7 +246,9 @@ class ListLocalIP(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',
@@ -301,7 +313,7 @@ class ListLocalIP(command.Lister):
 class ShowLocalIP(command.ShowOne):
     _description = _("Display Local IP 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(
             'local_ip',
@@ -311,7 +323,9 @@ class ShowLocalIP(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_local_ip(parsed_args.local_ip, ignore_missing=False)
         display_columns, columns = _get_columns(obj)

openstackclient/network/v2/local_ip_association.py

@@ -15,8 +15,12 @@
 
 """Node Local IP action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import local_ip_association as _local_ip_association
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -27,7 +31,9 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _local_ip_association.LocalIPAssociation,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'name', 'id', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
@@ -37,7 +43,7 @@ def _get_columns(item):
 class CreateLocalIPAssociation(command.ShowOne):
     _description = _("Create Local IP Association")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'local_ip',
@@ -61,7 +67,9 @@ class CreateLocalIPAssociation(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
 
         attrs = {}
@@ -83,7 +91,7 @@ class CreateLocalIPAssociation(command.ShowOne):
 class DeleteLocalIPAssociation(command.Command):
     _description = _("Delete Local IP association(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(
             'local_ip',
@@ -100,7 +108,7 @@ class DeleteLocalIPAssociation(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
         local_ip = client.find_local_ip(
             parsed_args.local_ip,
@@ -138,7 +146,7 @@ class DeleteLocalIPAssociation(command.Command):
 class ListLocalIPAssociation(command.Lister):
     _description = _("List Local IP Associations")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -170,7 +178,9 @@ class ListLocalIPAssociation(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 = (
             'local_ip_id',

openstackclient/network/v2/ndp_proxy.py

@@ -15,8 +15,12 @@
 
 """Router NDP proxy action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import ndp_proxy as _ndp_proxy
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -28,7 +32,9 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _ndp_proxy.NDPProxy,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
@@ -38,7 +44,7 @@ def _get_columns(item):
 class CreateNDPProxy(command.ShowOne):
     _description = _("Create NDP proxy")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'router', metavar='<router>', help=_("The name or ID of a router")
@@ -75,7 +81,9 @@ class CreateNDPProxy(command.ShowOne):
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         attrs = {'name': parsed_args.name}
         client = self.app.client_manager.network
         router = client.find_router(
@@ -102,7 +110,7 @@ class CreateNDPProxy(command.ShowOne):
 class DeleteNDPProxy(command.Command):
     _description = _("Delete NDP proxy")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'ndp_proxy',
@@ -112,7 +120,7 @@ class DeleteNDPProxy(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
 
@@ -137,7 +145,7 @@ class DeleteNDPProxy(command.Command):
 class ListNDPProxy(command.Lister):
     _description = _("List NDP proxies")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--router',
@@ -180,7 +188,9 @@ class ListNDPProxy(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
         identity_client = self.app.client_manager.identity
 
@@ -239,7 +249,7 @@ class ListNDPProxy(command.Lister):
 class SetNDPProxy(command.Command):
     _description = _("Set NDP proxy 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(
             'ndp_proxy',
@@ -259,7 +269,7 @@ class SetNDPProxy(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
         attrs = {}
         if parsed_args.description is not None:
@@ -276,7 +286,7 @@ class SetNDPProxy(command.Command):
 class ShowNDPProxy(command.ShowOne):
     _description = _("Display NDP proxy 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(
             'ndp_proxy',
@@ -285,7 +295,9 @@ class ShowNDPProxy(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_ndp_proxy(
             parsed_args.ndp_proxy, ignore_missing=False