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

openstackclient/network/v2/network_segment_range.py

@@ -16,30 +16,35 @@
 
 """Network segment action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import itertools
 import logging
-import typing as ty
+from typing import Any
 
+from openstack.network.v2 import network_segment_range as _segment_range
 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
 
-
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _segment_range.NetworkSegmentRange,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
 
 
-def _get_ranges(item):
+def _get_ranges(item: Any) -> Iterable[str]:
     item = sorted([int(i) for i in item])
     for a, b in itertools.groupby(enumerate(item), lambda xy: xy[1] - xy[0]):
         c = list(b)
@@ -48,18 +53,24 @@ def _get_ranges(item):
         )
 
 
-def _hack_tuple_value_update_by_index(tup, index, value):
+def _hack_tuple_value_update_by_index(
+    tup: tuple[Any, ...], index: int, value: Any
+) -> tuple[Any, ...]:
     lot = list(tup)
     lot[index] = value
     return tuple(lot)
 
 
-def _is_prop_empty(columns, props, prop_name):
+def _is_prop_empty(
+    columns: tuple[str, ...], props: tuple[Any, ...], prop_name: str
+) -> bool:
     return True if not props[columns.index(prop_name)] else False
 
 
-def _exchange_dict_keys_with_values(orig_dict):
-    updated_dict: dict[str, ty.Any] = {}
+def _exchange_dict_keys_with_values(
+    orig_dict: dict[Any, Any],
+) -> dict[str, Any]:
+    updated_dict: dict[str, Any] = {}
     for k, v in orig_dict.items():
         k = [k]
         if not updated_dict.get(v):
@@ -69,7 +80,9 @@ def _exchange_dict_keys_with_values(orig_dict):
     return updated_dict
 
 
-def _update_available_from_props(columns, props):
+def _update_available_from_props(
+    columns: tuple[str, ...], props: tuple[Any, ...]
+) -> tuple[Any, ...]:
     index_available = columns.index('available')
     props = _hack_tuple_value_update_by_index(
         props, index_available, list(_get_ranges(props[index_available]))
@@ -77,7 +90,9 @@ def _update_available_from_props(columns, props):
     return props
 
 
-def _update_used_from_props(columns, props):
+def _update_used_from_props(
+    columns: tuple[str, ...], props: tuple[Any, ...]
+) -> tuple[Any, ...]:
     index_used = columns.index('used')
     updated_used = _exchange_dict_keys_with_values(props[index_used])
     for k, v in updated_used.items():
@@ -86,7 +101,9 @@ def _update_used_from_props(columns, props):
     return props
 
 
-def _update_additional_fields_from_props(columns, props):
+def _update_additional_fields_from_props(
+    columns: tuple[str, ...], props: tuple[Any, ...]
+) -> tuple[Any, ...]:
     props = _update_available_from_props(columns, props)
     props = _update_used_from_props(columns, props)
     return props
@@ -97,7 +114,7 @@ class CreateNetworkSegmentRange(
 ):
     _description = _("Create new network segment range")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         shared_group = parser.add_mutually_exclusive_group()
         shared_group.add_argument(
@@ -170,7 +187,9 @@ class CreateNetworkSegmentRange(
 
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         network_client = self.app.client_manager.network
         try:
             # Verify that the extension exists.
@@ -251,7 +270,7 @@ class CreateNetworkSegmentRange(
 class DeleteNetworkSegmentRange(command.Command):
     _description = _("Delete network segment range(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_segment_range',
@@ -261,7 +280,7 @@ class DeleteNetworkSegmentRange(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         network_client = self.app.client_manager.network
         try:
             # Verify that the extension exists.
@@ -304,7 +323,7 @@ class DeleteNetworkSegmentRange(command.Command):
 class ListNetworkSegmentRange(command.Lister):
     _description = _("List network segment ranges")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--long',
@@ -342,9 +361,12 @@ class ListNetworkSegmentRange(command.Lister):
                 'List only network segment ranges without available segments'
             ),
         )
+        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, ...], tuple[Any, ...]]:
         network_client = self.app.client_manager.network
         try:
             # Verify that the extension exists.
@@ -358,7 +380,15 @@ class ListNetworkSegmentRange(command.Lister):
             ) % {'e': e}
             raise exceptions.CommandError(msg)
 
-        data = network_client.network_segment_ranges()
+        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 = network_client.network_segment_ranges(**filters)
 
         headers: tuple[str, ...] = (
             'ID',
@@ -402,18 +432,25 @@ class ListNetworkSegmentRange(command.Lister):
                 'available',
             )
 
-        display_props: tuple[ty.Any, ...] = tuple()
+        display_props: tuple[Any, ...] = tuple()
         for s in data:
             props = utils.get_item_properties(s, columns)
             if (
-                parsed_args.available
-                and _is_prop_empty(columns, props, 'available')
-                or parsed_args.unavailable
-                and not _is_prop_empty(columns, props, 'available')
-                or parsed_args.used
-                and _is_prop_empty(columns, props, 'used')
-                or parsed_args.unused
-                and not _is_prop_empty(columns, props, 'used')
+                (
+                    parsed_args.available
+                    and _is_prop_empty(columns, props, 'available')
+                )
+                or (
+                    parsed_args.unavailable
+                    and not _is_prop_empty(columns, props, 'available')
+                )
+                or (
+                    parsed_args.used and _is_prop_empty(columns, props, 'used')
+                )
+                or (
+                    parsed_args.unused
+                    and not _is_prop_empty(columns, props, 'used')
+                )
             ):
                 continue
             if parsed_args.long:
@@ -426,7 +463,7 @@ class ListNetworkSegmentRange(command.Lister):
 class SetNetworkSegmentRange(common.NeutronCommandWithExtraArgs):
     _description = _("Set network segment range 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_segment_range',
@@ -452,7 +489,7 @@ class SetNetworkSegmentRange(common.NeutronCommandWithExtraArgs):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         network_client = self.app.client_manager.network
         try:
             # Verify that the extension exists.
@@ -490,7 +527,7 @@ class SetNetworkSegmentRange(common.NeutronCommandWithExtraArgs):
 class ShowNetworkSegmentRange(command.ShowOne):
     _description = _("Display network segment range 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_segment_range',
@@ -499,7 +536,9 @@ class ShowNetworkSegmentRange(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         network_client = self.app.client_manager.network
         try:
             # Verify that the extension exists.

openstackclient/network/v2/network_service_provider.py

@@ -13,6 +13,10 @@
 
 """Network Service Providers Implementation"""
 
+import argparse
+from collections.abc import Iterable
+from typing import Any
+
 from osc_lib import utils
 
 from openstackclient import command
@@ -22,7 +26,9 @@ from openstackclient.i18n import _
 class ListNetworkServiceProvider(command.Lister):
     _description = _("List Service Providers")
 
-    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 = (

openstackclient/network/v2/network_trunk.py

@@ -16,10 +16,13 @@
 
 """Network trunk and subports action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
