python-openstackclient 6.6.0__py3-none-any.whl → 7.0.0__py3-none-any.whl

openstackclient/common/versions.py

@@ -23,7 +23,7 @@ class ShowVersions(command.Lister):
     _description = _("Show available versions of services")
 
     def get_parser(self, prog_name):
-        parser = super(ShowVersions, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         interface_group = parser.add_mutually_exclusive_group()
         interface_group.add_argument(
             "--all-interfaces",

openstackclient/compute/client.py

@@ -15,96 +15,28 @@
 
 import logging
 
-from osc_lib import exceptions
 from osc_lib import utils
 
 from openstackclient.i18n import _
 
-
 LOG = logging.getLogger(__name__)
 
 DEFAULT_API_VERSION = '2.1'
 API_VERSION_OPTION = 'os_compute_api_version'
 API_NAME = 'compute'
 API_VERSIONS = {
-    "2": "novaclient.client",
-    "2.1": "novaclient.client",
-}
-
-COMPUTE_API_TYPE = 'compute'
-COMPUTE_API_VERSIONS = {
-    '2': 'openstackclient.api.compute_v2.APIv2',
+    '2': 'openstack.connection.Connection',
+    '2.1': 'openstack.connection.Connection',
 }
 
-# Save the microversion if in use
-_compute_api_version = None
-
 
 def make_client(instance):
     """Returns a compute service client."""
-
-    # Defer client import until we actually need them
-    from novaclient import client as nova_client
-
-    if _compute_api_version is not None:
-        version = _compute_api_version
-    else:
-        version = instance._api_version[API_NAME]
-        from novaclient import api_versions
-
-        # convert to APIVersion object
-        version = api_versions.get_api_version(version)
-
-    if version.is_latest():
-        import novaclient
-
-        # NOTE(RuiChen): executing version discovery make sense, but that need
-        #                an initialized REST client, it's not available now,
-        #                fallback to use the max version of novaclient side.
-        version = novaclient.API_MAX_VERSION
-
-    LOG.debug('Instantiating compute client for %s', version)
-
-    compute_api = utils.get_client_class(
-        API_NAME,
-        version.ver_major,
-        COMPUTE_API_VERSIONS,
-    )
-    LOG.debug('Instantiating compute api: %s', compute_api)
-
-    # Set client http_log_debug to True if verbosity level is high enough
-    http_log_debug = utils.get_effective_log_level() <= logging.DEBUG
-
-    extensions = [
-        ext
-        for ext in nova_client.discover_extensions(version)
-        if ext.name == "list_extensions"
-    ]
-
-    # Remember interface only if it is set
-    kwargs = utils.build_kwargs_dict('endpoint_type', instance.interface)
-
-    client = nova_client.Client(
-        version,
-        session=instance.session,
-        extensions=extensions,
-        http_log_debug=http_log_debug,
-        timings=instance.timing,
-        region_name=instance.region_name,
-        **kwargs
-    )
-
-    client.api = compute_api(
-        session=instance.session,
-        service_type=COMPUTE_API_TYPE,
-        endpoint=instance.get_endpoint_for_service_type(
-            COMPUTE_API_TYPE,
-            region_name=instance.region_name,
-            interface=instance.interface,
-        ),
+    LOG.debug(
+        'Compute client initialized using OpenStack SDK: %s',
+        instance.sdk_connection.compute,
     )
-
-    return client
+    return instance.sdk_connection.compute
 
 
 def build_option_parser(parser):
@@ -113,48 +45,7 @@ def build_option_parser(parser):
         '--os-compute-api-version',
         metavar='<compute-api-version>',
         default=utils.env('OS_COMPUTE_API_VERSION'),
-        help=_(
-            "Compute API version, default=%s " "(Env: OS_COMPUTE_API_VERSION)"
-        )
+        help=_("Compute API version, default=%s (Env: OS_COMPUTE_API_VERSION)")
         % DEFAULT_API_VERSION,
     )
     return parser
-
-
-def check_api_version(check_version):
-    """Validate version supplied by user
-
-    Returns:
-
-    * True if version is OK
-    * False if the version has not been checked and the previous plugin
-      check should be performed
-    * throws an exception if the version is no good
-
-    TODO(dtroyer): make the exception thrown a version-related one
-    """
-
-    # Defer client imports until we actually need them
-    import novaclient
-    from novaclient import api_versions
-
-    global _compute_api_version
-
-    # Copy some logic from novaclient 3.3.0 for basic version detection
-    # NOTE(dtroyer): This is only enough to resume operations using API
-    #                version 2.0 or any valid version supplied by the user.
-    _compute_api_version = api_versions.get_api_version(check_version)
-
-    # Bypass X.latest format microversion
-    if not _compute_api_version.is_latest():
-        if _compute_api_version > api_versions.APIVersion("2.0"):
-            if not _compute_api_version.matches(
-                novaclient.API_MIN_VERSION,
-                novaclient.API_MAX_VERSION,
-            ):
-                msg = _("versions supported by client: %(min)s - %(max)s") % {
-                    "min": novaclient.API_MIN_VERSION.get_string(),
-                    "max": novaclient.API_MAX_VERSION.get_string(),
-                }
-                raise exceptions.CommandError(msg)
-    return True

openstackclient/compute/v2/agent.py

@@ -17,6 +17,7 @@
 
 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
@@ -36,7 +37,7 @@ class CreateAgent(command.ShowOne):
     """
 
     def get_parser(self, prog_name):
-        parser = super(CreateAgent, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument("os", metavar="<os>", help=_("Type of OS"))
         parser.add_argument(
             "architecture",
@@ -55,16 +56,26 @@ class CreateAgent(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
-        args = (
-            parsed_args.os,
-            parsed_args.architecture,
-            parsed_args.version,
-            parsed_args.url,
-            parsed_args.md5hash,
-            parsed_args.hypervisor,
+        compute_client = self.app.client_manager.sdk_connection.compute
+
+        # doing this since openstacksdk has decided not to support this
+        # deprecated command
+        data = {
+            'agent': {
+                'hypervisor': parsed_args.hypervisor,
+                'os': parsed_args.os,
+                'architecture': parsed_args.architecture,
+                'version': parsed_args.version,
+                'url': parsed_args.url,
+                'md5hash': parsed_args.md5hash,
+            },
+        }
+        response = compute_client.post(
+            '/os-agents', json=data, microversion='2.1'
         )
-        agent = compute_client.agents.create(*args)._info.copy()
+        sdk_exceptions.raise_from_response(response)
+        agent = response.json().get('agent')
+
         return zip(*sorted(agent.items()))
 
 
@@ -77,18 +88,23 @@ class DeleteAgent(command.Command):
     """
 
     def get_parser(self, prog_name):
-        parser = super(DeleteAgent, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "id", metavar="<id>", nargs='+', help=_("ID of agent(s) to delete")
         )
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
         result = 0
         for id in parsed_args.id:
             try:
-                compute_client.agents.delete(id)
+                # doing this since openstacksdk has decided not to support this
+                # deprecated command
+                response = compute_client.delete(
+                    f'/os-agents/{id}', microversion='2.1'
+                )
+                sdk_exceptions.raise_from_response(response)
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -114,7 +130,7 @@ class ListAgent(command.Lister):
     """
 
     def get_parser(self, prog_name):
-        parser = super(ListAgent, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "--hypervisor",
             metavar="<hypervisor>",
@@ -123,7 +139,7 @@ class ListAgent(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
+        compute_client = self.app.client_manager.sdk_connection.compute
         columns = (
             "Agent ID",
             "Hypervisor",
@@ -133,30 +149,36 @@ class ListAgent(command.Lister):
             "Md5Hash",
             "URL",
         )
-        data = compute_client.agents.list(parsed_args.hypervisor)
-        return (
-            columns,
-            (
-                utils.get_item_properties(
-                    s,
-                    columns,
-                )
-                for s in data
-            ),
-        )
+
+        # doing this since openstacksdk has decided not to support this
+        # deprecated command
+        path = '/os-agents'
+        if parsed_args.hypervisor:
+            path += f'?hypervisor={parsed_args.hypervisor}'
+
+        response = compute_client.get(path, microversion='2.1')
+        sdk_exceptions.raise_from_response(response)
+        agents = response.json().get('agents')
+
+        return columns, (utils.get_dict_properties(s, columns) for s in agents)
 
 
 class SetAgent(command.Command):
     """Set compute agent properties.
 
-    The compute agent functionality is hypervisor specific and is only
+    The compute agent functionality is hypervisor-specific and is only
     supported by the XenAPI hypervisor driver. It was removed from nova in the
     23.0.0 (Wallaby) release.
     """
 
     def get_parser(self, prog_name):
-        parser = super(SetAgent, self).get_parser(prog_name)
-        parser.add_argument("id", metavar="<id>", help=_("ID of the agent"))
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "id",
+            metavar="<id>",
+            type=int,
+            help=_("ID of the agent"),
+        )
         parser.add_argument(
             "--agent-version",
             dest="version",
@@ -172,30 +194,34 @@ class SetAgent(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.compute
-        data = compute_client.agents.list(hypervisor=None)
-        agent = {}
-
-        for s in data:
-            if s.agent_id == int(parsed_args.id):
-                agent['version'] = s.version
-                agent['url'] = s.url
-                agent['md5hash'] = s.md5hash
-        if agent == {}:
+        compute_client = self.app.client_manager.sdk_connection.compute
+
+        response = compute_client.get('/os-agents', microversion='2.1')
+        sdk_exceptions.raise_from_response(response)
+        agents = response.json().get('agents')
+        data = {}
+        for agent in agents:
+            if agent['agent_id'] == parsed_args.id:
+                data['version'] = agent['version']
+                data['url'] = agent['url']
+                data['md5hash'] = agent['md5hash']
+                break
+        else:
             msg = _("No agent with a ID of '%(id)s' exists.")
-            raise exceptions.CommandError(msg % parsed_args.id)
+            raise exceptions.CommandError(msg % {'id': parsed_args.id})
 
         if parsed_args.version:
-            agent['version'] = parsed_args.version
+            data['version'] = parsed_args.version
         if parsed_args.url:
-            agent['url'] = parsed_args.url
+            data['url'] = parsed_args.url
         if parsed_args.md5hash:
-            agent['md5hash'] = parsed_args.md5hash
+            data['md5hash'] = parsed_args.md5hash
+
+        data = {'para': data}
 
-        args = (
-            parsed_args.id,
-            agent['version'],
-            agent['url'],
-            agent['md5hash'],
+        # doing this since openstacksdk has decided not to support this
+        # deprecated command
+        response = compute_client.put(
+            f'/os-agents/{parsed_args.id}', json=data, microversion='2.1'
         )
-        compute_client.agents.update(*args)
+        sdk_exceptions.raise_from_response(response)

openstackclient/compute/v2/aggregate.py

@@ -55,7 +55,7 @@ class AddAggregateHost(command.ShowOne):
     _description = _("Add host to aggregate")
 
     def get_parser(self, prog_name):
-        parser = super(AddAggregateHost, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'aggregate',
             metavar='<aggregate>',
@@ -88,7 +88,7 @@ class CreateAggregate(command.ShowOne):
     _description = _("Create a new aggregate")
 
     def get_parser(self, prog_name):
-        parser = super(CreateAggregate, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "name", metavar="<name>", help=_("New aggregate name")
         )
@@ -136,7 +136,7 @@ class DeleteAggregate(command.Command):
     _description = _("Delete existing aggregate(s)")
 
     def get_parser(self, prog_name):
-        parser = super(DeleteAggregate, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'aggregate',
             metavar='<aggregate>',
@@ -178,7 +178,7 @@ class ListAggregate(command.Lister):
     _description = _("List all aggregates")
 
     def get_parser(self, prog_name):
-        parser = super(ListAggregate, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             '--long',
             action='store_true',
@@ -232,7 +232,7 @@ class RemoveAggregateHost(command.ShowOne):
     _description = _("Remove host from aggregate")
 
     def get_parser(self, prog_name):
-        parser = super(RemoveAggregateHost, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'aggregate',
             metavar='<aggregate>',
@@ -265,7 +265,7 @@ class SetAggregate(command.Command):
     _description = _("Set aggregate properties")
 
     def get_parser(self, prog_name):
-        parser = super(SetAggregate, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'aggregate',
             metavar='<aggregate>',
@@ -337,7 +337,7 @@ class ShowAggregate(command.ShowOne):
     _description = _("Display aggregate details")
 
     def get_parser(self, prog_name):
-        parser = super(ShowAggregate, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'aggregate',
             metavar='<aggregate>',
@@ -366,7 +366,7 @@ class UnsetAggregate(command.Command):
     _description = _("Unset aggregate properties")
 
     def get_parser(self, prog_name):
-        parser = super(UnsetAggregate, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "aggregate",
             metavar="<aggregate>",
@@ -403,7 +403,7 @@ class CacheImageForAggregate(command.Command):
     # not be anything to return.
 
     def get_parser(self, prog_name):
-        parser = super(CacheImageForAggregate, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'aggregate',
             metavar='<aggregate>',

openstackclient/compute/v2/console.py

@@ -36,7 +36,7 @@ class ShowConsoleLog(command.Command):
     _description = _("Show server's console output")
 
     def get_parser(self, prog_name):
-        parser = super(ShowConsoleLog, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
             metavar='<server>',
@@ -78,7 +78,7 @@ class ShowConsoleURL(command.ShowOne):
     _description = _("Show server's remote console URL")
 
     def get_parser(self, prog_name):
-        parser = super(ShowConsoleURL, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             'server',
             metavar='<server>',

openstackclient/compute/v2/flavor.py

@@ -58,7 +58,7 @@ class CreateFlavor(command.ShowOne):
     _description = _("Create new flavor")
 
     def get_parser(self, prog_name):
-        parser = super(CreateFlavor, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "name", metavar="<flavor-name>", help=_("New flavor name")
         )
@@ -214,7 +214,7 @@ class DeleteFlavor(command.Command):
     _description = _("Delete flavor(s)")
 
     def get_parser(self, prog_name):
-        parser = super(DeleteFlavor, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "flavor",
             metavar="<flavor>",
@@ -253,7 +253,7 @@ class ListFlavor(command.Lister):
     _description = _("List flavors")
 
     def get_parser(self, prog_name):
-        parser = super(ListFlavor, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         public_group = parser.add_mutually_exclusive_group()
         public_group.add_argument(
             "--public",
@@ -375,7 +375,7 @@ class SetFlavor(command.Command):
     _description = _("Set flavor properties")
 
     def get_parser(self, prog_name):
-        parser = super(SetFlavor, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "flavor",
             metavar="<flavor>",
@@ -491,7 +491,7 @@ class ShowFlavor(command.ShowOne):
     _description = _("Display flavor details")
 
     def get_parser(self, prog_name):
-        parser = super(ShowFlavor, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "flavor",
             metavar="<flavor>",
@@ -540,7 +540,7 @@ class UnsetFlavor(command.Command):
     _description = _("Unset flavor properties")
 
     def get_parser(self, prog_name):
-        parser = super(UnsetFlavor, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "flavor",
             metavar="<flavor>",

openstackclient/compute/v2/host.py

@@ -15,6 +15,7 @@
 
 """Host action implementations"""
 
+from openstack import exceptions as sdk_exceptions
 from osc_lib.command import command
 from osc_lib import utils
 
@@ -35,37 +36,29 @@ class ListHost(command.Lister):
 
     def take_action(self, parsed_args):
         compute_client = self.app.client_manager.sdk_connection.compute
-        columns = ("Host Name", "Service", "Zone")
 
         self.log.warning(
-            "API has been deprecated. "
-            "Please consider using 'hypervisor list' instead."
+            "API has been deprecated; "
+            "consider using 'hypervisor list' instead."
         )
 
         # doing this since openstacksdk has decided not to support this
         # deprecated command
-        hosts = (
-            compute_client.get('/os-hosts', microversion='2.1')
-            .json()
-            .get('hosts')
-        )
-
+        response = compute_client.get('/os-hosts', microversion='2.1')
+        sdk_exceptions.raise_from_response(response)
+        hosts = response.json().get('hosts')
         if parsed_args.zone is not None:
-            filtered_hosts = []
-            for host in hosts:
-                if host['zone'] == parsed_args.zone:
-                    filtered_hosts.append(host)
-
-            hosts = filtered_hosts
+            hosts = [h for h in hosts if h['zone'] == parsed_args.zone]
 
+        columns = ("Host Name", "Service", "Zone")
         return columns, (utils.get_dict_properties(s, columns) for s in hosts)
 
 
 class SetHost(command.Command):
-    _description = _("Set host properties")
+    _description = _("DEPRECATED: Set host properties")
 
     def get_parser(self, prog_name):
-        parser = super(SetHost, self).get_parser(prog_name)
+        parser = super().get_parser(prog_name)
         parser.add_argument(
             "host", metavar="<host>", help=_("Host to modify (name only)")
         )
@@ -90,20 +83,33 @@ class SetHost(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        kwargs = {}
+        compute_client = self.app.client_manager.sdk_connection.compute
+
+        self.log.warning(
+            "API has been deprecated; "
+            "consider using 'compute service set' instead."
+        )
 
+        data = {}
         if parsed_args.enable:
-            kwargs['status'] = 'enable'
+            data['status'] = 'enable'
         if parsed_args.disable:
-            kwargs['status'] = 'disable'
+            data['status'] = 'disable'
         if parsed_args.enable_maintenance:
-            kwargs['maintenance_mode'] = 'enable'
+            data['maintenance_mode'] = 'enable'
         if parsed_args.disable_maintenance:
-            kwargs['maintenance_mode'] = 'disable'
+            data['maintenance_mode'] = 'disable'
 
-        compute_client = self.app.client_manager.compute
+        if not data:
+            # don't bother calling if nothing given
+            return
 
-        compute_client.api.host_set(parsed_args.host, **kwargs)
+        # doing this since openstacksdk has decided not to support this
+        # deprecated command
+        response = compute_client.put(
+            f'/os-hosts/{parsed_args.host}', json=data, microversion='2.1'
+        )
+        sdk_exceptions.raise_from_response(response)
 
 
 class ShowHost(command.Lister):
@@ -116,26 +122,25 @@ class ShowHost(command.Lister):
 
     def take_action(self, parsed_args):
         compute_client = self.app.client_manager.sdk_connection.compute
-        columns = ("Host", "Project", "CPU", "Memory MB", "Disk GB")
 
         self.log.warning(
-            "API has been deprecated. "
-            "Please consider using 'hypervisor show' instead."
+            "API has been deprecated; "
+            "consider using 'hypervisor show' instead."
         )
 
         # doing this since openstacksdk has decided not to support this
         # deprecated command
-        resources = (
-            compute_client.get(
-                '/os-hosts/' + parsed_args.host, microversion='2.1'
-            )
-            .json()
-            .get('host')
+        response = compute_client.get(
+            f'/os-hosts/{parsed_args.host}', microversion='2.1'
         )
+        sdk_exceptions.raise_from_response(response)
+        resources = response.json().get('host')
 
         data = []
         if resources is not None:
             for resource in resources:
                 data.append(resource['resource'])
 
+        columns = ("Host", "Project", "CPU", "Memory MB", "Disk GB")
+
         return columns, (utils.get_dict_properties(s, columns) for s in data)

openstackclient/compute/v2/hypervisor.py

@@ -18,7 +18,7 @@
 import json
 import re
 
-from novaclient import exceptions as nova_exceptions
+from openstack import exceptions as sdk_exceptions
 from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
 from osc_lib.command import command
@@ -223,8 +223,9 @@ class ShowHypervisor(command.ShowOne):
                 hypervisor['uptime'] = m.group(2)
                 hypervisor['users'] = m.group(3)
                 hypervisor['load_average'] = m.group(4)
-        except nova_exceptions.HTTPNotImplemented:
-            pass
+        except sdk_exceptions.HttpException as exc:
+            if exc.status_code != 501:
+                raise
 
         hypervisor['service_id'] = service_details['id']
         hypervisor['service_host'] = service_details['host']