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

openstackclient/network/v2/network_agent.py

@@ -13,26 +13,31 @@
 
 """Network agent action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from cliff import columns as cliff_columns
+from openstack.network.v2 import agent as _agent
 from osc_lib.cli import format_columns
 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__)
 
 
 class AliveColumn(cliff_columns.FormattableColumn[bool]):
-    def human_readable(self):
+    def human_readable(self) -> str:
         return ":-)" if self._value else "XXX"
 
 
 class AdminStateColumn(cliff_columns.FormattableColumn[bool]):
-    def human_readable(self):
+    def human_readable(self) -> str:
         return 'UP' if self._value else 'DOWN'
 
 
@@ -45,21 +50,37 @@ _formatters = {
 }
 
 
-def _get_network_columns(item):
-    column_map = {
-        'is_admin_state_up': 'admin_state_up',
-        'is_alive': 'alive',
+def _get_network_columns(
+    item: _agent.Agent,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
+    column_data_mapping = {
+        'admin_state_up': 'is_admin_state_up',
+        'agent_type': 'agent_type',
+        'alive': 'is_alive',
+        'availability_zone': 'availability_zone',
+        'binary': 'binary',
+        'configuration': 'configuration',
+        'created_at': 'created_at',
+        'description': 'description',
+        'ha_chassis_priority': 'ha_chassis_priority',
+        'ha_state': 'ha_state',
+        'host': 'host',
+        'id': 'id',
+        'last_heartbeat_at': 'last_heartbeat_at',
+        'resources_synced': 'resources_synced',
+        'started_at': 'started_at',
+        'topic': 'topic',
     }
-    hidden_columns = ['location', 'name', 'tenant_id']
-    return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+    return (
+        tuple(column_data_mapping.keys()),
+        tuple(column_data_mapping.values()),
     )
 
 
 class AddNetworkToAgent(command.Command):
     _description = _("Add network to an agent")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--dhcp',
@@ -79,7 +100,7 @@ class AddNetworkToAgent(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
         agent = client.get_agent(parsed_args.agent_id)
         network = client.find_network(
@@ -96,11 +117,20 @@ class AddNetworkToAgent(command.Command):
 class AddRouterToAgent(command.Command):
     _description = _("Add router to an agent")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--l3', action='store_true', help=_('Add router to an L3 agent')
         )
+        parser.add_argument(
+            '--ha-chassis-priority',
+            metavar='<ha-chassis-priority>',
+            type=int,
+            help=_(
+                "HA Chassis priority, ranging from [0, 32767]. "
+                "Only used with --l3 and for ML2/OVN L3 agents"
+            ),
+        )
         parser.add_argument(
             'agent_id',
             metavar='<agent-id>',
@@ -114,18 +144,22 @@ class AddRouterToAgent(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
         agent = client.get_agent(parsed_args.agent_id)
         router = client.find_router(parsed_args.router, ignore_missing=False)
         if parsed_args.l3:
-            client.add_router_to_agent(agent, router)
+            client.add_router_to_agent(
+                agent,
+                router,
+                ha_chassis_priority=parsed_args.ha_chassis_priority,
+            )
 
 
 class DeleteNetworkAgent(command.Command):
     _description = _("Delete network agent(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(
             'network_agent',
@@ -135,7 +169,7 @@ class DeleteNetworkAgent(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,8 +194,6 @@ class DeleteNetworkAgent(command.Command):
             raise exceptions.CommandError(msg)
 
 
-# TODO(huanxuan): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class ListNetworkAgent(command.Lister):
     _description = _("List network agents")
     _supported_agents = {
@@ -183,7 +215,7 @@ class ListNetworkAgent(command.Lister):
         'ovn-agent': 'OVN Neutron agent',
     }
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         supported_agents = ','.join(self._supported_agents.keys())
         parser.add_argument(
@@ -218,10 +250,13 @@ class ListNetworkAgent(command.Lister):
             default=False,
             help=_("List additional fields in output"),
         )
+        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: tuple[str, ...] = (
             'id',
@@ -243,12 +278,19 @@ class ListNetworkAgent(command.Lister):
         )
 
         filters = {}
-
+        if parsed_args.marker is not None:
+            filters['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            filters['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            filters['max_items'] = parsed_args.max_items
+
+        data: list[_agent.Agent]
         if parsed_args.network is not None:
             network = client.find_network(
                 parsed_args.network, ignore_missing=False
             )
-            data = client.network_hosting_dhcp_agents(network)
+            data = list(client.network_hosting_dhcp_agents(network))
         elif parsed_args.router is not None:
             if parsed_args.long:
                 columns += ('ha_state',)
@@ -256,7 +298,7 @@ class ListNetworkAgent(command.Lister):
             router = client.find_router(
                 parsed_args.router, ignore_missing=False
             )
-            data = client.routers_hosting_l3_agents(router)
+            data = list(client.routers_hosting_l3_agents(router))
         else:
             if parsed_args.agent_type is not None:
                 filters['agent_type'] = self._supported_agents[
@@ -265,7 +307,8 @@ class ListNetworkAgent(command.Lister):
             if parsed_args.host is not None:
                 filters['host'] = parsed_args.host
 
-            data = client.agents(**filters)
+            data = list(client.agents(**filters))
+
         return (
             column_headers,
             (
@@ -282,7 +325,7 @@ class ListNetworkAgent(command.Lister):
 class RemoveNetworkFromAgent(command.Command):
     _description = _("Remove network from an agent.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--dhcp',
@@ -301,7 +344,7 @@ class RemoveNetworkFromAgent(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
         agent = client.get_agent(parsed_args.agent_id)
         network = client.find_network(
@@ -318,7 +361,7 @@ class RemoveNetworkFromAgent(command.Command):
 class RemoveRouterFromAgent(command.Command):
     _description = _("Remove router from an agent")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--l3',
@@ -338,7 +381,7 @@ class RemoveRouterFromAgent(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
         agent = client.get_agent(parsed_args.agent_id)
         router = client.find_router(parsed_args.router, ignore_missing=False)
@@ -346,12 +389,10 @@ class RemoveRouterFromAgent(command.Command):
             client.remove_router_from_agent(agent, router)
 
 
-# TODO(huanxuan): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetNetworkAgent(command.Command):
     _description = _("Set network agent 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(
             'network_agent',
@@ -372,7 +413,7 @@ class SetNetworkAgent(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.get_agent(parsed_args.network_agent)
         attrs = {}
@@ -390,7 +431,7 @@ class SetNetworkAgent(command.Command):
 class ShowNetworkAgent(command.ShowOne):
     _description = _("Display network agent 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(
             'network_agent',
@@ -399,7 +440,9 @@ class ShowNetworkAgent(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.get_agent(parsed_args.network_agent)
         display_columns, columns = _get_network_columns(obj)

openstackclient/network/v2/network_auto_allocated_topology.py

@@ -13,8 +13,14 @@
 
 """Auto-allocated Topology Implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import (
+    auto_allocated_topology as _auto_allocated_topology,
+)
 from osc_lib import utils
 
 from openstackclient import command
@@ -24,26 +30,30 @@ from openstackclient.identity import common as identity_common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _auto_allocated_topology.AutoAllocatedTopology,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['name', 'location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
 
 
-def _format_check_resource_columns():
+def _format_check_resource_columns() -> tuple[str, ...]:
     return ('dry_run',)
 
 
-def _format_check_resource(item):
+def _format_check_resource(item: Any) -> Any:
     item_id = getattr(item, 'id', False)
     if item_id == 'dry-run=pass':
         item.check_resource = 'pass'
     return 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] = {}
     if parsed_args.project:
         identity_client = client_manager.identity
         project_id = identity_common.find_project(
@@ -58,12 +68,10 @@ def _get_attrs(client_manager, parsed_args):
     return attrs
 
 
-# TODO(ankur-gupta-f): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class CreateAutoAllocatedTopology(command.ShowOne):
     _description = _("Create the  auto allocated topology for project")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--project',
@@ -94,7 +102,9 @@ class CreateAutoAllocatedTopology(command.ShowOne):
 
         return parser
 
-    def check_resource_topology(self, client, parsed_args):
+    def check_resource_topology(
+        self, client: Any, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Any]:
         obj = client.validate_auto_allocated_topology(parsed_args.project)
 
         columns = _format_check_resource_columns()
@@ -104,13 +114,17 @@ class CreateAutoAllocatedTopology(command.ShowOne):
 
         return (columns, data)
 
-    def get_topology(self, client, parsed_args):
+    def get_topology(
+        self, client: Any, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Any]:
         obj = client.get_auto_allocated_topology(parsed_args.project)
         display_columns, columns = _get_columns(obj)
         data = utils.get_item_properties(obj, columns, formatters={})
         return (display_columns, data)
 
-    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 parsed_args.check_resources:
             columns, data = self.check_resource_topology(client, parsed_args)
@@ -119,12 +133,10 @@ class CreateAutoAllocatedTopology(command.ShowOne):
         return (columns, data)
 
 
-# TODO(ankur-gupta-f): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class DeleteAutoAllocatedTopology(command.Command):
     _description = _("Delete auto allocated topology for project")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--project',
@@ -138,6 +150,6 @@ class DeleteAutoAllocatedTopology(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
         client.delete_auto_allocated_topology(parsed_args.project)

openstackclient/network/v2/network_flavor.py

@@ -13,12 +13,17 @@
 
 """Flavor action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import flavor as _flavor
 from osc_lib import exceptions
 from osc_lib import utils
 
 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
@@ -26,7 +31,9 @@ from openstackclient.network import common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _flavor.Flavor,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'is_enabled': 'enabled',
     }
@@ -37,8 +44,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['service_type'] = parsed_args.service_type
     if parsed_args.description is not None:
@@ -62,7 +71,7 @@ def _get_attrs(client_manager, parsed_args):
 class AddNetworkFlavorToProfile(command.Command):
     _description = _("Add a service profile to a network flavor")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'flavor', metavar="<flavor>", help=_("Network flavor (name or ID)")
@@ -74,7 +83,7 @@ class AddNetworkFlavorToProfile(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_flavor = client.find_flavor(
             parsed_args.flavor, ignore_missing=False
@@ -87,12 +96,10 @@ class AddNetworkFlavorToProfile(command.Command):
         )
 
 
-# TODO(dasanind): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class CreateNetworkFlavor(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create new network flavor")
 
-    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=_("Name for the flavor")
@@ -129,7 +136,9 @@ class CreateNetworkFlavor(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(
@@ -145,7 +154,7 @@ class CreateNetworkFlavor(command.ShowOne, common.NeutronCommandWithExtraArgs):
 class DeleteNetworkFlavor(command.Command):
     _description = _("Delete network flavors")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -156,7 +165,7 @@ class DeleteNetworkFlavor(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
 
@@ -185,7 +194,14 @@ class DeleteNetworkFlavor(command.Command):
 class ListNetworkFlavor(command.Lister):
     _description = _("List network flavors")
 
-    def take_action(self, parsed_args):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        pagination.add_marker_pagination_option_to_parser(parser)
+        return parser
+
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         client = self.app.client_manager.network
 
         columns = ('id', 'name', 'is_enabled', 'service_type', 'description')
@@ -197,7 +213,15 @@ class ListNetworkFlavor(command.Lister):
             'Description',
         )
 
-        data = client.flavors()
+        filters = {}
+        if parsed_args.marker is not None:
+            filters['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            filters['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            filters['max_items'] = parsed_args.max_items
+
+        data = client.flavors(**filters)
         return (
             column_headers,
             (
@@ -213,7 +237,7 @@ class ListNetworkFlavor(command.Lister):
 class RemoveNetworkFlavorFromProfile(command.Command):
     _description = _("Remove service profile from network flavor")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'flavor', metavar="<flavor>", help=_("Network flavor (name or ID)")
@@ -225,7 +249,7 @@ class RemoveNetworkFlavorFromProfile(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_flavor = client.find_flavor(
             parsed_args.flavor, ignore_missing=False
@@ -238,12 +262,10 @@ class RemoveNetworkFlavorFromProfile(command.Command):
         )
 
 
-# TODO(dasanind): Use only the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetNetworkFlavor(common.NeutronCommandWithExtraArgs):
     _description = _("Set network flavor 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(
             'flavor',
@@ -266,7 +288,7 @@ class SetNetworkFlavor(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_flavor(parsed_args.flavor, ignore_missing=False)
         attrs = {}
@@ -287,7 +309,7 @@ class SetNetworkFlavor(common.NeutronCommandWithExtraArgs):
 class ShowNetworkFlavor(command.ShowOne):
     _description = _("Display network flavor 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(
             'flavor',
@@ -296,7 +318,9 @@ class ShowNetworkFlavor(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_flavor(parsed_args.flavor, ignore_missing=False)
         display_columns, columns = _get_columns(obj)