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

openstackclient/api/compute_v2.py

@@ -64,7 +64,7 @@ def list_security_groups(compute_client, all_projects=None):
 
 
 def find_security_group(compute_client, name_or_id):
-    """Find the name for a given security group name or ID
+    """Find the security group for a given name or ID
 
     https://docs.openstack.org/api-ref/compute/#show-security-group-details
 
@@ -240,7 +240,7 @@ def list_networks(compute_client):
 
 
 def find_network(compute_client, name_or_id):
-    """Find the ID for a given network name or ID
+    """Find the network for a given name or ID
 
     https://docs.openstack.org/api-ref/compute/#show-network-details
 

openstackclient/api/object_store_v1.py

@@ -256,7 +256,10 @@ class APIv1(api.BaseAPI):
         # object's name in the container.
         object_name_str = name if name else object
 
-        full_url = f"{urllib.parse.quote(container)}/{urllib.parse.quote(object_name_str)}"
+        full_url = (
+            f"{urllib.parse.quote(container)}/"
+            f"{urllib.parse.quote(object_name_str)}"
+        )
         with open(object, 'rb') as f:
             response = self.create(
                 full_url,

openstackclient/api/volume_v2.py

@@ -0,0 +1,60 @@
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+
+"""Volume v2 API Library
+
+A collection of wrappers for deprecated Block Storage v2 APIs that are not
+intentionally supported by SDK.
+"""
+
+import http
+
+from openstack import exceptions as sdk_exceptions
+from osc_lib import exceptions
+
+
+# consistency groups
+
+
+def find_consistency_group(compute_client, name_or_id):
+    """Find the consistency group for a given name or ID
+
+    https://docs.openstack.org/api-ref/block-storage/v3/#show-a-consistency-group-s-details
+
+    :param volume_client: A volume client
+    :param name_or_id: The name or ID of the consistency group to look up
+    :returns: A consistency group object
+    :raises exception.NotFound: If a matching consistency group could not be
+        found or more than one match was found
+    """
+    response = compute_client.get(f'/consistencygroups/{name_or_id}')
+    if response.status_code != http.HTTPStatus.NOT_FOUND:
+        # there might be other, non-404 errors
+        sdk_exceptions.raise_from_response(response)
+        return response.json()['consistencygroup']
+
+    response = compute_client.get('/consistencygroups')
+    sdk_exceptions.raise_from_response(response)
+    found = None
+    consistency_groups = response.json()['consistencygroups']
+    for consistency_group in consistency_groups:
+        if consistency_group['name'] == name_or_id:
+            if found:
+                raise exceptions.NotFound(
+                    f'multiple matches found for {name_or_id}'
+                )
+            found = consistency_group
+
+    if not found:
+        raise exceptions.NotFound(f'{name_or_id} not found')
+
+    return found

openstackclient/api/volume_v3.py

@@ -0,0 +1,60 @@
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+
+"""Volume v3 API Library
+
+A collection of wrappers for deprecated Block Storage v3 APIs that are not
+intentionally supported by SDK.
+"""
+
+import http
+
+from openstack import exceptions as sdk_exceptions
+from osc_lib import exceptions
+
+
+# consistency groups
+
+
+def find_consistency_group(compute_client, name_or_id):
+    """Find the consistency group for a given name or ID
+
+    https://docs.openstack.org/api-ref/block-storage/v3/#show-a-consistency-group-s-details
+
+    :param volume_client: A volume client
+    :param name_or_id: The name or ID of the consistency group to look up
+    :returns: A consistency group object
+    :raises exception.NotFound: If a matching consistency group could not be
+        found or more than one match was found
+    """
+    response = compute_client.get(f'/consistencygroups/{name_or_id}')
+    if response.status_code != http.HTTPStatus.NOT_FOUND:
+        # there might be other, non-404 errors
+        sdk_exceptions.raise_from_response(response)
+        return response.json()['consistencygroup']
+
+    response = compute_client.get('/consistencygroups')
+    sdk_exceptions.raise_from_response(response)
+    found = None
+    consistency_groups = response.json()['consistencygroups']
+    for consistency_group in consistency_groups:
+        if consistency_group['name'] == name_or_id:
+            if found:
+                raise exceptions.NotFound(
+                    f'multiple matches found for {name_or_id}'
+                )
+            found = consistency_group
+
+    if not found:
+        raise exceptions.NotFound(f'{name_or_id} not found')
+
+    return found

openstackclient/command.py

@@ -0,0 +1,27 @@
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from cliff import lister
+from cliff import show
+from osc_lib.command import command
+
+from openstackclient import shell
+
+
+class Command(command.Command):
+    app: shell.OpenStackShell
+
+
+class Lister(Command, lister.Lister): ...
+
+
+class ShowOne(Command, show.ShowOne): ...

openstackclient/common/availability_zone.py

@@ -17,9 +17,9 @@ import copy
 import logging
 
 from openstack import exceptions as sdk_exceptions
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/common/clientmanager.py

@@ -15,15 +15,25 @@
 
 """Manage access to the clients, including authenticating when needed."""
 
+import argparse
+from collections.abc import Callable
 import importlib
 import logging
 import sys
 import typing as ty
 
+from osc_lib.cli import client_config
 from osc_lib import clientmanager
 from osc_lib import shell
 import stevedore
 
+if ty.TYPE_CHECKING:
+    from keystoneauth1 import access as ksa_access
+    from openstack.compute.v2 import _proxy as compute_proxy
+    from openstack.image.v2 import _proxy as image_proxy
+    from openstack.network.v2 import _proxy as network_proxy
+
+    from openstackclient.api import object_store_v1
 
 LOG = logging.getLogger(__name__)
 
@@ -40,11 +50,23 @@ class ClientManager(clientmanager.ClientManager):
     in osc-lib so we need to maintain a transition period.
     """
 
-    # A simple incrementing version for the plugin to know what is available
-    PLUGIN_INTERFACE_VERSION = "2"
-
-    # Let the commands set this
-    _auth_required = False
+    if ty.TYPE_CHECKING:
+        # we know this will be set by us and will not be nullable
+        auth_ref: ksa_access.AccessInfo
+
+        # this is a hack to keep mypy happy: the actual attributes are set in
+        # get_plugin_modules below
+        # TODO(stephenfin): Change the types of identity and volume once we've
+        # migrated everything to SDK. Hopefully by then we'll have figured out
+        # how to statically distinguish between the v2 and v3 versions of both
+        # services...
+        # TODO(stephenfin): We also need to migrate object storage...
+        compute: compute_proxy.Proxy
+        identity: ty.Any
+        image: image_proxy.Proxy
+        network: network_proxy.Proxy
+        object_store: object_store_v1.APIv1
+        volume: ty.Any
 
     def __init__(
         self,
@@ -81,6 +103,12 @@ class ClientManager(clientmanager.ClientManager):
             self._auth_required
             and self._cli_options._openstack_config is not None
         ):
+            if not isinstance(
+                self._cli_options._openstack_config, client_config.OSC_Config
+            ):
+                # programmer error
+                raise TypeError('unexpected type for _openstack_config')
+
             self._cli_options._openstack_config._pw_callback = (
                 shell.prompt_for_password
             )
@@ -107,6 +135,13 @@ class ClientManager(clientmanager.ClientManager):
             self._cli_options.config['auth_type'] = self._original_auth_type
             del self._cli_options.config['auth']['token']
             del self._cli_options.config['auth']['endpoint']
+
+            if not isinstance(
+                self._cli_options._openstack_config, client_config.OSC_Config
+            ):
+                # programmer error
+                raise TypeError('unexpected type for _openstack_config')
+
             self._cli_options._auth = (
                 self._cli_options._openstack_config.load_auth_plugin(
                     self._cli_options.config,
@@ -144,11 +179,25 @@ class ClientManager(clientmanager.ClientManager):
 
 # Plugin Support
 
+ArgumentParserT = ty.TypeVar('ArgumentParserT', bound=argparse.ArgumentParser)
+
+
+@ty.runtime_checkable  # Optional: allows usage with isinstance()
+class PluginModule(ty.Protocol):
+    DEFAULT_API_VERSION: str
+    API_VERSION_OPTION: str
+    API_NAME: str
+    API_VERSIONS: tuple[str]
+
+    make_client: Callable[..., ty.Any]
+    build_option_parser: Callable[[ArgumentParserT], ArgumentParserT]
+    check_api_version: Callable[[str], bool]
+
 
 def _on_load_failure_callback(
     manager: stevedore.ExtensionManager,
     ep: importlib.metadata.EntryPoint,
-    err: Exception,
+    err: BaseException,
 ) -> None:
     sys.stderr.write(
         f"WARNING: Failed to import plugin {ep.group}:{ep.name}: {err}.\n"
@@ -158,36 +207,25 @@ def _on_load_failure_callback(
 def get_plugin_modules(group):
     """Find plugin entry points"""
     mod_list = []
+    mgr: stevedore.ExtensionManager[PluginModule]
     mgr = stevedore.ExtensionManager(
         group, on_load_failure_callback=_on_load_failure_callback
     )
     for ep in mgr:
         LOG.debug('Found plugin %s', ep.name)
 
-        # Different versions of stevedore use different
-        # implementations of EntryPoint from other libraries, which
-        # are not API-compatible.
-        try:
-            module_name = ep.entry_point.module_name
-        except AttributeError:
-            try:
-                module_name = ep.entry_point.module
-            except AttributeError:
-                module_name = ep.entry_point.value
+        module_name = ep.entry_point.module
 
         try:
             module = importlib.import_module(module_name)
         except Exception as err:
             sys.stderr.write(
-                f"WARNING: Failed to import plugin {ep.group}:{ep.name}: "
-                f"{err}.\n"
+                f"WARNING: Failed to import plugin "
+                f"{ep.module_name}:{ep.name}: {err}.\n"
             )
             continue
 
         mod_list.append(module)
-        init_func = getattr(module, 'Initialize', None)
-        if init_func:
-            init_func('x')
 
         # Add the plugin to the ClientManager
         setattr(

openstackclient/common/configuration.py

@@ -14,8 +14,8 @@
 """Configuration action implementations"""
 
 from keystoneauth1.loading import base
-from osc_lib.command import command
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 REDACTED = "<redacted>"

openstackclient/common/extension.py

@@ -17,9 +17,9 @@
 
 import logging
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)

openstackclient/common/limits.py

@@ -17,9 +17,9 @@
 
 import itertools
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 

openstackclient/common/module.py

@@ -17,9 +17,9 @@
 
 import sys
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 
@@ -48,7 +48,9 @@ class ListCommand(command.Lister):
         columns = ('Command Group', 'Commands')
 
         if parsed_args.group:
-            groups = (group for group in groups if parsed_args.group in group)
+            groups = sorted(
+                group for group in groups if parsed_args.group in group
+            )
 
         commands = []
         for group in groups:

openstackclient/common/project_cleanup.py

@@ -20,8 +20,8 @@ import queue
 import typing as ty
 
 from cliff.formatters import table
-from osc_lib.command import command
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -90,17 +90,19 @@ class ProjectCleanup(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        sdk = self.app.client_manager.sdk_connection
+        connection = self.app.client_manager.sdk_connection
 
         if parsed_args.auth_project:
-            project_connect = sdk
+            # is we've got a project already configured, use the connection
+            # as-is
+            pass
         elif parsed_args.project:
-            project = sdk.identity.find_project(
+            project = connection.identity.find_project(
                 name_or_id=parsed_args.project, ignore_missing=False
             )
-            project_connect = sdk.connect_as_project(project)
+            connection = connection.connect_as_project(project)
 
-        if project_connect:
+        if connection:
             status_queue: queue.Queue[ty.Any] = queue.Queue()
             parsed_args.max_width = int(
                 os.environ.get('CLIFF_MAX_TERM_WIDTH', 0)
@@ -120,7 +122,7 @@ class ProjectCleanup(command.Command):
             if parsed_args.updated_before:
                 filters['updated_at'] = parsed_args.updated_before
 
-            project_connect.project_cleanup(
+            connection.project_cleanup(
                 dry_run=True,
                 status_queue=status_queue,
                 filters=filters,
@@ -150,7 +152,7 @@ class ProjectCleanup(command.Command):
 
             self.log.warning(_('Deleting resources'))
 
-            project_connect.project_cleanup(
+            connection.project_cleanup(
                 dry_run=False,
                 status_queue=status_queue,
                 filters=filters,

openstackclient/common/quota.py

@@ -21,10 +21,10 @@ import sys
 import typing as ty
 
 from openstack import exceptions as sdk_exceptions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 from openstackclient.network import common
 
@@ -746,21 +746,32 @@ and ``server-group-members`` output for a given quota class."""
         # values if the project or class does not exist. This is expected
         # behavior. However, we have already checked for the presence of the
         # project above so it shouldn't be an issue.
-        if parsed_args.service in {'all', 'compute'}:
+        if parsed_args.service == 'compute' or (
+            parsed_args.service == 'all'
+            and self.app.client_manager.is_compute_endpoint_enabled()
+        ):
             compute_quota_info = get_compute_quotas(
                 self.app,
                 project,
                 detail=parsed_args.usage,
                 default=parsed_args.default,
             )
-        if parsed_args.service in {'all', 'volume'}:
+
+        if parsed_args.service == 'volume' or (
+            parsed_args.service == 'all'
+            and self.app.client_manager.is_volume_endpoint_enabled()
+        ):
             volume_quota_info = get_volume_quotas(
                 self.app,
                 project,
                 detail=parsed_args.usage,
                 default=parsed_args.default,
             )
-        if parsed_args.service in {'all', 'network'}:
+
+        if parsed_args.service == 'network' or (
+            parsed_args.service == 'all'
+            and self.app.client_manager.is_network_endpoint_enabled()
+        ):
             network_quota_info = get_network_quotas(
                 self.app,
                 project,
@@ -906,12 +917,18 @@ class DeleteQuota(command.Command):
         )
 
         # compute quotas
-        if parsed_args.service in {'all', 'compute'}:
+        if parsed_args.service == 'compute' or (
+            parsed_args.service == 'all'
+            and self.app.client_manager.is_compute_endpoint_enabled()
+        ):
             compute_client = self.app.client_manager.compute
             compute_client.revert_quota_set(project.id)
 
         # volume quotas
-        if parsed_args.service in {'all', 'volume'}:
+        if parsed_args.service == 'volume' or (
+            parsed_args.service == 'all'
+            and self.app.client_manager.is_volume_endpoint_enabled()
+        ):
             volume_client = self.app.client_manager.sdk_connection.volume
             volume_client.revert_quota_set(project.id)
 

openstackclient/common/versions.py

@@ -14,8 +14,7 @@
 
 """Versions Action Implementation"""
 
-from osc_lib.command import command
-
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/compute/v2/agent.py

@@ -18,10 +18,10 @@
 import logging
 
 from openstack import exceptions as sdk_exceptions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/compute/v2/aggregate.py

@@ -19,20 +19,21 @@
 import logging
 import typing as ty
 
+from cliff import columns
 from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 
 LOG = logging.getLogger(__name__)
 
 
-_aggregate_formatters = {
+_aggregate_formatters: dict[str, type[columns.FormattableColumn[ty.Any]]] = {
     'Hosts': format_columns.ListColumn,
     'Metadata': format_columns.DictColumn,
     'hosts': format_columns.ListColumn,
@@ -438,15 +439,15 @@ class CacheImageForAggregate(command.Command):
             )
             raise exceptions.CommandError(msg)
 
+        image_client = self.app.client_manager.sdk_connection.image
+
         aggregate = compute_client.find_aggregate(
             parsed_args.aggregate, ignore_missing=False
         )
 
         images = []
         for img in parsed_args.image:
-            image = self.app.client_manager.sdk_connection.image.find_image(
-                img, ignore_missing=False
-            )
+            image = image_client.find_image(img, ignore_missing=False)
             images.append(image.id)
 
         compute_client.aggregate_precache_images(aggregate.id, images)

openstackclient/compute/v2/console.py

@@ -16,9 +16,9 @@
 """Compute v2 Console action implementations"""
 
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 
@@ -64,13 +64,15 @@ class ShowConsoleLog(command.Command):
         output = compute_client.get_server_console_output(
             server.id, length=parsed_args.lines
         )
-        data = None
+        data: str | None = None
         if output:
             data = output.get('output', None)
 
         if data and data[-1] != '\n':
             data += '\n'
-        self.app.stdout.write(data)
+
+        if data:
+            self.app.stdout.write(data)
 
 
 class ShowConsoleURL(command.ShowOne):

openstackclient/compute/v2/console_connection.py

@@ -13,9 +13,9 @@
 
 """Compute v2 Console auth token implementations."""
 
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _
 
 

openstackclient/compute/v2/flavor.py

@@ -21,10 +21,10 @@ from openstack import exceptions as sdk_exceptions
 from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
-from osc_lib.command import command
 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
@@ -156,12 +156,25 @@ class CreateFlavor(command.ShowOne):
             msg = _("--project is only allowed with --private")
             raise exceptions.CommandError(msg)
 
+        flavor_id = parsed_args.id
+        if parsed_args.id == 'auto':
+            # novaclient aliased 'auto' to mean "generate a UUID for me": we
+            # do the same to avoid breaking existing users
+            flavor_id = None
+
+            msg = _(
+                "Passing '--id auto' is deprecated. Nova will automatically "
+                "assign a UUID-like ID if no ID is provided. Omit the '--id' "
+                "parameter instead."
+            )
+            self.log.warning(msg)
+
         args = {
             'name': parsed_args.name,
             'ram': parsed_args.ram,
             'vcpus': parsed_args.vcpus,
             'disk': parsed_args.disk,
-            'id': parsed_args.id,
+            'id': flavor_id,
             'ephemeral': parsed_args.ephemeral,
             'swap': parsed_args.swap,
             'rxtx_factor': parsed_args.rxtx_factor,

openstackclient/compute/v2/host.py

@@ -16,9 +16,9 @@
 """Host action implementations"""
 
 from openstack import exceptions as sdk_exceptions
-from osc_lib.command import command
 from osc_lib import utils
 
+from openstackclient import command
 from openstackclient.i18n import _