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

{osc-lib-3.1.0 → osc_lib-4.0.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-4.0.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: v5.0.0
     hooks:
       - id: trailing-whitespace
       - id: mixed-line-ending
@@ -18,22 +18,34 @@ 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.9.6
     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)/.*$'
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        additional_dependencies:
+          - cliff
+          - keystoneauth1
+          - types-requests
+        # keep this in-sync with '[mypy] exclude' in 'setup.cfg'
+        exclude: |
+          (?x)(
+            doc/.*
+            | examples/.*
+            | releasenotes/.*
+          )

{osc-lib-3.1.0 → osc_lib-4.0.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-4.0.0}/ChangeLog

@@ -1,11 +1,51 @@
 CHANGES
 =======
 
+4.0.0
+-----
+
+* typing: Enable disallow\_subclassing\_any
+* tests: Resolve TODO
+* utils: Deprecate legacy client-specific helpers
+* utils: Remove support for legacy format functions
+* utils: Group similar utilities together
+* utils: Don't warn for partial formatter classes
+* typing: Add typing to osc\_lib.utils
+* typing: Add typing to osc\_lib.command
+* clientmanager: Deprecate ClientCache
+* typing: Add typing to osc\_lib.clientmanager
+* typing: Add typing to osc\_lib.shell
+* typing: Add typing to osc\_lib.logs, osc\_lib.i18n
+* typing: Add typing to osc\_lib.cli
+* api: Deprecate BaseAPI
+* typing: Add typing to osc\_lib.api
+* Remove unused docs Makefile
+* typing: Add typing to osc\_lib.exceptions
+* pre-commit: Enable mypy
+* typing: Fix initial typing issues
+* Update master for stable/2025.1
+* Add pagination helpers
+* pre-commit: Enable ruff S (bandit) checks
+* pre-commit: Bump versions
+* tests: Use consistent output widths
+* reno: Update master for unmaintained/2023.1
+
+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-4.0.0/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.1
+Name: osc-lib
+Version: 4.0.0
+Summary: OpenStackClient Library
+Home-page: https://docs.openstack.org/osc-lib/latest/
+Author: OpenStack
+Author-email: openstack-discuss@lists.openstack.org
+Project-URL: Bug Tracker, https://storyboard.openstack.org/#!/project/openstack/osc-lib
+Project-URL: Documentation, https://docs.openstack.org/osc-lib/latest/
+Project-URL: Source Code, https://opendev.org/openstack/osc-lib/
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: OpenStack
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.8
+License-File: LICENSE
+Requires-Dist: cliff>=4.9.0
+Requires-Dist: keystoneauth1>=5.10.0
+Requires-Dist: openstacksdk>=0.15.0
+Requires-Dist: oslo.i18n>=3.15.3
+Requires-Dist: oslo.utils>=3.33.0
+Requires-Dist: pbr!=2.1.0,>=2.0.0
+Requires-Dist: requests>=2.14.2
+Requires-Dist: stevedore>=1.20.0
+
+=======
+osc-lib
+=======
+
+.. image:: https://img.shields.io/pypi/v/osc-lib.svg
+    :target: https://pypi.org/project/osc-lib/
+    :alt: Latest Version
+
+OpenStackClient (aka OSC) is a command-line client for OpenStack. osc-lib
+is a package of common support modules for writing OSC plugins.
+
+* `PyPi`_ - package installation
+* `Online Documentation`_
+* `Launchpad project`_ - part of OpenStackClient
+* `Bugs`_ - issue tracking
+* `Source`_
+* `Developer` - getting started as a developer
+* `Contributing` - contributing code
+* `Testing` - testing code
+* IRC: #openstack-sdks on OFTC (irc.oftc.net)
+* License: Apache 2.0
+
+.. _PyPi: https://pypi.org/project/osc-lib
+.. _Online Documentation: http://docs.openstack.org/osc-lib/latest/
+.. _Launchpad project: https://launchpad.net/python-openstackclient
+.. _Bugs: https://storyboard.openstack.org/#!/project_group/80
+.. _Source: https://opendev.org/openstack/osc-lib
+.. _Developer: http://docs.openstack.org/project-team-guide/project-setup/python.html
+.. _Contributing: http://docs.openstack.org/infra/manual/developers.html
+.. _Testing: http://docs.openstack.org/osc-lib/latest/contributor/#testing
+.. _Release Notes: https://docs.openstack.org/releasenotes/osc-lib
+
+Getting Started
+===============
+
+osc-lib can be installed from PyPI using pip::
+
+    pip install osc-lib
+
+Transition From OpenStackclient
+===============================
+
+This library was extracted from the main OSC repo after the OSC 2.4.0 release.
+The following are the changes to imports that will cover the majority of
+transition to using osc-lib:
+
+* openstackclient.api.api -> osc_lib.api.api
+* openstackclient.api.auth -> osc_lib.api.auth
+* openstackclient.api.utils -> osc_lib.api.utils
+* openstackclient.common.command -> osc_lib.command.command
+* openstackclient.common.commandmanager -> osc_lib.command.commandmanager
+* openstackclient.common.exceptions -> osc_lib.exceptions
+* openstackclient.common.logs -> osc_lib.logs
+* openstackclient.common.parseractions -> osc_lib.cli.parseractions
+* openstackclient.common.session -> osc_lib.session
+* openstackclient.common.utils -> osc_lib.utils
+* openstackclient.i18n -> osc_lib.i18n
+* openstackclient.shell -> osc_lib.shell
+
+Also, some of the test fixtures and modules may be used:
+
+* openstackclient.tests.fakes -> osc_lib.tests.fakes
+* openstackclient.tests.utils -> osc_lib.tests.utils
+

