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

openstackclient/network/v2/taas/tap_mirror.py

@@ -10,8 +10,12 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import tap_mirror as _tap_mirror
 from osc_lib.cli import identity as identity_utils
 from osc_lib import exceptions
 from osc_lib import utils as osc_utils
@@ -39,7 +43,9 @@ _attr_map = [
 ]
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _tap_mirror.TapMirror,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map: dict[str, str] = {}
     hidden_columns = ['location', 'tenant_id']
     return osc_utils.get_osc_show_columns_for_sdk_resource(
@@ -50,7 +56,7 @@ def _get_columns(item):
 class CreateTapMirror(command.ShowOne):
     _description = _("Create a new tap mirror.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         identity_utils.add_project_owner_option_to_parser(parser)
         tap_service._add_updatable_args(parser)
@@ -88,7 +94,9 @@ class CreateTapMirror(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
         attrs = {}
         if parsed_args.name is not None:
@@ -113,7 +121,7 @@ class CreateTapMirror(command.ShowOne):
                 parsed_args.project_domain,
             ).id
         obj = client.create_tap_mirror(**attrs)
-        display_columns, columns = tap_service._get_columns(obj)
+        display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(obj, columns)
         return display_columns, data
 
@@ -121,13 +129,15 @@ class CreateTapMirror(command.ShowOne):
 class ListTapMirror(command.Lister):
     _description = _("List tap mirrors.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         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[tuple[Any, ...]]]:
         client = self.app.client_manager.network
         params = {}
         if parsed_args.project is not None:
@@ -149,7 +159,7 @@ class ListTapMirror(command.Lister):
 class ShowTapMirror(command.ShowOne):
     _description = _("Show tap mirror 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(
             TAP_MIRROR,
@@ -158,13 +168,15 @@ class ShowTapMirror(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
         id = client.find_tap_mirror(
             parsed_args.tap_mirror, ignore_missing=False
         ).id
         obj = client.get_tap_mirror(id)
-        display_columns, columns = tap_service._get_columns(obj)
+        display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(obj, columns)
         return display_columns, data
 
@@ -172,7 +184,7 @@ class ShowTapMirror(command.ShowOne):
 class DeleteTapMirror(command.Command):
     _description = _("Delete a tap mirror.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             TAP_MIRROR,
@@ -182,7 +194,7 @@ class DeleteTapMirror(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
         fails = 0
         for id_or_name in parsed_args.tap_mirror:
@@ -211,7 +223,7 @@ class DeleteTapMirror(command.Command):
 class UpdateTapMirror(command.ShowOne):
     _description = _("Update a tap mirror.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             TAP_MIRROR,
@@ -221,7 +233,9 @@ class UpdateTapMirror(command.ShowOne):
         tap_service._add_updatable_args(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
         original_t_s = client.find_tap_mirror(
             parsed_args.tap_mirror, ignore_missing=False
@@ -232,6 +246,6 @@ class UpdateTapMirror(command.ShowOne):
         if parsed_args.description is not None:
             attrs['description'] = parsed_args.description
         obj = client.update_tap_mirror(original_t_s, **attrs)
-        display_columns, columns = tap_service._get_columns(obj)
+        display_columns, columns = _get_columns(obj)
         data = osc_utils.get_dict_properties(obj, columns)
         return display_columns, data

openstackclient/network/v2/taas/tap_service.py

@@ -12,8 +12,12 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
+from openstack.network.v2 import tap_service as _tap_service
 from osc_lib.cli import identity as identity_utils
 from osc_lib import exceptions
 from osc_lib import utils as osc_utils
@@ -37,14 +41,16 @@ _attr_map = [
 ]
 
 
-def _add_updatable_args(parser):
+def _add_updatable_args(parser: argparse.ArgumentParser) -> None:
     parser.add_argument('--name', help=_('Name of the tap service.'))
     parser.add_argument(
         '--description', help=_('Description of the tap service.')
     )
 
 
-def _get_columns(item):
+def _get_columns(
+    item: _tap_service.TapService,
+) -> tuple[tuple[str, ...], tuple[str, ...]]:
     column_map: dict[str, str] = {}
     hidden_columns = ['location', 'tenant_id']
     return osc_utils.get_osc_show_columns_for_sdk_resource(
@@ -55,7 +61,7 @@ def _get_columns(item):
 class CreateTapService(command.ShowOne):
     _description = _("Create a new tap service.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         identity_utils.add_project_owner_option_to_parser(parser)
         _add_updatable_args(parser)
@@ -68,7 +74,9 @@ class CreateTapService(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
         attrs = {}
         if parsed_args.name is not None:
@@ -95,13 +103,15 @@ class CreateTapService(command.ShowOne):
 class ListTapService(command.Lister):
     _description = _("List tap services.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         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[tuple[Any, ...]]]:
         client = self.app.client_manager.network
         params = {}
         if parsed_args.project is not None:
@@ -123,7 +133,7 @@ class ListTapService(command.Lister):
 class ShowTapService(command.ShowOne):
     _description = _("Show tap service 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(
             TAP_SERVICE,
@@ -132,7 +142,9 @@ class ShowTapService(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
         id = client.find_tap_service(
             parsed_args.tap_service, ignore_missing=False
@@ -146,7 +158,7 @@ class ShowTapService(command.ShowOne):
 class DeleteTapService(command.Command):
     _description = _("Delete a tap service.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             TAP_SERVICE,
@@ -156,7 +168,7 @@ class DeleteTapService(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
         fails = 0
         for id_or_name in parsed_args.tap_service:
@@ -185,7 +197,7 @@ class DeleteTapService(command.Command):
 class UpdateTapService(command.ShowOne):
     _description = _("Update a tap service.")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             TAP_SERVICE,
@@ -195,7 +207,9 @@ class UpdateTapService(command.ShowOne):
         _add_updatable_args(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
         original_t_s = client.find_tap_service(
             parsed_args.tap_service, ignore_missing=False

openstackclient/object/client.py

@@ -15,6 +15,9 @@
 
 """Object client"""
 
+import argparse
+from typing import Any
+
 from osc_lib import utils
 
 from openstackclient.api import object_store_v1
@@ -26,7 +29,7 @@ API_NAME = 'object_store'
 API_VERSIONS = ('1',)
 
 
-def make_client(instance):
+def make_client(instance: Any) -> object_store_v1.APIv1:
     """Returns an object-store API client."""
 
     endpoint = instance.get_endpoint_for_service_type(
@@ -43,7 +46,9 @@ def make_client(instance):
     return client
 
 
-def build_option_parser(parser):
+def build_option_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
     """Hook to add global options"""
     parser.add_argument(
         '--os-object-api-version',

openstackclient/object/v1/account.py

@@ -13,6 +13,10 @@
 
 """Account v1 action implementations"""
 
+import argparse
+from collections.abc import Iterable, Sequence
+from typing import Any
+
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
 
@@ -23,7 +27,7 @@ from openstackclient.i18n import _
 class SetAccount(command.Command):
     _description = _("Set account 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(
             "--property",
@@ -37,7 +41,7 @@ class SetAccount(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.account_set(
             properties=parsed_args.property,
         )
@@ -46,19 +50,22 @@ class SetAccount(command.Command):
 class ShowAccount(command.ShowOne):
     _description = _("Display account details")
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         data = self.app.client_manager.object_store.account_show()
         if 'properties' in data:
             data['properties'] = format_columns.DictColumn(
                 data.pop('properties')
             )
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class UnsetAccount(command.Command):
     _description = _("Unset account 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(
             '--property',
@@ -73,7 +80,7 @@ class UnsetAccount(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.account_unset(
             properties=parsed_args.property,
         )

openstackclient/object/v1/container.py

@@ -15,7 +15,10 @@
 
 """Container v1 action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -31,7 +34,7 @@ LOG = logging.getLogger(__name__)
 class CreateContainer(command.Lister):
     _description = _("Create new container")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--public',
@@ -51,7 +54,9 @@ class CreateContainer(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         results = []
         for container in parsed_args.containers:
             if len(container) > 256:
@@ -84,7 +89,7 @@ class CreateContainer(command.Lister):
 class DeleteContainer(command.Command):
     _description = _("Delete container")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             '--recursive',
@@ -101,7 +106,7 @@ class DeleteContainer(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         for container in parsed_args.containers:
             if parsed_args.recursive:
                 objs = self.app.client_manager.object_store.object_list(
@@ -120,14 +125,16 @@ class DeleteContainer(command.Command):
 class ListContainer(command.Lister):
     _description = _("List containers")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--prefix",
             metavar="<prefix>",
             help=_("Filter list using <prefix>"),
         )
-        pagination.add_marker_pagination_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(
+            parser, include_max_items=False
+        )
         parser.add_argument(
             "--end-marker",
             metavar="<end-marker>",
@@ -147,7 +154,9 @@ class ListContainer(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         columns: tuple[str, ...] = ('Name',)
         if parsed_args.long:
             columns += ('Bytes', 'Count')
@@ -182,7 +191,7 @@ class ListContainer(command.Lister):
 class SaveContainer(command.Command):
     _description = _("Save container contents locally")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'container',
@@ -191,7 +200,7 @@ class SaveContainer(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.container_save(
             container=parsed_args.container,
         )
@@ -200,7 +209,7 @@ class SaveContainer(command.Command):
 class SetContainer(command.Command):
     _description = _("Set container 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(
             'container',
@@ -219,7 +228,7 @@ class SetContainer(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.container_set(
             parsed_args.container,
             properties=parsed_args.property,
@@ -229,7 +238,7 @@ class SetContainer(command.Command):
 class ShowContainer(command.ShowOne):
     _description = _("Display container 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(
             'container',
@@ -238,20 +247,23 @@ class ShowContainer(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         data = self.app.client_manager.object_store.container_show(
             container=parsed_args.container,
         )
         if 'properties' in data:
             data['properties'] = format_columns.DictColumn(data['properties'])
 
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class UnsetContainer(command.Command):
     _description = _("Unset container 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(
             'container',
@@ -271,7 +283,7 @@ class UnsetContainer(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.container_unset(
             parsed_args.container,
             properties=parsed_args.property,

openstackclient/object/v1/object.py

@@ -15,7 +15,10 @@
 
 """Object v1 action implementations"""
 
+import argparse
 import logging
+from collections.abc import Iterable, Sequence
+from typing import Any
 
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -33,7 +36,7 @@ LOG = logging.getLogger(__name__)
 class CreateObject(command.Lister):
     _description = _("Upload object to container")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'container',
@@ -56,7 +59,9 @@ class CreateObject(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         if parsed_args.name:
             if len(parsed_args.objects) > 1:
                 msg = _(
@@ -98,7 +103,7 @@ class CreateObject(command.Lister):
 class DeleteObject(command.Command):
     _description = _("Delete object from container")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             'container',
@@ -113,7 +118,7 @@ class DeleteObject(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         for obj in parsed_args.objects:
             self.app.client_manager.object_store.object_delete(
                 container=parsed_args.container,
@@ -124,7 +129,7 @@ class DeleteObject(command.Command):
 class ListObject(command.Lister):
     _description = _("List objects")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "container",
@@ -141,7 +146,9 @@ class ListObject(command.Lister):
             metavar="<delimiter>",
             help=_("Roll up items with <delimiter>"),
         )
-        pagination.add_marker_pagination_option_to_parser(parser)
+        pagination.add_marker_pagination_option_to_parser(
+            parser, include_max_items=False
+        )
         parser.add_argument(
             "--end-marker",
             metavar="<end-marker>",
@@ -161,7 +168,9 @@ class ListObject(command.Lister):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[tuple[Any, ...]]]:
         columns: tuple[str, ...] = ('Name',)
         if parsed_args.long:
             columns += ('Bytes', 'Hash', 'Content Type', 'Last Modified')
@@ -200,7 +209,7 @@ class ListObject(command.Lister):
 class SaveObject(command.Command):
     _description = _("Save object locally")
 
-    def get_parser(self, prog_name):
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
         parser = super().get_parser(prog_name)
         parser.add_argument(
             "--file",
@@ -222,7 +231,7 @@ class SaveObject(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.object_save(
             container=parsed_args.container,
             object=parsed_args.object,
@@ -233,7 +242,7 @@ class SaveObject(command.Command):
 class SetObject(command.Command):
     _description = _("Set object 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(
             'container',
@@ -257,7 +266,7 @@ class SetObject(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.object_set(
             parsed_args.container,
             parsed_args.object,
@@ -268,7 +277,7 @@ class SetObject(command.Command):
 class ShowObject(command.ShowOne):
     _description = _("Display object 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(
             'container',
@@ -282,7 +291,9 @@ class ShowObject(command.ShowOne):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(
+        self, parsed_args: argparse.Namespace
+    ) -> tuple[Sequence[str], Iterable[Any]]:
         data = self.app.client_manager.object_store.object_show(
             container=parsed_args.container,
             object=parsed_args.object,
@@ -290,13 +301,14 @@ class ShowObject(command.ShowOne):
         if 'properties' in data:
             data['properties'] = format_columns.DictColumn(data['properties'])
 
-        return zip(*sorted(data.items()))
+        col_headers, col_data = zip(*sorted(data.items()))
+        return col_headers, col_data
 
 
 class UnsetObject(command.Command):
     _description = _("Unset object 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(
             'container',
@@ -321,7 +333,7 @@ class UnsetObject(command.Command):
         )
         return parser
 
-    def take_action(self, parsed_args):
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
         self.app.client_manager.object_store.object_unset(
             parsed_args.container,
             parsed_args.object,