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

openstackclient/network/v2/network_flavor_profile.py

@@ -11,19 +11,26 @@
 #   under the License.
 #
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import service_profile as _service_profile
 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: _service_profile.ServiceProfile,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'is_enabled': 'enabled',
     }
@@ -34,8 +41,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] = {}
     if parsed_args.description is not None:
         attrs['description'] = parsed_args.description
     if parsed_args.driver is not None:
@@ -50,14 +59,12 @@ def _get_attrs(client_manager, parsed_args):
     return attrs
 
 
-# TODO(ndahiwade): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class CreateNetworkFlavorProfile(
     command.ShowOne, common.NeutronCommandWithExtraArgs
 ):
     _description = _("Create new network flavor profile")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--description',
@@ -92,7 +99,9 @@ class CreateNetworkFlavorProfile(
 
         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(
@@ -113,7 +122,7 @@ class CreateNetworkFlavorProfile(
 class DeleteNetworkFlavorProfile(command.Command):
     _description = _("Delete network flavor profile")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -124,7 +133,7 @@ class DeleteNetworkFlavorProfile(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
 
@@ -154,7 +163,14 @@ class DeleteNetworkFlavorProfile(command.Command):
 class ListNetworkFlavorProfile(command.Lister):
     _description = _("List network flavor profile(s)")
 
-    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 = (
@@ -172,7 +188,16 @@ class ListNetworkFlavorProfile(command.Lister):
             'Description',
         )
 
-        data = client.service_profiles()
+        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.service_profiles(**filters)
+
         return (
             column_headers,
             (
@@ -185,12 +210,10 @@ class ListNetworkFlavorProfile(command.Lister):
         )
 
 
-# TODO(ndahiwade): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetNetworkFlavorProfile(common.NeutronCommandWithExtraArgs):
     _description = _("Set network flavor profile 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_profile',
@@ -230,7 +253,7 @@ class SetNetworkFlavorProfile(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_service_profile(
             parsed_args.flavor_profile, ignore_missing=False
@@ -246,7 +269,7 @@ class SetNetworkFlavorProfile(common.NeutronCommandWithExtraArgs):
 class ShowNetworkFlavorProfile(command.ShowOne):
     _description = _("Display network flavor profile 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_profile',
@@ -255,7 +278,9 @@ class ShowNetworkFlavorProfile(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_service_profile(
             parsed_args.flavor_profile, ignore_missing=False

openstackclient/network/v2/network_meter.py

@@ -13,12 +13,17 @@
 
 """Metering Label Implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import metering_label as _metering_label
 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: _metering_label.MeteringLabel,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'is_shared': 'shared',
     }
@@ -36,8 +43,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] = {}
 
     if parsed_args.description is not None:
         attrs['description'] = parsed_args.description
@@ -59,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 CreateMeter(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create network meter")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -99,7 +106,9 @@ class CreateMeter(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(
@@ -112,12 +121,10 @@ class CreateMeter(command.ShowOne, common.NeutronCommandWithExtraArgs):
         return (display_columns, data)
 
 
-# TODO(ankur-gupta-f): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class DeleteMeter(command.Command):
     _description = _("Delete network meter")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
 
         parser.add_argument(
@@ -128,7 +135,7 @@ class DeleteMeter(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
 
@@ -154,7 +161,14 @@ class DeleteMeter(command.Command):
 class ListMeter(command.Lister):
     _description = _("List network meters")
 
-    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 = (
@@ -170,7 +184,15 @@ class ListMeter(command.Lister):
             'Shared',
         )
 
-        data = client.metering_labels()
+        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.metering_labels(**filters)
         return (
             column_headers,
             (
@@ -186,14 +208,16 @@ class ListMeter(command.Lister):
 class ShowMeter(command.ShowOne):
     _description = _("Show network meter")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'meter', metavar='<meter>', help=_('Meter 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]]:
         client = self.app.client_manager.network
         obj = client.find_metering_label(
             parsed_args.meter, ignore_missing=False

openstackclient/network/v2/network_meter_rule.py

@@ -13,13 +13,17 @@
 
 """Meter Rule Implementations"""
 
+import argparse
 import logging
-import typing as ty
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import metering_label_rule as _metering_label_rule
 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
@@ -27,15 +31,19 @@ from openstackclient.network import common
 LOG = logging.getLogger(__name__)
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _metering_label_rule.MeteringLabelRule,
+) -> 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: dict[str, ty.Any] = {}
+def _get_attrs(
+    client_manager: Any, parsed_args: argparse.Namespace
+) -> dict[str, Any]:
+    attrs: dict[str, Any] = {}
 
     if parsed_args.exclude:
         attrs['excluded'] = True
@@ -68,7 +76,7 @@ def _get_attrs(client_manager, parsed_args):
 class CreateMeterRule(command.ShowOne, common.NeutronCommandWithExtraArgs):
     _description = _("Create a new meter 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(
@@ -125,7 +133,9 @@ class CreateMeterRule(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
         _meter = client.find_metering_label(
             parsed_args.meter, ignore_missing=False
@@ -145,7 +155,7 @@ class CreateMeterRule(command.ShowOne, common.NeutronCommandWithExtraArgs):
 class DeleteMeterRule(command.Command):
     _description = _("Delete meter rule(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(
@@ -157,7 +167,7 @@ class DeleteMeterRule(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
 
@@ -183,7 +193,14 @@ class DeleteMeterRule(command.Command):
 class ListMeterRule(command.Lister):
     _description = _("List meter rules")
 
-    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 = (
@@ -202,7 +219,16 @@ class ListMeterRule(command.Lister):
             'Source IP Prefix',
             'Destination IP Prefix',
         )
-        data = client.metering_label_rules()
+
+        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.metering_label_rules(**filters)
         return (
             column_headers,
             (
@@ -218,7 +244,7 @@ class ListMeterRule(command.Lister):
 class ShowMeterRule(command.ShowOne):
     _description = _("Display meter rules 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(
             'meter_rule_id',
@@ -227,7 +253,9 @@ class ShowMeterRule(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_metering_label_rule(
             parsed_args.meter_rule_id, ignore_missing=False

openstackclient/network/v2/network_qos_policy.py

@@ -13,14 +13,18 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+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 qos_policy as _qos_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
@@ -28,8 +32,8 @@ from openstackclient.network import common
 LOG = logging.getLogger(__name__)
 
 
-class RulesColumn(cliff_columns.FormattableColumn[ty.Any]):
-    def human_readable(self):
+class RulesColumn(cliff_columns.FormattableColumn[Any]):
+    def human_readable(self) -> str:
         return '\n'.join(str(v) for v in self._value)
 
 
@@ -38,7 +42,9 @@ _formatters = {
 }
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _qos_policy.QoSPolicy,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map = {
         'is_shared': 'shared',
     }
@@ -48,7 +54,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 = {}
     if 'name' in parsed_args and parsed_args.name is not None:
         attrs['name'] = parsed_args.name
@@ -78,14 +86,12 @@ 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 CreateNetworkQosPolicy(
     command.ShowOne, common.NeutronCommandWithExtraArgs
 ):
     _description = _("Create a QoS 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(
             'name', metavar='<name>', help=_("Name of QoS policy to create")
@@ -129,7 +135,9 @@ class CreateNetworkQosPolicy(
         )
         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(
@@ -144,7 +152,7 @@ class CreateNetworkQosPolicy(
 class DeleteNetworkQosPolicy(command.Command):
     _description = _("Delete Qos 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(
             'policy',
@@ -154,7 +162,7 @@ class DeleteNetworkQosPolicy(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
 
@@ -180,12 +188,10 @@ class DeleteNetworkQosPolicy(command.Command):
             raise exceptions.CommandError(msg)
 
 
-# TODO(abhiraut): Use only the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class ListNetworkQosPolicy(command.Lister):
     _description = _("List QoS 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(
             '--project',
@@ -207,9 +213,12 @@ class ListNetworkQosPolicy(command.Lister):
             action='store_true',
             help=_("List only QoS policies not shared between projects"),
         )
+        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',
@@ -225,7 +234,16 @@ class ListNetworkQosPolicy(command.Lister):
             'Default',
             'Project',
         )
+
         attrs = _get_attrs(self.app.client_manager, 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.qos_policies(**attrs)
         return (
             column_headers,
@@ -240,12 +258,10 @@ class ListNetworkQosPolicy(command.Lister):
         )
 
 
-# TODO(abhiraut): Use the SDK resource mapped attribute names once the
-# OSC minimum requirements include SDK 1.0.
 class SetNetworkQosPolicy(common.NeutronCommandWithExtraArgs):
     _description = _("Set QoS 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(
             'policy',
@@ -284,7 +300,7 @@ class SetNetworkQosPolicy(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_qos_policy(parsed_args.policy, ignore_missing=False)
         attrs = _get_attrs(self.app.client_manager, parsed_args)
@@ -297,7 +313,7 @@ class SetNetworkQosPolicy(common.NeutronCommandWithExtraArgs):
 class ShowNetworkQosPolicy(command.ShowOne):
     _description = _("Display QoS 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(
             'policy',
@@ -306,7 +322,9 @@ class ShowNetworkQosPolicy(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_qos_policy(parsed_args.policy, ignore_missing=False)
         display_columns, columns = _get_columns(obj)