{osc-lib-3.1.0 → osc_lib-4.0.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-4.0.0}/osc_lib/api/api.py

@@ -12,6 +12,11 @@
 #
 
 """Base API Library"""
+
+import builtins
+import typing as ty
+import warnings
+
 from keystoneauth1 import exceptions as ksa_exceptions
 from keystoneauth1 import session as ksa_session
 import requests
@@ -20,7 +25,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
@@ -41,8 +46,12 @@ class BaseAPI(object):
     HEADER_NAME = "OpenStack-API-Version"
 
     def __init__(
-        self, session=None, service_type=None, endpoint=None, **kwargs
-    ):
+        self,
+        session: ty.Optional[ksa_session.Session] = None,
+        service_type: ty.Optional[str] = None,
+        endpoint: ty.Optional[str] = None,
+        **kwargs: ty.Any,
+    ) -> None:
         """Base object that contains some common API objects and methods
 
         :param keystoneauth1.session.Session session:
@@ -57,7 +66,13 @@ class BaseAPI(object):
             Keyword arguments passed to keystoneauth1.session.Session().
         """
 
-        super(BaseAPI, self).__init__()
+        warnings.warn(
+            'The BaseAPI class is deprecated for removal. Consider using '
+            'openstacksdk instead else vendoring this code into your client',
+            category=DeprecationWarning,
+        )
+
+        super().__init__()
 
         # Create a keystoneauth1.session.Session if one is not supplied
         if not session:
@@ -68,7 +83,7 @@ class BaseAPI(object):
         self.service_type = service_type
         self.endpoint = self._munge_endpoint(endpoint)
 
-    def _munge_endpoint(self, endpoint):
+    def _munge_endpoint(self, endpoint: ty.Optional[str]) -> ty.Optional[str]:
         """Hook to allow subclasses to massage the passed-in endpoint
 
         Hook to massage passed-in endpoints from arbitrary sources,
@@ -89,7 +104,13 @@ class BaseAPI(object):
         else:
             return endpoint
 
-    def _request(self, method, url, session=None, **kwargs):
+    def _request(
+        self,
+        method: str,
+        url: str,
+        session: ty.Optional[ksa_session.Session] = None,
+        **kwargs: ty.Any,
+    ) -> requests.Response:
         """Perform call into session
 
         All API calls are funneled through this method to provide a common
