python-openstackclient 8.3.0__py3-none-any.whl → 10.0.0__py3-none-any.whl

openstackclient/network/v2/taas/tap_service.py

@@ -12,7 +12,10 @@
 #    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 osc_lib.cli import identity as identity_utils
 from osc_lib import exceptions
@@ -37,14 +40,14 @@ _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: Any) -> 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 +58,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 +71,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 +100,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 +130,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 +139,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 +155,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 +165,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 +194,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 +204,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,7 +125,7 @@ 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",
@@ -147,7 +152,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 +189,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 +198,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 +207,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 +226,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 +236,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 +245,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 +281,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",
@@ -161,7 +166,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 +207,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 +229,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 +240,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 +264,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 +275,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 +289,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 +299,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 +331,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,

openstackclient/shell.py

@@ -16,7 +16,9 @@
 
 """Command-line interface to the OpenStack APIs"""
 
+import argparse
 import sys
+from typing import Any
 import warnings
 
 from osc_lib.api import auth
@@ -31,14 +33,16 @@ DEFAULT_DOMAIN = 'default'
 # core OSC
 IGNORED_MODULES = (
     'neutron_taas.taas_client.osc',
+    'neutronclient.osc.v2.fwaas',
     'neutronclient.osc.v2.taas',
+    'neutronclient.osc.v2.networking_bgpvpn',
 )
 
 
 class OpenStackShell(shell.OpenStackShell):
     client_manager: clientmanager.ClientManager
 
-    def __init__(self):
+    def __init__(self) -> None:
         command_manager = commandmanager.CommandManager(
             'openstack.cli', ignored_modules=IGNORED_MODULES
         )
@@ -59,7 +63,12 @@ class OpenStackShell(shell.OpenStackShell):
         # about them
         warnings.filterwarnings('ignore', module='openstack')
 
-    def build_option_parser(self, description, version, argparse_kwargs=None):
+    def build_option_parser(
+        self,
+        description: str | None,
+        version: str | None,
+        argparse_kwargs: dict[str, Any] | None = None,
+    ) -> argparse.ArgumentParser:
         parser = super().build_option_parser(
             description, version, argparse_kwargs
         )
@@ -67,7 +76,7 @@ class OpenStackShell(shell.OpenStackShell):
         parser = auth.build_auth_plugins_option_parser(parser)
         return parser
 
-    def _final_defaults(self):
+    def _final_defaults(self) -> None:
         super()._final_defaults()
 
         # Set the default plugin to admin_token if endpoint and token are given
@@ -77,7 +86,7 @@ class OpenStackShell(shell.OpenStackShell):
         else:
             self._auth_type = 'password'
 
-    def _load_plugins(self):
+    def _load_plugins(self) -> None:
         """Load plugins via stevedore."""
         # Loop through extensions to get API versions
         for mod in clientmanager.PLUGIN_MODULES:
@@ -128,16 +137,43 @@ class OpenStackShell(shell.OpenStackShell):
                             },
                         )
 
-                # Command groups deal only with major versions
-                version = '.v' + version_opt.replace('.', '_').split('_')[0]
-                cmd_group = 'openstack.' + api.replace('-', '_') + version
+                # Build our command group which we expect to look like:
+                #
+                #   openstack.<service>.vN
+                #
+                # Note that command groups deal only with major versions
+                cmd_group = '.'.join(
+                    [
+                        'openstack',
+                        api.replace('-', '_'),
+                        'v' + version_opt.replace('.', '_').split('_')[0],
+                    ]
+                )
                 self.command_manager.add_command_group(cmd_group)
                 self.log.debug(
                     '%(name)s API version %(version)s, cmd group %(group)s',
                     {'name': api, 'version': version_opt, 'group': cmd_group},
                 )
 
-    def _load_commands(self):
+                mod_extensions = getattr(mod, 'API_EXTENSIONS', None)
+                if not mod_extensions:
+                    continue
+
+                for extension in mod_extensions:
+                    extension_cmd_group = '.'.join([cmd_group, extension])
+                    self.command_manager.add_command_group(extension_cmd_group)
+                    self.log.debug(
+                        '%(name)s API version %(version)s '
+                        '(%(extension)s extension), cmd group %(group)s',
+                        {
+                            'name': api,
+                            'version': version_opt,
+                            'extension': extension,
+                            'group': cmd_group,
+                        },
+                    )
+
+    def _load_commands(self) -> None:
         """Load commands via cliff/stevedore
 
         osc-lib has no opinion on what commands should be loaded
@@ -157,7 +193,7 @@ class OpenStackShell(shell.OpenStackShell):
         # }
         self.command_manager.add_command_group('openstack.extension')
 
-    def initialize_app(self, argv):
+    def initialize_app(self, argv: list[str]) -> None:
         super().initialize_app(argv)
 
         # Re-create the client_manager with our subclass
@@ -168,7 +204,7 @@ class OpenStackShell(shell.OpenStackShell):
         )
 
 
-def main(argv=None):
+def main(argv: list[str] | None = None) -> int:
     if argv is None:
         argv = sys.argv[1:]