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

openstackclient/network/v2/router.py

@@ -14,13 +14,15 @@
 """Router action implementations"""
 
 import argparse
+from collections.abc import Iterable, Sequence
 import collections
 import copy
 import json
 import logging
-import typing as ty
+from typing import Any
 
 from cliff import columns as cliff_columns
+from openstack.network.v2 import router as _router
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 from osc_lib import exceptions
@@ -28,6 +30,7 @@ from osc_lib import utils
 from osc_lib.utils import tags as _tag
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 from openstackclient.network import common
@@ -36,25 +39,25 @@ LOG = logging.getLogger(__name__)
 
 
 class AdminStateColumn(cliff_columns.FormattableColumn[bool]):
-    def human_readable(self):
+    def human_readable(self) -> str:
         return 'UP' if self._value else 'DOWN'
 
 
-class RouterInfoColumn(cliff_columns.FormattableColumn[ty.Any]):
-    def human_readable(self):
+class RouterInfoColumn(cliff_columns.FormattableColumn[Any]):
+    def human_readable(self) -> str:
         try:
             return json.dumps(self._value)
         except (TypeError, KeyError):
             return ''
 
 
-class RoutesColumn(cliff_columns.FormattableColumn[ty.Any]):
-    def human_readable(self):
+class RoutesColumn(cliff_columns.FormattableColumn[Any]):
+    def human_readable(self) -> str:
         # Map the route keys to match --route option.
         for route in self._value or []:
             if 'nexthop' in route:
                 route['gateway'] = route.pop('nexthop')
-        return utils.format_list_of_dicts(self._value)
+        return utils.format_list_of_dicts(self._value) or ""
 
 
 _formatters = {
@@ -68,7 +71,9 @@ _formatters = {
 }
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _router.Router,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'is_ha': 'ha',
         'is_distributed': 'distributed',
@@ -76,19 +81,21 @@ def _get_columns(item):
     }
     if hasattr(item, 'interfaces_info'):
         column_map['interfaces_info'] = 'interfaces_info'
-    invisible_columns = ['location', 'tenant_id']
+    hidden_columns = ['location', 'tenant_id']
     if item.is_ha is None:
-        invisible_columns.append('is_ha')
+        hidden_columns.append('is_ha')
         column_map.pop('is_ha')
     if item.is_distributed is None:
-        invisible_columns.append('is_distributed')
+        hidden_columns.append('is_distributed')
         column_map.pop('is_distributed')
+    if not hasattr(item, 'evpn_vni'):
+        hidden_columns.append('evpn_vni')
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, invisible_columns
+        item, column_map, hidden_columns
     )
 
 
