osc-lib 3.1.0__tar.gz → 3.2.0__tar.gz

{osc-lib-3.1.0 → osc-lib-3.2.0}/.coveragerc

@@ -1,6 +1,7 @@
 [run]
 branch = True
 source = osc_lib
+omit = osc_lib/tests/*
 
 [report]
 ignore_errors = True

{osc-lib-3.1.0 → osc-lib-3.2.0}/.pre-commit-config.yaml

@@ -4,7 +4,7 @@ default_language_version:
   python: python3
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: mixed-line-ending
@@ -18,22 +18,19 @@ repos:
         files: .*\.(yaml|yml)$
         exclude: '^zuul.d/.*$'
   - repo: https://github.com/PyCQA/doc8
-    rev: v1.1.1
+    rev: v1.1.2
     hooks:
       - id: doc8
-  - repo: https://github.com/psf/black
-    rev: 23.7.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.4
     hooks:
-      - id: black
-        args: ['-S', '-l', '79']
-  - repo: local
+      - id: ruff
+        args: ['--fix', '--unsafe-fixes']
+      - id: ruff-format
+  - repo: https://opendev.org/openstack/hacking
+    rev: 7.0.0
     hooks:
-      - id: flake8
-        name: flake8
+      - id: hacking
         additional_dependencies:
-          - hacking>=6.0.1,<6.1.0
-          - flake8-import-order>=0.18.2,<0.19.0
-        language: python
-        entry: flake8
-        files: '^.*\.py$'
+          - flake8-import-order~=0.18.2
         exclude: '^(doc|releasenotes|tools)/.*$'

{osc-lib-3.1.0 → osc-lib-3.2.0}/AUTHORS

@@ -107,6 +107,7 @@ OpenStack Release Bot <infra-root@openstack.org>
 Paul Belanger <paul.belanger@polybeacon.com>
 Qiu Yu <qiuyu@ebaysf.com>
 Rabi Mishra <ramishra@redhat.com>
+Radoslaw Smigielski <rsmigiel@redhat.com>
 Reedip <reedip14@gmail.com>
 Riccardo Pittau <elfosardo@gmail.com>
 Richard Theis <rtheis@us.ibm.com>

{osc-lib-3.1.0 → osc-lib-3.2.0}/ChangeLog

@@ -1,11 +1,22 @@
 CHANGES
 =======
 
+3.2.0
+-----
+
+* ruff: Enable pyupgrade rules
+* pre-commit: Migrate from black to ruff format
+* pre-commit: Migrate from flake8 to ruff
+* parseactions: Use ArgumentError, not ArgumentTypeError
+* Update master for stable/2024.2
+* Exclude tests directory from coverage calculation
+
 3.1.0
 -----
 
 * Drop dependency on simplejson
 * reno: Update master for unmaintained/zed
+* Fix log level, remove unnecessary debug
 * Update master for stable/2024.1
 * reno: Update master for unmaintained/xena
 * reno: Update master for unmaintained/wallaby

{osc-lib-3.1.0 → osc-lib-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: osc-lib
-Version: 3.1.0
+Version: 3.2.0
 Summary: OpenStackClient Library
 Home-page: https://docs.openstack.org/osc-lib/latest/
 Author: OpenStack

{osc-lib-3.1.0 → osc-lib-3.2.0}/doc/source/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # OpenStack Command Line Client documentation build configuration file, created
 # by sphinx-quickstart on Wed May 16 12:05:58 2012.

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/api/api.py

@@ -12,6 +12,7 @@
 #
 
 """Base API Library"""
+
 from keystoneauth1 import exceptions as ksa_exceptions
 from keystoneauth1 import session as ksa_session
 import requests
@@ -20,7 +21,7 @@ from osc_lib import exceptions
 from osc_lib.i18n import _
 
 
-class BaseAPI(object):
+class BaseAPI:
     """Base API wrapper for keystoneauth1.session.Session
 
     Encapsulate the translation between keystoneauth1.session.Session
@@ -57,7 +58,7 @@ class BaseAPI(object):
             Keyword arguments passed to keystoneauth1.session.Session().
         """
 
-        super(BaseAPI, self).__init__()
+        super().__init__()
 
         # Create a keystoneauth1.session.Session if one is not supplied
         if not session:
@@ -173,7 +174,7 @@ class BaseAPI(object):
         body=None,
         detailed=False,
         headers=None,
-        **params
+        **params,
     ):
         """Return a list of resources
 
@@ -362,7 +363,7 @@ class BaseAPI(object):
         try:
             ret = self._request(
                 'GET',
-                "/%s/%s" % (path, value),
+                f"/{path}/{value}",
                 headers=headers,
             ).json()
             if isinstance(ret, dict):

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/api/auth.py

@@ -59,9 +59,8 @@ def get_options_list():
                 # TODO(mhu) simplistic approach, would be better to only add
                 # help texts if they vary from one auth plugin to another
                 # also the text rendering is ugly in the CLI ...
-                OPTIONS_LIST[os_name]['help'] += 'With %s: %s\n' % (
-                    plugin_name,
-                    o.help,
+                OPTIONS_LIST[os_name]['help'] += (
+                    f'With {plugin_name}: {o.help}\n'
                 )
     return OPTIONS_LIST
 
@@ -177,7 +176,7 @@ def build_auth_plugins_option_parser(parser):
         if 'tenant' not in o:
             parser.add_argument(
                 '--os-' + o,
-                metavar='<auth-%s>' % o,
+                metavar=f'<auth-{o}>',
                 dest=o.replace('-', '_'),
                 default=envs.get(
                     OPTIONS_LIST[o]['env'],

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/cli/client_config.py

@@ -56,7 +56,7 @@ class OSC_Config(config.OpenStackConfig):
             if not config.get('auth_type', None):
                 config['auth_type'] = 'password'
 
-        LOG.debug("Auth plugin %s selected" % config['auth_type'])
+        LOG.debug("Auth plugin {} selected".format(config['auth_type']))
         return config
 
     def _auth_v2_arguments(self, config):
@@ -94,14 +94,15 @@ class OSC_Config(config.OpenStackConfig):
                 if config['auth'].pop(prop, None) is not None:
                     if config.get('cloud'):
                         LOG.warning(
-                            "Ignoring domain related config %s for %s"
-                            "because identity API version is 2.0"
-                            % (prop, config['cloud'])
+                            "Ignoring domain related config {} for {}"
+                            "because identity API version is 2.0".format(
+                                prop, config['cloud']
+                            )
                         )
                     else:
                         LOG.warning(
-                            "Ignoring domain related config %s because"
-                            " identity API version is 2.0" % prop
+                            f"Ignoring domain related config {prop} because"
+                            " identity API version is 2.0"
                         )
         return config
 
@@ -204,9 +205,9 @@ class OSC_Config(config.OpenStackConfig):
                 # Prefer the plugin configuration dest value if the value's key
                 # is marked as depreciated.
                 if p_opt.dest is None:
-                    config['auth'][
-                        p_opt.name.replace('-', '_')
-                    ] = winning_value
+                    config['auth'][p_opt.name.replace('-', '_')] = (
+                        winning_value
+                    )
                 else:
                     config['auth'][p_opt.dest] = winning_value
 

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/cli/parseractions.py

@@ -37,12 +37,12 @@ class KeyValueAction(argparse.Action):
             # NOTE(qtang): Prevent null key setting in property
             if '' == values_list[0]:
                 msg = _("Property key must be specified: %s")
-                raise argparse.ArgumentTypeError(msg % str(values))
+                raise argparse.ArgumentError(self, msg % str(values))
             else:
                 getattr(namespace, self.dest, {}).update([values_list])
         else:
             msg = _("Expected 'key=value' type, but got: %s")
-            raise argparse.ArgumentTypeError(msg % str(values))
+            raise argparse.ArgumentError(self, msg % str(values))
 
 
 class KeyValueAppendAction(argparse.Action):
@@ -62,7 +62,7 @@ class KeyValueAppendAction(argparse.Action):
             # NOTE(qtang): Prevent null key setting in property
             if '' == key:
                 msg = _("Property key must be specified: %s")
-                raise argparse.ArgumentTypeError(msg % str(values))
+                raise argparse.ArgumentError(self, msg % str(values))
 
             dest = getattr(namespace, self.dest)
             if key in dest:
@@ -71,7 +71,7 @@ class KeyValueAppendAction(argparse.Action):
                 dest[key] = [value]
         else:
             msg = _("Expected 'key=value' type, but got: %s")
-            raise argparse.ArgumentTypeError(msg % str(values))
+            raise argparse.ArgumentError(self, msg % str(values))
 
 
 class MultiKeyValueAction(argparse.Action):
@@ -91,7 +91,7 @@ class MultiKeyValueAction(argparse.Action):
         nargs=None,
         required_keys=None,
         optional_keys=None,
-        **kwargs
+        **kwargs,
     ):
         """Initialize the action object, and parse customized options
 
@@ -106,9 +106,7 @@ class MultiKeyValueAction(argparse.Action):
             msg = _("Parameter 'nargs' is not allowed, but got %s")
             raise ValueError(msg % nargs)
 
-        super(MultiKeyValueAction, self).__init__(
-            option_strings, dest, **kwargs
-        )
+        super().__init__(option_strings, dest, **kwargs)
 
         # required_keys: A list of keys that is required. None by default.
         if required_keys and not isinstance(required_keys, list):
@@ -136,12 +134,13 @@ class MultiKeyValueAction(argparse.Action):
                     "Invalid keys %(invalid_keys)s specified.\n"
                     "Valid keys are: %(valid_keys)s"
                 )
-                raise argparse.ArgumentTypeError(
+                raise argparse.ArgumentError(
+                    self,
                     msg
                     % {
                         'invalid_keys': ', '.join(invalid_keys),
                         'valid_keys': ', '.join(valid_keys),
-                    }
+                    },
                 )
 
         if self.required_keys:
@@ -151,12 +150,13 @@ class MultiKeyValueAction(argparse.Action):
                     "Missing required keys %(missing_keys)s.\n"
                     "Required keys are: %(required_keys)s"
                 )
-                raise argparse.ArgumentTypeError(
+                raise argparse.ArgumentError(
+                    self,
                     msg
                     % {
                         'missing_keys': ', '.join(missing_keys),
                         'required_keys': ', '.join(self.required_keys),
-                    }
+                    },
                 )
 
     def __call__(self, parser, namespace, values, metavar=None):
@@ -166,20 +166,20 @@ class MultiKeyValueAction(argparse.Action):
 
         params = {}
         for kv in values.split(','):
-            # Add value if an assignment else raise ArgumentTypeError
+            # Add value if an assignment else raise ArgumentError
             if '=' in kv:
                 kv_list = kv.split('=', 1)
                 # NOTE(qtang): Prevent null key setting in property
                 if '' == kv_list[0]:
                     msg = _("Each property key must be specified: %s")
-                    raise argparse.ArgumentTypeError(msg % str(kv))
+                    raise argparse.ArgumentError(self, msg % str(kv))
                 else:
                     params.update([kv_list])
             else:
                 msg = _(
                     "Expected comma separated 'key=value' pairs, but got: %s"
                 )
-                raise argparse.ArgumentTypeError(msg % str(kv))
+                raise argparse.ArgumentError(self, msg % str(kv))
 
         # Check key validation
         self.validate_keys(list(params))
@@ -209,13 +209,13 @@ class MultiKeyValueCommaAction(MultiKeyValueAction):
         params = {}
         key = ''
         for kv in values.split(','):
-            # Add value if an assignment else raise ArgumentTypeError
+            # Add value if an assignment else raise ArgumentError
             if '=' in kv:
                 kv_list = kv.split('=', 1)
                 # NOTE(qtang): Prevent null key setting in property
                 if '' == kv_list[0]:
                     msg = _("A key must be specified before '=': %s")
-                    raise argparse.ArgumentTypeError(msg % str(kv))
+                    raise argparse.ArgumentError(self, msg % str(kv))
                 else:
                     params.update([kv_list])
                 key = kv_list[0]
@@ -224,10 +224,10 @@ class MultiKeyValueCommaAction(MultiKeyValueAction):
                 # means the current value is a part of the previous
                 # key=value pair, so append it.
                 try:
-                    params[key] = "%s,%s" % (params[key], kv)
+                    params[key] = f"{params[key]},{kv}"
                 except KeyError:
                     msg = _("A key=value pair is required: %s")
-                    raise argparse.ArgumentTypeError(msg % str(kv))
+                    raise argparse.ArgumentError(self, msg % str(kv))
 
         # Check key validation
         self.validate_keys(list(params))
@@ -284,4 +284,4 @@ class NonNegativeAction(argparse.Action):
             setattr(namespace, self.dest, values)
         else:
             msg = _("%s expected a non-negative integer")
-            raise argparse.ArgumentTypeError(msg % str(option_string))
+            raise argparse.ArgumentError(self, msg % str(option_string))

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/clientmanager.py

@@ -31,7 +31,7 @@ LOG = logging.getLogger(__name__)
 PLUGIN_MODULES = []
 
 
-class ClientCache(object):
+class ClientCache:
     """Descriptor class for caching created client handles."""
 
     def __init__(self, factory):
@@ -50,7 +50,7 @@ class ClientCache(object):
         return self._handle
 
 
-class ClientManager(object):
+class ClientManager:
     """Manages access to API clients, including authentication."""
 
     # NOTE(dtroyer): Keep around the auth required state of the _current_
@@ -150,7 +150,7 @@ class ClientManager(object):
         ) and not self._cli_options.auth.get('password'):
             self._cli_options.auth['password'] = self._pw_callback()
 
-        LOG.info('Using auth plugin: %s', self.auth_plugin_name)
+        LOG.debug('Using auth plugin: %s', self.auth_plugin_name)
         LOG.debug(
             'Using parameters %s',
             strutils.mask_password(self._cli_options.auth),
@@ -209,7 +209,7 @@ class ClientManager(object):
         return self._auth_ref
 
     def _override_for(self, service_type):
-        key = '%s_endpoint_override' % service_type.replace('-', '_')
+        key = '{}_endpoint_override'.format(service_type.replace('-', '_'))
         return self._cli_options.config.get(key)
 
     def is_service_available(self, service_type):

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/command/command.py

@@ -29,13 +29,13 @@ class CommandMeta(abc.ABCMeta):
             cls_dict['log'] = logging.getLogger(
                 cls_dict['__module__'] + '.' + name
             )
-        return super(CommandMeta, mcs).__new__(mcs, name, bases, cls_dict)
+        return super().__new__(mcs, name, bases, cls_dict)
 
 
 class Command(command.Command, metaclass=CommandMeta):
     def run(self, parsed_args):
         self.log.debug('run(%s)', parsed_args)
-        return super(Command, self).run(parsed_args)
+        return super().run(parsed_args)
 
     def validate_os_beta_command_enabled(self):
         if not self.app.options.os_beta_command:

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/exceptions.py

@@ -68,7 +68,7 @@ class ClientException(Exception):
         self.details = details
 
     def __str__(self):
-        return "%s (HTTP %s)" % (self.message, self.code)
+        return f"{self.message} (HTTP {self.code})"
 
 
 class BadRequest(ClientException):

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/logs.py

@@ -114,7 +114,7 @@ class _FileFormatter(logging.Formatter):
         logging.Formatter.__init__(self, self.fmt, self._LOG_DATE_FORMAT)
 
 
-class LogConfigurator(object):
+class LogConfigurator:
     _CONSOLE_MESSAGE_FORMAT = '%(message)s'
 
     def __init__(self, options):

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/shell.py

@@ -107,7 +107,7 @@ class OpenStackShell(app.App):
         else:
             cm = command_manager
 
-        super(OpenStackShell, self).__init__(
+        super().__init__(
             description=__doc__.strip(),
             version=version,
             command_manager=cm,
@@ -134,7 +134,7 @@ class OpenStackShell(app.App):
         ret_val = 1
         self.command_options = argv
         try:
-            ret_val = super(OpenStackShell, self).run(argv)
+            ret_val = super().run(argv)
             return ret_val
         except Exception as e:
             if not logging.getLogger('').handlers:
@@ -147,7 +147,7 @@ class OpenStackShell(app.App):
             return ret_val
 
         finally:
-            self.log.info("END return value: %s", ret_val)
+            self.log.debug("END return value: %s", ret_val)
 
     def init_profile(self):
         self.do_profile = osprofiler_profiler and self.options.profile
@@ -165,20 +165,19 @@ class OpenStackShell(app.App):
             # printed. In fact we can define custom log level here with value
             # bigger than most big default one (CRITICAL) or something like
             # that (PROFILE = 60 for instance), but not sure we need it here.
-            self.log.warning("Trace ID: %s" % trace_id)
+            self.log.warning(f"Trace ID: {trace_id}")
             self.log.warning(
-                "Short trace ID "
-                "for OpenTracing-based drivers: %s" % short_id
+                "Short trace ID " f"for OpenTracing-based drivers: {short_id}"
             )
             self.log.warning(
                 "Display trace data with command:\n"
-                "osprofiler trace show --html %s " % trace_id
+                f"osprofiler trace show --html {trace_id} "
             )
 
     def run_subcommand(self, argv):
         self.init_profile()
         try:
-            ret_value = super(OpenStackShell, self).run_subcommand(argv)
+            ret_value = super().run_subcommand(argv)
         finally:
             self.close_profile()
         return ret_value
@@ -186,15 +185,13 @@ class OpenStackShell(app.App):
     def interact(self):
         self.init_profile()
         try:
-            ret_value = super(OpenStackShell, self).interact()
+            ret_value = super().interact()
         finally:
             self.close_profile()
         return ret_value
 
     def build_option_parser(self, description, version):
-        parser = super(OpenStackShell, self).build_option_parser(
-            description, version
-        )
+        parser = super().build_option_parser(description, version)
 
         # service token auth argument
         parser.add_argument(
@@ -416,7 +413,7 @@ class OpenStackShell(app.App):
         """
 
         # Parent __init__ parses argv into self.options
-        super(OpenStackShell, self).initialize_app(argv)
+        super().initialize_app(argv)
         self.log.info(
             "START with options: %s",
             strutils.mask_password(" ".join(self.command_options)),
@@ -435,7 +432,7 @@ class OpenStackShell(app.App):
                     'auth_type': self._auth_type,
                 },
             )
-        except (IOError, OSError) as e:
+        except OSError as e:
             self.log.critical("Could not read clouds.yaml configuration file")
             self.print_help_if_requested()
             raise e
@@ -478,7 +475,7 @@ class OpenStackShell(app.App):
 
     def prepare_to_run_command(self, cmd):
         """Set up auth and API versions"""
-        self.log.info(
+        self.log.debug(
             'command: %s -> %s.%s (auth=%s)',
             getattr(cmd, 'cmd_name', '<none>'),
             cmd.__class__.__module__,

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/tests/api/fakes.py

@@ -50,6 +50,6 @@ class TestSession(utils.TestCase):
     BASE_URL = 'https://api.example.com:1234/test'
 
     def setUp(self):
-        super(TestSession, self).setUp()
+        super().setUp()
         self.sess = session.Session()
         self.requests_mock = self.useFixture(fixture.Fixture())

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/tests/api/test_api.py

@@ -23,7 +23,7 @@ from osc_lib.tests.api import fakes as api_fakes
 
 class TestBaseAPIDefault(api_fakes.TestSession):
     def setUp(self):
-        super(TestBaseAPIDefault, self).setUp()
+        super().setUp()
         self.api = api.BaseAPI()
 
     def test_baseapi_request_no_url(self):
@@ -186,7 +186,7 @@ class TestBaseAPIEndpointArg(api_fakes.TestSession):
 
 class TestBaseAPIArgs(api_fakes.TestSession):
     def setUp(self):
-        super(TestBaseAPIArgs, self).setUp()
+        super().setUp()
         self.api = api.BaseAPI(
             session=self.sess,
             endpoint=self.BASE_URL,
@@ -220,7 +220,7 @@ class TestBaseAPIArgs(api_fakes.TestSession):
 
 class TestBaseAPICreate(api_fakes.TestSession):
     def setUp(self):
-        super(TestBaseAPICreate, self).setUp()
+        super().setUp()
         self.api = api.BaseAPI(
             session=self.sess,
             endpoint=self.BASE_URL,
@@ -258,7 +258,7 @@ class TestBaseAPICreate(api_fakes.TestSession):
 
 class TestBaseAPIFind(api_fakes.TestSession):
     def setUp(self):
-        super(TestBaseAPIFind, self).setUp()
+        super().setUp()
         self.api = api.BaseAPI(
             session=self.sess,
             endpoint=self.BASE_URL,
@@ -452,7 +452,7 @@ class TestBaseAPIFind(api_fakes.TestSession):
 
 class TestBaseAPIList(api_fakes.TestSession):
     def setUp(self):
-        super(TestBaseAPIList, self).setUp()
+        super().setUp()
         self.api = api.BaseAPI(
             session=self.sess,
             endpoint=self.BASE_URL,

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/tests/api/test_utils.py

@@ -24,7 +24,7 @@ class TestBaseAPIFilter(api_fakes.TestSession):
     """The filters can be tested independently"""
 
     def setUp(self):
-        super(TestBaseAPIFilter, self).setUp()
+        super().setUp()
         self.api = api.BaseAPI(
             session=self.sess,
             endpoint=self.BASE_URL,

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/tests/cli/test_client_config.py

@@ -17,7 +17,7 @@ from osc_lib.tests import utils
 
 class TestOSCConfig(utils.TestCase):
     def setUp(self):
-        super(TestOSCConfig, self).setUp()
+        super().setUp()
 
         self.cloud = client_config.OSC_Config()
 

{osc-lib-3.1.0 → osc-lib-3.2.0}/osc_lib/tests/cli/test_format_columns.py

@@ -104,7 +104,7 @@ class TestListDictColumn(utils.TestCase):
         # OrderedDict is a subclass of dict and would inadvertently pass
         self.assertEqual(type(col.machine_readable()), list)  # noqa: H212
         for x in col.machine_readable():
-            self.assertEqual(type(x), dict)  # noqa: H212
+            self.assertEqual(type(x), dict)  # noqa: H211
 
 
 class TestSizeColumn(utils.TestCase):