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

openstackclient/network/v2/network_qos_rule.py

@@ -13,8 +13,18 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import argparse
+from collections.abc import Iterable, Sequence
 import itertools
-
+from typing import Any, cast
+
+from openstack.network.v2 import (
+    qos_bandwidth_limit_rule as _qos_bandwidth_limit_rule,
+    qos_dscp_marking_rule as _qos_dscp_marking_rule,
+    qos_minimum_bandwidth_rule as _qos_minimum_bandwidth_rule,
+    qos_minimum_packet_rate_rule as _qos_minimum_packet_rate_rule,
+    qos_packet_rate_limit_rule as _qos_packet_rate_limit_rule,
+)
 from osc_lib import exceptions
 from osc_lib import utils
 
@@ -72,14 +82,24 @@ ACTION_SET = 'update'
 ACTION_SHOW = 'get'
 
 
-def _get_columns(item):
+def _get_columns(
+    item: (
+        _qos_bandwidth_limit_rule.QoSBandwidthLimitRule
+        | _qos_dscp_marking_rule.QoSDSCPMarkingRule
+        | _qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule
+        | _qos_minimum_packet_rate_rule.QoSMinimumPacketRateRule
+        | _qos_packet_rate_limit_rule.QoSPacketRateLimitRule
+    ),
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'name', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
     )
 
 
-def _check_type_parameters(attrs, type, is_create):
+def _check_type_parameters(
+    attrs: dict[str, Any], type: str, is_create: bool
+) -> None:
     req_params = MANDATORY_PARAMETERS[type]
     opt_params = OPTIONAL_PARAMETERS[type]
     type_params = req_params | opt_params
@@ -102,7 +122,11 @@ def _check_type_parameters(attrs, type, is_create):
         raise exceptions.CommandError(msg)
 
 