-def is_multiple_gateways_supported(n_client):
+def is_multiple_gateways_supported(n_client: Any) -> bool:
     return (
         n_client.find_extension(
             "external-gateway-multihoming", ignore_missing=True
@@ -97,7 +104,9 @@ def is_multiple_gateways_supported(n_client):
     )
 
 
-def _passed_multiple_gateways(extension_supported, external_gateways):
+def _passed_multiple_gateways(
+    extension_supported: bool, external_gateways: list[Any]
+) -> bool:
     passed_multiple_gws = len(external_gateways) > 1
     if passed_multiple_gws and not extension_supported:
         msg = _(
@@ -109,13 +118,15 @@ def _passed_multiple_gateways(extension_supported, external_gateways):
     return passed_multiple_gws
 
 
-def _get_external_gateway_attrs(client_manager, parsed_args):
-    attrs: dict[str, ty.Any] = {}
+def _get_external_gateway_attrs(
+    client_manager: Any, parsed_args: argparse.Namespace
+) -> dict[str, Any]:
+    attrs: dict[str, Any] = {}
 
     if parsed_args.external_gateways:
-        external_gateways: collections.defaultdict[str, list[dict]] = (
-            collections.defaultdict(list)
-        )
+        external_gateways: collections.defaultdict[
+            str, list[dict[str, Any]]
+        ] = collections.defaultdict(list)
         n_client = client_manager.network
         first_network_id = ''
 
@@ -206,8 +217,10 @@ def _get_external_gateway_attrs(client_manager, parsed_args):
     return attrs
 
 
-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] = {}
     n_client = client_manager.network
 
     if parsed_args.name is not None:
@@ -257,7 +270,7 @@ def _get_attrs(client_manager, parsed_args):
     return attrs
 
 
-def _parser_add_bfd_ecmp_arguments(parser):
+def _parser_add_bfd_ecmp_arguments(parser: argparse.ArgumentParser) -> None:
     """Helper to add BFD and ECMP args for CreateRouter and SetRouter."""
     parser.add_argument(
         '--enable-default-route-bfd',
@@ -298,7 +311,9 @@ def _parser_add_bfd_ecmp_arguments(parser):
     )
 
 
-def _command_check_bfd_ecmp_supported(attrs, client):
+def _command_check_bfd_ecmp_supported(
+    attrs: dict[str, Any], client: Any
+) -> None:
     """Helper to check for server side support when bfd/ecmp attrs provided.
 
     :raises: exceptions.CommandError
@@ -318,7 +333,7 @@ def _command_check_bfd_ecmp_supported(attrs, client):
 class AddPortToRouter(command.Command):
     _description = _("Add a port to a router")
 
-    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',
@@ -330,19 +345,19 @@ class AddPortToRouter(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
         port = client.find_port(parsed_args.port, ignore_missing=False)
         client.add_interface_to_router(
             client.find_router(parsed_args.router, ignore_missing=False),
-            port_id=port.id,
+            port=port.id,
         )
 
 
 class AddSubnetToRouter(command.Command):
     _description = _("Add a subnet to a router")
 
-    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',
@@ -356,19 +371,19 @@ class AddSubnetToRouter(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
         subnet = client.find_subnet(parsed_args.subnet, ignore_missing=False)
         client.add_interface_to_router(
             client.find_router(parsed_args.router, ignore_missing=False),
-            subnet_id=subnet.id,
+            subnet=subnet.id,
         )
 
 
 class AddExtraRoutesToRouter(command.ShowOne):
     _description = _("Add extra static routes to a router's routing table.")
 
-    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',
@@ -398,7 +413,9 @@ class AddExtraRoutesToRouter(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         if parsed_args.routes is not None:
             for route in parsed_args.routes:
                 route['nexthop'] = route.pop('gateway')
@@ -419,7 +436,7 @@ class RemoveExtraRoutesFromRouter(command.ShowOne):
         "Remove extra static routes from a router's routing table."
     )
 
-    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',
@@ -449,7 +466,9 @@ class RemoveExtraRoutesFromRouter(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         if parsed_args.routes is not None:
             for route in parsed_args.routes:
                 route['nexthop'] = route.pop('gateway')
@@ -465,12 +484,10 @@ class RemoveExtraRoutesFromRouter(command.ShowOne):
         return (display_columns, data)
 
 
-# TODO(yanxing'an): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class CreateRouter(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new router")
 
-    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 router name")
@@ -597,7 +614,9 @@ class CreateRouter(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)
@@ -661,7 +680,7 @@ class CreateRouter(command.ShowOne, common.NeutronCommandWithExtraArgs):
 class DeleteRouter(command.Command):
     _description = _("Delete router(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(
             'router',
@@ -671,7 +690,7 @@ class DeleteRouter(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
 
@@ -698,12 +717,10 @@ class DeleteRouter(command.Command):
             raise exceptions.CommandError(msg)
 
 
-# TODO(yanxing'an): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class ListRouter(command.Lister):
     _description = _("List routers")
 
-    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',
@@ -739,10 +756,13 @@ class ListRouter(command.Lister):
             ),
         )
         _tag.add_tag_filtering_option_to_parser(parser, _('routers'))
+        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, ...]]]:
         identity_client = self.app.client_manager.identity
         client = self.app.client_manager.network
 
@@ -781,16 +801,26 @@ class ListRouter(command.Lister):
             ).id
             args['project_id'] = project_id
 
+        if parsed_args.marker is not None:
+            args['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            args['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            args['max_items'] = parsed_args.max_items
+
         _tag.get_tag_filtering_args(parsed_args, args)
 
-        if parsed_args.agent is not None:
+        if parsed_args.agent is None:
+            data = list(client.routers(**args))
+        else:
             agent = client.get_agent(parsed_args.agent)
-            data = client.agent_hosted_routers(agent)
             # NOTE: Networking API does not support filtering by parameters,
             # so we need filtering in the client side.
-            data = [d for d in data if self._filter_match(d, args)]
-        else:
-            data = client.routers(**args)
+            data = [
+                d
+                for d in client.agent_hosted_routers(agent)
+                if self._filter_match(d, args)
+            ]
 
         # check if "HA" and "Distributed" columns should be displayed also
         data = list(data)
@@ -834,7 +864,7 @@ class ListRouter(command.Lister):
         )
 
     @staticmethod
-    def _filter_match(data, conditions):
+    def _filter_match(data: Any, conditions: dict[str, Any]) -> bool:
         for key, value in conditions.items():
             try:
                 if getattr(data, key) != value:
@@ -851,7 +881,7 @@ class ListRouter(command.Lister):
 class RemovePortFromRouter(command.Command):
     _description = _("Remove a port from a router")
 
-    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',
@@ -865,19 +895,19 @@ class RemovePortFromRouter(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
         port = client.find_port(parsed_args.port, ignore_missing=False)
         client.remove_interface_from_router(
             client.find_router(parsed_args.router, ignore_missing=False),
-            port_id=port.id,
+            port=port.id,
         )
 
 
 class RemoveSubnetFromRouter(command.Command):
     _description = _("Remove a subnet from a router")
 
-    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',
@@ -893,21 +923,19 @@ class RemoveSubnetFromRouter(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
         subnet = client.find_subnet(parsed_args.subnet, ignore_missing=False)
         client.remove_interface_from_router(
             client.find_router(parsed_args.router, ignore_missing=False),
-            subnet_id=subnet.id,
+            subnet=subnet.id,
         )
 
 
-# TODO(yanxing'an): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetRouter(common.NeutronCommandWithExtraArgs):
     _description = _("Set router 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',
@@ -1051,7 +1079,7 @@ class SetRouter(common.NeutronCommandWithExtraArgs):
         _parser_add_bfd_ecmp_arguments(parser)
         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_router(parsed_args.router, ignore_missing=False)
 
@@ -1141,7 +1169,7 @@ class SetRouter(common.NeutronCommandWithExtraArgs):
 class ShowRouter(command.ShowOne):
     _description = _("Display router 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',
@@ -1150,7 +1178,9 @@ class ShowRouter(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_router(parsed_args.router, ignore_missing=False)
         interfaces_info = []
@@ -1177,7 +1207,7 @@ class ShowRouter(command.ShowOne):
 class UnsetRouter(common.NeutronUnsetCommandWithExtraArgs):
     _description = _("Unset router 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(
             '--route',
@@ -1217,7 +1247,7 @@ class UnsetRouter(common.NeutronUnsetCommandWithExtraArgs):
         _tag.add_tag_option_to_parser_for_unset(parser, _('router'))
         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_router(parsed_args.router, ignore_missing=False)
         tmp_routes = copy.deepcopy(obj.routes)
@@ -1272,7 +1302,7 @@ class UnsetRouter(common.NeutronUnsetCommandWithExtraArgs):
 class AddGatewayToRouter(command.ShowOne):
     _description = _("Add router gateway")
 
-    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',
@@ -1304,7 +1334,9 @@ class AddGatewayToRouter(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
         if not is_multiple_gateways_supported(client):
             msg = _(
@@ -1339,7 +1371,7 @@ class AddGatewayToRouter(command.ShowOne):
 class RemoveGatewayFromRouter(command.ShowOne):
     _description = _("Remove router gateway")
 
-    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',
@@ -1371,7 +1403,9 @@ class RemoveGatewayFromRouter(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
         if not is_multiple_gateways_supported(client):
             msg = _(