@@ -135,7 +156,13 @@ class BaseAPI(object):
 
     # The basic action methods all take a Session and return dict/lists
 
-    def create(self, url, session=None, method=None, **params):
+    def create(
+        self,
+        url: str,
+        session: ty.Optional[ksa_session.Session] = None,
+        method: ty.Optional[str] = None,
+        **params: ty.Any,
+    ) -> ty.Union[requests.Response, ty.Any]:
         """Create a new resource
 
         :param string url:
@@ -155,7 +182,12 @@ class BaseAPI(object):
         except requests.JSONDecodeError:
             return ret
 
-    def delete(self, url, session=None, **params):
+    def delete(
+        self,
+        url: str,
+        session: ty.Optional[ksa_session.Session] = None,
+        **params: ty.Any,
+    ) -> requests.Response:
         """Delete a resource
 
         :param string url:
@@ -168,13 +200,13 @@ class BaseAPI(object):
 
     def list(
         self,
-        path,
-        session=None,
-        body=None,
-        detailed=False,
-        headers=None,
-        **params
-    ):
+        path: str,
+        session: ty.Optional[ksa_session.Session] = None,
+        body: ty.Any = None,
+        detailed: bool = False,
+        headers: ty.Optional[dict[str, str]] = None,
+        **params: ty.Any,
+    ) -> ty.Union[requests.Response, ty.Any]:
         """Return a list of resources
 
         GET ${ENDPOINT}/${PATH}?${PARAMS}
@@ -225,11 +257,11 @@ class BaseAPI(object):
 
     def find_attr(
         self,
-        path,
-        value=None,
-        attr=None,
-        resource=None,
-    ):
+        path: str,
+        value: ty.Optional[str] = None,
+        attr: ty.Optional[str] = None,
+        resource: ty.Optional[str] = None,
+    ) -> ty.Any:
         """Find a resource via attribute or ID
 
         Most APIs return a list wrapped by a dict with the resource
@@ -259,7 +291,7 @@ class BaseAPI(object):
         if resource is None:
             resource = path
 
-        def getlist(kw):
+        def getlist(kw: dict[str, ty.Any]) -> ty.Any:
             """Do list call, unwrap resource dict if present"""
             ret = self.list(path, **kw)
             if isinstance(ret, dict) and resource in ret:
@@ -289,7 +321,12 @@ class BaseAPI(object):
             msg % {'resource': resource, 'attr': attr, 'value': value}
         )
 
-    def find_bulk(self, path, headers=None, **kwargs):
+    def find_bulk(
+        self,
+        path: str,
+        headers: ty.Optional[dict[str, str]] = None,
+        **kwargs: ty.Any,
+    ) -> builtins.list[ty.Any]:
         """Bulk load and filter locally
 
         :param string path:
@@ -317,7 +354,7 @@ class BaseAPI(object):
 
         return ret
 
-    def find_one(self, path, **kwargs):
+    def find_one(self, path: str, **kwargs: ty.Any) -> ty.Any:
         """Find a resource by name or ID
 
         :param string path:
@@ -338,11 +375,11 @@ class BaseAPI(object):
 
     def find(
         self,
-        path,
-        value=None,
-        attr=None,
-        headers=None,
-    ):
+        path: str,
+        value: ty.Optional[str] = None,
+        attr: ty.Optional[str] = None,
+        headers: ty.Optional[dict[str, str]] = None,
+    ) -> ty.Any:
         """Find a single resource by name or ID
 
         :param string path:
@@ -355,14 +392,14 @@ class BaseAPI(object):
             Headers dictionary to pass to requests
         """
 
-        def raise_not_found():
+        def raise_not_found() -> ty.NoReturn:
             msg = _("%s not found") % value
             raise exceptions.NotFound(404, msg)
 
         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-4.0.0}/osc_lib/api/auth.py

@@ -14,7 +14,9 @@
 """Authentication Library"""
 
 import argparse
+import typing as ty
 
+from keystoneauth1.identity import base as identity_base
 from keystoneauth1.identity.v3 import k2k
 from keystoneauth1.loading import base
 