-def _get_attrs(network_client, parsed_args, is_create=False):
+def _get_attrs(
+    network_client: Any,
+    parsed_args: argparse.Namespace,
+    is_create: bool = False,
+) -> dict[str, Any]:
     attrs = {}
     qos = network_client.find_qos_policy(
         parsed_args.qos_policy, ignore_missing=False
@@ -148,19 +172,19 @@ def _get_attrs(network_client, parsed_args, is_create=False):
     return attrs
 
 
-def _rule_action_call(client, action, rule_type):
+def _rule_action_call(client: Any, action: str, rule_type: str) -> Any:
     rule_type = rule_type.replace('-', '_')
     func_name = f'{action}_qos_{rule_type}_rule'
     return getattr(client, func_name)
 
 
-def _find_rule_type(qos, rule_id):
+def _find_rule_type(qos: Any, rule_id: str) -> str | None:
     for rule in (r for r in qos.rules if r['id'] == rule_id):
-        return rule['type'].replace('_', '-')
+        return cast(str, rule['type']).replace('_', '-')
     return None
 
 
-def _add_rule_arguments(parser):
+def _add_rule_arguments(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         '--max-kbps',
         dest='max_kbps',
@@ -230,7 +254,7 @@ class CreateNetworkQosRule(
 ):
     _description = _("Create new Network QoS rule")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'qos_policy',
@@ -255,7 +279,9 @@ class CreateNetworkQosRule(
         _add_rule_arguments(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
         try:
             attrs = _get_attrs(network_client, parsed_args, is_create=True)
@@ -276,7 +302,7 @@ class CreateNetworkQosRule(
 class DeleteNetworkQosRule(command.Command):
     _description = _("Delete Network QoS rule")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'qos_policy',
@@ -290,7 +316,7 @@ class DeleteNetworkQosRule(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
         rule_id = parsed_args.id
         try:
@@ -313,7 +339,7 @@ class DeleteNetworkQosRule(command.Command):
 class ListNetworkQosRule(command.Lister):
     _description = _("List Network QoS rules")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'qos_policy',
@@ -322,7 +348,9 @@ class ListNetworkQosRule(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',
@@ -359,7 +387,7 @@ class ListNetworkQosRule(command.Lister):
 class SetNetworkQosRule(common.NeutronCommandWithExtraArgs):
     _description = _("Set Network QoS rule 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(
             'qos_policy',
@@ -374,7 +402,7 @@ class SetNetworkQosRule(common.NeutronCommandWithExtraArgs):
         _add_rule_arguments(parser)
         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:
             qos = network_client.find_qos_policy(
@@ -405,7 +433,7 @@ class SetNetworkQosRule(common.NeutronCommandWithExtraArgs):
 class ShowNetworkQosRule(command.ShowOne):
     _description = _("Display Network QoS rule 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(
             'qos_policy',
@@ -419,7 +447,9 @@ class ShowNetworkQosRule(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
         rule_id = parsed_args.id
         try:

openstackclient/network/v2/network_qos_rule_type.py

@@ -13,13 +13,21 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
+from openstack.network.v2 import qos_rule_type as _qos_rule_type
 from osc_lib import utils
 
 from openstackclient import command
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _qos_rule_type.QoSRuleType,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         "type": "rule_type_name",
         "drivers": "drivers",
@@ -33,7 +41,7 @@ def _get_columns(item):
 class ListNetworkQosRuleType(command.Lister):
     _description = _("List QoS rule types")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         supported = parser.add_mutually_exclusive_group()
         supported.add_argument(
@@ -52,19 +60,28 @@ class ListNetworkQosRuleType(command.Lister):
                 "List all QoS rule types implemented in Neutron QoS driver"
             ),
         )
+        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 = ('type',)
         column_headers = ('Type',)
 
-        args = {}
+        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
         if parsed_args.all_supported:
-            args['all_supported'] = True
+            filters['all_supported'] = True
         elif parsed_args.all_rules:
-            args['all_rules'] = True
-        data = client.qos_rule_types(**args)
+            filters['all_rules'] = True
+        data = client.qos_rule_types(**filters)
 
         return (
             column_headers,
@@ -82,7 +99,7 @@ class ListNetworkQosRuleType(command.Lister):
 class ShowNetworkQosRuleType(command.ShowOne):
     _description = _("Show details about supported QoS rule type")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'rule_type',
@@ -91,7 +108,9 @@ class ShowNetworkQosRuleType(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_qos_rule_type(parsed_args.rule_type)
         display_columns, columns = _get_columns(obj)

openstackclient/network/v2/network_rbac.py

@@ -13,12 +13,17 @@
 
 """RBAC action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack.network.v2 import rbac_policy as _rbac_policy
 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: _rbac_policy.RBACPolicy,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'target_tenant': 'target_project_id',
     }
@@ -36,7 +43,9 @@ def _get_columns(item):
     )
 
 
-def _get_attrs(client_manager, parsed_args):
+def _get_attrs(
+    client_manager: Any, parsed_args: argparse.Namespace
+) -> dict[str, Any]:
     attrs = {}
     attrs['object_type'] = parsed_args.type
     attrs['action'] = parsed_args.action
@@ -90,12 +99,10 @@ def _get_attrs(client_manager, parsed_args):
     return attrs
 
 
-# TODO(abhiraut): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class CreateNetworkRBAC(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create network RBAC policy")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'rbac_object',
@@ -166,7 +173,9 @@ class CreateNetworkRBAC(command.ShowOne, common.NeutronCommandWithExtraArgs):
         identity_common.add_project_domain_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]]:
         client = self.app.client_manager.network
         attrs = _get_attrs(self.app.client_manager, parsed_args)
         attrs.update(
@@ -181,7 +190,7 @@ class CreateNetworkRBAC(command.ShowOne, common.NeutronCommandWithExtraArgs):
 class DeleteNetworkRBAC(command.Command):
     _description = _("Delete network RBAC policy(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(
             'rbac_policy',
@@ -191,7 +200,7 @@ class DeleteNetworkRBAC(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
 
@@ -220,7 +229,7 @@ class DeleteNetworkRBAC(command.Command):
 class ListNetworkRBAC(command.Lister):
     _description = _("List network RBAC policies")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--type',
@@ -263,9 +272,12 @@ class ListNetworkRBAC(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, ...] = (
@@ -297,6 +309,12 @@ class ListNetworkRBAC(command.Lister):
                     parsed_args.target_project,
                 ).id
             query['target_project_id'] = project_id
+        if parsed_args.marker is not None:
+            query['marker'] = parsed_args.marker
+        if parsed_args.limit is not None:
+            query['limit'] = parsed_args.limit
+        if parsed_args.max_items is not None:
+            query['max_items'] = parsed_args.max_items
 
         data = client.rbac_policies(**query)
 
@@ -312,12 +330,10 @@ class ListNetworkRBAC(command.Lister):
         )
 
 
-# TODO(abhiraut): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetNetworkRBAC(common.NeutronCommandWithExtraArgs):
     _description = _("Set network RBAC policy 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(
             'rbac_policy',
@@ -343,7 +359,7 @@ class SetNetworkRBAC(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_rbac_policy(
             parsed_args.rbac_policy, ignore_missing=False
@@ -366,7 +382,7 @@ class SetNetworkRBAC(common.NeutronCommandWithExtraArgs):
 class ShowNetworkRBAC(command.ShowOne):
     _description = _("Display network RBAC policy 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(
             'rbac_policy',
@@ -375,7 +391,9 @@ class ShowNetworkRBAC(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_rbac_policy(
             parsed_args.rbac_policy, ignore_missing=False

openstackclient/network/v2/network_segment.py

@@ -13,19 +13,26 @@
 
 """Network segment action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
 import logging
+from typing import Any
 
+from openstack.network.v2 import segment as _segment
 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.network import common
 
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _segment.Segment,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     hidden_columns = ['location', 'tenant_id']
     return utils.get_osc_show_columns_for_sdk_resource(
         item, {}, hidden_columns
@@ -37,7 +44,7 @@ class CreateNetworkSegment(
 ):
     _description = _("Create new network segment")
 
-    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 network segment name')
@@ -81,7 +88,9 @@ class CreateNetworkSegment(
         )
         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 = {}
         attrs['name'] = parsed_args.name
@@ -107,7 +116,7 @@ class CreateNetworkSegment(
 class DeleteNetworkSegment(command.Command):
     _description = _("Delete network segment(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',
@@ -117,7 +126,7 @@ class DeleteNetworkSegment(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
@@ -148,7 +157,7 @@ class DeleteNetworkSegment(command.Command):
 class ListNetworkSegment(command.Lister):
     _description = _("List network segments")
 
-    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',
@@ -164,9 +173,12 @@ class ListNetworkSegment(command.Lister):
                 'network (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, ...]]]:
         network_client = self.app.client_manager.network
 
         filters = {}
@@ -175,6 +187,13 @@ class ListNetworkSegment(command.Lister):
                 parsed_args.network, ignore_missing=False
             )
             filters = {'network_id': _network.id}
+        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.segments(**filters)
 
         headers: tuple[str, ...] = (
@@ -211,7 +230,7 @@ class ListNetworkSegment(command.Lister):
 class SetNetworkSegment(common.NeutronCommandWithExtraArgs):
     _description = _("Set network segment 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',
@@ -230,7 +249,7 @@ class SetNetworkSegment(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_segment(
             parsed_args.network_segment, ignore_missing=False
@@ -249,7 +268,7 @@ class SetNetworkSegment(common.NeutronCommandWithExtraArgs):
 class ShowNetworkSegment(command.ShowOne):
     _description = _("Display network segment 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',
@@ -258,7 +277,9 @@ class ShowNetworkSegment(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_segment(
             parsed_args.network_segment, ignore_missing=False