-import typing as ty
+from typing import Any
 
 from cliff import columns as cliff_columns
+from openstack.network.v2 import trunk as _trunk
 from osc_lib.cli import format_columns
 from osc_lib.cli import identity as identity_utils
 from osc_lib.cli import parseractions
@@ -37,14 +40,14 @@ SUB_PORTS = 'sub_ports'
 
 
 class AdminStateColumn(cliff_columns.FormattableColumn[bool]):
-    def human_readable(self):
+    def human_readable(self) -> str:
         return 'UP' if self._value else 'DOWN'
 
 
 class CreateNetworkTrunk(command.ShowOne):
     """Create a network trunk for a given 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(
             'name', metavar='<name>', help=_("Name of the trunk to create")
@@ -87,7 +90,9 @@ class CreateNetworkTrunk(command.ShowOne):
         identity_utils.add_project_owner_option_to_parser(parser)
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         network_client = self.app.client_manager.network
         identity_client = self.app.client_manager.identity
         attrs = _get_attrs_for_trunk(
@@ -104,7 +109,7 @@ class CreateNetworkTrunk(command.ShowOne):
 class DeleteNetworkTrunk(command.Command):
     """Delete a given network trunk"""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'trunk',
@@ -114,7 +119,7 @@ class DeleteNetworkTrunk(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         network_client = self.app.client_manager.network
         result = 0
         for trunk in parsed_args.trunk:
@@ -145,7 +150,7 @@ class DeleteNetworkTrunk(command.Command):
 class ListNetworkTrunk(command.Lister):
     """List all network trunks"""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--long',
@@ -155,7 +160,9 @@ class ListNetworkTrunk(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         network_client = self.app.client_manager.network
         data = network_client.trunks()
         headers: tuple[str, ...] = ('ID', 'Name', 'Parent Port', 'Description')
@@ -184,7 +191,7 @@ class ListNetworkTrunk(command.Lister):
 class SetNetworkTrunk(command.Command):
     """Set network trunk 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(
             'trunk', metavar="<trunk>", help=_("Trunk to modify (name or ID)")
@@ -220,7 +227,7 @@ class SetNetworkTrunk(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         network_client = self.app.client_manager.network
         identity_client = self.app.client_manager.identity
         trunk_id = network_client.find_trunk(
@@ -255,14 +262,16 @@ class SetNetworkTrunk(command.Command):
 class ShowNetworkTrunk(command.ShowOne):
     """Show information of a given network trunk"""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'trunk', metavar="<trunk>", help=_("Trunk to display (name or ID)")
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         network_client = self.app.client_manager.network
         trunk_id = network_client.find_trunk(
             parsed_args.trunk,
@@ -279,7 +288,7 @@ class ShowNetworkTrunk(command.ShowOne):
 class ListNetworkSubport(command.Lister):
     """List all subports for a given network trunk"""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--trunk',
@@ -289,7 +298,9 @@ class ListNetworkSubport(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]:
         network_client = self.app.client_manager.network
         trunk_id = network_client.find_trunk(
             parsed_args.trunk,
@@ -321,7 +332,7 @@ class ListNetworkSubport(command.Lister):
 class UnsetNetworkTrunk(command.Command):
     """Unset subports from a given network trunk"""
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'trunk',
@@ -341,7 +352,7 @@ class UnsetNetworkTrunk(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         network_client = self.app.client_manager.network
         attrs = _get_attrs_for_subports(network_client, parsed_args)
         trunk_id = network_client.find_trunk(
@@ -357,15 +368,19 @@ _formatters = {
 }
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _trunk.Trunk,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return osc_utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
 
 
-def _get_attrs_for_trunk(network_client, identity_client, parsed_args):
-    attrs: dict[str, ty.Any] = {}
+def _get_attrs_for_trunk(
+    network_client: Any, identity_client: Any, parsed_args: argparse.Namespace
+) -> dict[str, Any]:
+    attrs: dict[str, Any] = {}
     if parsed_args.name is not None:
         attrs['name'] = str(parsed_args.name)
     if parsed_args.description is not None:
@@ -392,12 +407,14 @@ def _get_attrs_for_trunk(network_client, identity_client, parsed_args):
             parsed_args.project,
             parsed_args.project_domain,
         ).id
-        attrs['tenant_id'] = project_id
+        attrs['project_id'] = project_id
 
     return attrs
 
 
-def _format_subports(network_client, subports):
+def _format_subports(
+    network_client: Any, subports: list[dict[str, Any]]
+) -> list[dict[str, Any]]:
     attrs = []
     for subport in subports:
         subport_attrs = {}
@@ -424,7 +441,9 @@ def _format_subports(network_client, subports):
     return attrs
 
 
-def _get_attrs_for_subports(network_client, parsed_args):
+def _get_attrs_for_subports(
+    network_client: Any, parsed_args: argparse.Namespace
+) -> list[dict[str, Any]]:
     attrs = []
     if 'set_subports' in parsed_args and parsed_args.set_subports is not None:
         attrs = _format_subports(network_client, parsed_args.set_subports)