@@ -22,16 +24,25 @@ from osc_lib import exceptions as exc
 from osc_lib.i18n import _
 from osc_lib import utils
 
+if ty.TYPE_CHECKING:
+    from openstack import connection
+
 
 # Initialize the list of Authentication plugins early in order
 # to get the command-line options
 PLUGIN_LIST = None
 
+
+class _OptionDict(ty.TypedDict):
+    env: str
+    help: str
+
+
 # List of plugin command line options
-OPTIONS_LIST = {}
+OPTIONS_LIST: dict[str, _OptionDict] = {}
 
 
-def get_plugin_list():
+def get_plugin_list() -> frozenset[str]:
     """Gather plugin list and cache it"""
 
     global PLUGIN_LIST
@@ -41,7 +52,7 @@ def get_plugin_list():
     return PLUGIN_LIST
 
 
-def get_options_list():
+def get_options_list() -> dict[str, _OptionDict]:
     """Gather plugin options so the help action has them available"""
 
     global OPTIONS_LIST
@@ -59,14 +70,16 @@ 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
 
 
-def check_valid_authorization_options(options, auth_plugin_name):
+def check_valid_authorization_options(
+    options: 'connection.Connection',
+    auth_plugin_name: str,
+) -> None:
     """Validate authorization options, and provide helpful error messages."""
     if (
         options.auth.get('project_id')
@@ -87,16 +100,15 @@ def check_valid_authorization_options(options, auth_plugin_name):
         )
 
 
-def check_valid_authentication_options(options, auth_plugin_name):
-    """Validate authentication options, and provide helpful error messages
-
-    :param required_scope: indicate whether a scoped token is required
-
-    """
-
+def check_valid_authentication_options(
+    options: 'connection.Connection',
+    auth_plugin_name: str,
+) -> None:
+    """Validate authentication options, and provide helpful error messages."""
     # Get all the options defined within the plugin.
-    plugin_opts = base.get_plugin_options(auth_plugin_name)
-    plugin_opts = {opt.dest: opt for opt in plugin_opts}
+    plugin_opts = {
+        opt.dest: opt for opt in base.get_plugin_options(auth_plugin_name)
+    }
 
     # NOTE(aloga): this is an horrible hack. We need a way to specify the
     # required options in the plugins. Using the "required" argument for
@@ -142,7 +154,9 @@ def check_valid_authentication_options(options, auth_plugin_name):
         )
 
 
-def build_auth_plugins_option_parser(parser):
+def build_auth_plugins_option_parser(
+    parser: argparse.ArgumentParser,
+) -> argparse.ArgumentParser:
     """Auth plugins options builder
 
     Builds dynamically the list of options expected by each available
@@ -177,7 +191,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'],
@@ -207,13 +221,13 @@ def build_auth_plugins_option_parser(parser):
 
 
 def get_keystone2keystone_auth(
-    local_auth,
-    service_provider,
-    project_id=None,
-    project_name=None,
-    project_domain_id=None,
-    project_domain_name=None,
-):
+    local_auth: identity_base.BaseIdentityPlugin,
+    service_provider: str,
+    project_id: ty.Optional[str] = None,
+    project_name: ty.Optional[str] = None,
+    project_domain_id: ty.Optional[str] = None,
+    project_domain_name: ty.Optional[str] = None,
+) -> k2k.Keystone2Keystone:
     """Return Keystone 2 Keystone authentication for service provider.
 
     :param local_auth: authentication to use with the local Keystone

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

@@ -13,13 +13,18 @@
 
 """API Utilities Library"""
 
+import typing as ty
+
+
+_T = ty.TypeVar('_T', bound=list[ty.Any])
+
 
 def simple_filter(
-    data=None,
-    attr=None,
-    value=None,
-    property_field=None,
-):
+    data: ty.Optional[_T] = None,
+    attr: ty.Optional[str] = None,
+    value: ty.Optional[str] = None,
+    property_field: ty.Optional[str] = None,
+) -> ty.Optional[_T]:
     """Filter a list of dicts
 
     :param list data: