Merge pull request 3scale-qe#175 from mdujava/codestyle

mdujava · web-flow · commit bf1c118b4116 · 2026-05-13T10:15:54.000+02:00
Some codestyle changes
diff --git a/.github/workflows/lint-and-smoke.yml b/.github/workflows/lint-and-smoke.yml
@@ -21,7 +21,7 @@ jobs:
           pipenv install --dev
       - name: lint
         run: |
-          pipenv run python -m flake8 .
+          pipenv run python -m flake8 threescale_api/
       - name: smoke
         run: |
           pipenv run python -m pytest -m smoke
diff --git a/Pipfile b/Pipfile
@@ -1,18 +1,21 @@
-[[source]]
-name = "pypi"
-url = "https://pypi.org/simple"
-verify_ssl = true
-
 [dev-packages]
+black = "*"
+flake8 = "*"
+mypy = "*"
 pylint = "*"
-pytest = "*"
 responses = "*"
+types-requests = "*"
+
 python-dotenv = "*"
-flake8 = "*"
+pytest = "<9.0.0"
+
+#python-language-server = "*"
+#pyls-mypy = "*"
+#pyls-isort = "*"
 
 [packages]
 requests = "*"
-backoff = "*"
+python-backoff = "*"
 
 [requires]
 python_version = "3"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,48 @@
+[metadata]
+name = 3scale-api
+version = 0.35.2
+description = 3scale API python client
+author = Peter Stanko
+author_email = stanko@mail.muni.cz
+maintainer = Matej Dujava
+maintainer_email = mdujava@redhat.com
+url = https://github.com/3scale-qe/3scale-api-python
+license = Apache-2.0
+license_files = LICENSE
+long_description = file: README.md
+long_description_content_type = text/markdown
+classifiers =
+    Operating System :: OS Independent
+    Intended Audience :: Developers
+    Topic :: Utilities
+    Programming Language :: Python :: 3
+
+[options]
+packages = find:
+include_package_data = True
+install_requires =
+    requests
+    python-backoff
+
+[options.packages.find]
+exclude = tests
+
+[options.extras_require]
+dev =
+    coverage
+    flake8
+    mypy
+    pylint
+    pytest
+    python-dotenv
+    responses
+docs = sphinx
+
+[flake8]
+max-line-length = 120
+ignore = E203,W503
+
+[mypy]
+ignore_missing_imports = True
+check_untyped_defs = true
+local_partial_types = true
diff --git a/setup.py b/setup.py
@@ -1,49 +1,3 @@
-import re
-import sys
+from setuptools import setup
 
-from setuptools import find_packages, setup
-
-with open("README.md", "r") as fh:
-    long_description = fh.read()
-
-VERSION = "devel"
-if sys.argv[1] == "--release-version":
-    sys.argv.pop(1)
-    VERSION = sys.argv.pop(1)
-    assert re.match(r"[0-9]+\.[0-9]+\.[0-9]+", VERSION), "Version definition required as first arg"
-
-requirements = ["requests", "backoff"]
-
-extra_requirements = {"dev": ["pytest", "coverage", "python-dotenv", "responses"], "docs": ["sphinx"]}
-
-setup(
-    name="3scale-api",
-    version=VERSION,
-    description="3scale API python client",
-    author="Peter Stanko",
-    author_email="stanko@mail.muni.cz",
-    maintainer="Matej Dujava",
-    maintainer_email="mdujava@redhat.com",
-    url="https://github.com/3scale-qe/3scale-api-python",
-    packages=find_packages(exclude=("tests",)),
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    include_package_data=True,
-    install_requires=requirements,
-    extras_require=extra_requirements,
-    entry_points={},
-    classifiers=[
-        "Operating System :: OS Independent",
-        "License :: OSI Approved :: Apache Software License",
-        "Intended Audience :: Developers",
-        "Topic :: Utilities",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-        "Programming Language :: Python :: 3.13",
-    ],
-)
+setup()
diff --git a/tests/integration/auth/test_app_key_authorization.py b/tests/integration/auth/test_app_key_authorization.py
@@ -19,7 +19,7 @@ def proxy(service, proxy):
 def test_app_key_authorization(proxy, application, ssl_verify):
     creds = application.authobj().credentials
     encoded = base64.b64encode(
-        f"{creds['app_id']}:{creds['app_key']}".encode("utf-8")).decode("utf-8")
+        f"{creds['app_id']}:{creds['app_key']}".encode()).decode("utf-8")
 
     response = application.test_request(verify=ssl_verify)
 
diff --git a/tests/integration/test_integration_response_headers.py b/tests/integration/test_integration_response_headers.py
@@ -1,4 +1,3 @@
-
 def test_x_served_by(api):
     response = api._rest.get(url=api.admin_api_url + '/accounts')
     assert response.status_code == 200
diff --git a/tests/integration/test_integration_service_plans.py b/tests/integration/test_integration_service_plans.py
@@ -1,5 +1,3 @@
-
-
 from tests.integration import asserts
 
 def test_list_service_plans(service):
diff --git a/tests/integration/test_integration_service_subscriptions.py b/tests/integration/test_integration_service_subscriptions.py
@@ -1,4 +1,3 @@
-
 from tests.integration import asserts
 
 def test_list_service_subscriptions(account):
diff --git a/threescale_api/auth.py b/threescale_api/auth.py
@@ -38,9 +38,7 @@ class UserKeyAuth(BaseClientAuth):
 
     def __init__(self, app, location=None):
         super().__init__(app, location)
-        self.credentials = {
-            self.app.service.proxy.list()["auth_user_key"]: self.app["user_key"]
-        }
+        self.credentials = {self.app.service.proxy.list()["auth_user_key"]: self.app["user_key"]}
 
     def __call__(self, request):
         if self.location == "authorization":
@@ -57,7 +55,7 @@ def __init__(self, app, location=None):
         proxy = self.app.service.proxy.list()
         self.credentials = {
             proxy["auth_app_id"]: self.app["application_id"],
-            proxy["auth_app_key"]: self.app.keys.list()[-1]["value"]
+            proxy["auth_app_key"]: self.app.keys.list()[-1]["value"],
         }
 
     def __call__(self, request):
diff --git a/threescale_api/client.py b/threescale_api/client.py
@@ -11,8 +11,7 @@
 
 
 class ThreeScaleClient:
-    def __init__(self, url: str, token: str,
-                 throws: bool = True, ssl_verify: bool = True, wait: int = -1):
+    def __init__(self, url: str, token: str, throws: bool = True, ssl_verify: bool = True, wait: int = -1):
         """Creates instance of the 3scale client
         Args:
             url: 3scale instance url
@@ -25,40 +24,37 @@ def __init__(self, url: str, token: str,
         self._rest = RestApiClient(url=url, token=token, throws=throws, ssl_verify=ssl_verify)
         self._services = resources.Services(self, instance_klass=resources.Service)
         self._accounts = resources.Accounts(self, instance_klass=resources.Account)
-        self._provider_accounts = \
-            resources.ProviderAccounts(self, instance_klass=resources.ProviderAccount)
-        self._provider_account_users = \
-            resources.ProviderAccountUsers(self, instance_klass=resources.ProviderAccountUser)
+        self._provider_accounts = resources.ProviderAccounts(self, instance_klass=resources.ProviderAccount)
+        self._provider_account_users = resources.ProviderAccountUsers(
+            self, instance_klass=resources.ProviderAccountUser
+        )
         self._methods = resources.Methods(self, instance_klass=resources.Method)
         self._metrics = resources.Metrics(self, instance_klass=resources.Metric)
         self._analytics = resources.Analytics(self)
         self._tenants = resources.Tenants(self, instance_klass=resources.Tenant)
         self._providers = resources.Providers(self, instance_klass=resources.Provider)
-        self._access_tokens = \
-            resources.AccessTokens(self, instance_klass=resources.AccessToken)
+        self._access_tokens = resources.AccessTokens(self, instance_klass=resources.AccessToken)
         self._active_docs = resources.ActiveDocs(self, instance_klass=resources.ActiveDoc)
-        self._application_plans = \
-            resources.ApplicationPlans(self, instance_klass=resources.ApplicationPlan)
+        self._application_plans = resources.ApplicationPlans(self, instance_klass=resources.ApplicationPlan)
         self._account_plans = resources.AccountPlans(self, instance_klass=resources.AccountPlan)
         self._settings = resources.SettingsClient(self)
         self._admin_portal_auth_providers = resources.AdminPortalAuthProviders(
-            self, instance_klass=resources.AdminPortalAuthProvider)
+            self, instance_klass=resources.AdminPortalAuthProvider
+        )
         self._dev_portal_auth_providers = resources.DevPortalAuthProviders(
-            self, instance_klass=resources.DevPortalAuthProvider)
-        self._policy_registry = resources.PoliciesRegistry(self,
-                                                           instance_klass=resources.PolicyRegistry)
+            self, instance_klass=resources.DevPortalAuthProvider
+        )
+        self._policy_registry = resources.PoliciesRegistry(self, instance_klass=resources.PolicyRegistry)
         self._backends = resources.Backends(self, instance_klass=resources.Backend)
         self._webhooks = resources.Webhooks(self)
         self._invoices = resources.Invoices(self, instance_klass=resources.Invoice)
-        self._fields_definitions =\
-            resources.FieldsDefinitions(self, instance_klass=resources.FieldsDefinition)
+        self._fields_definitions = resources.FieldsDefinitions(self, instance_klass=resources.FieldsDefinition)
         self._cms_files = resources.CmsFiles(self, instance_klass=resources.CmsFile)
         self._cms_sections = resources.CmsSections(self, instance_klass=resources.CmsSection)
         self._cms_pages = resources.CmsPages(self, instance_klass=resources.CmsPage)
         self._cms_builtin_pages = resources.CmsBuiltinPages(self, instance_klass=resources.CmsPage)
         self._cms_layouts = resources.CmsLayouts(self, instance_klass=resources.CmsLayout)
-        self._cms_builtin_partials =\
-            resources.CmsBuiltinPartials(self, instance_klass=resources.CmsPartial)
+        self._cms_builtin_partials = resources.CmsBuiltinPartials(self, instance_klass=resources.CmsPartial)
         self._cms_partials = resources.CmsPartials(self, instance_klass=resources.CmsPartial)
 
         if wait >= 0:
@@ -68,8 +64,7 @@ def __init__(self, url: str, token: str,
             # here to mitigate the problem. This requires proper fix in checks
             time.sleep(wait)
 
-    @backoff.on_predicate(
-            backoff.constant, lambda ready: not ready, interval=6, max_tries=90, jitter=None)
+    @backoff.on_predicate(backoff.constant, lambda ready: not ready, interval=6, max_tries=90, jitter=None)
     def wait_for_tenant(self) -> bool:
         """
         When True is returned, there is some chance the tenant is actually ready.
@@ -78,13 +73,15 @@ def wait_for_tenant(self) -> bool:
         # ultimate readiness check. There might be duplicates though, so
         # worth to review it one day
         try:
-            return self.account_plans.exists(throws=True) \
-                and len(self.account_plans.fetch()["plans"]) >= 1 \
-                and len(self.account_plans.list()) >= 1 \
-                and self.accounts.exists(throws=True) \
-                and len(self.accounts.list()) >= 1 \
-                and self.services.exists(throws=True) \
+            return (
+                self.account_plans.exists(throws=True)
+                and len(self.account_plans.fetch()["plans"]) >= 1
+                and len(self.account_plans.list()) >= 1
+                and self.accounts.exists(throws=True)
+                and len(self.accounts.list()) >= 1
+                and self.services.exists(throws=True)
                 and len(self.services.list()) >= 1
+            )
         except errors.ApiClientError as err:
             if err.code in (404, 409, 503):
                 log.info("wait_for_tenant failed: %s", err)
@@ -95,21 +92,21 @@ def wait_for_tenant(self) -> bool:
             return False
 
     @property
-    def rest(self) -> 'RestApiClient':
+    def rest(self) -> "RestApiClient":
         """Get REST api client instance
         Returns(RestApiClient): Rest api client instance
         """
         return self._rest
 
     @property
-    def parent(self) -> 'ThreeScaleClient':
+    def parent(self) -> "ThreeScaleClient":
         """Parent is self - the 3scale client
         Returns(ThreeScaleClient):
         """
         return self
 
     @property
-    def threescale_client(self) -> 'ThreeScaleClient':
+    def threescale_client(self) -> "ThreeScaleClient":
         """3scale client instance
         Returns(ThreeScaleClient): 3scale client instance
         """
@@ -124,7 +121,7 @@ def url(self) -> str:
 
     @property
     def url_with_token(self) -> str:
-        return self.rest.url.replace('//', f"//{self.rest._token}@")
+        return self.rest.url.replace("//", f"//{self.rest._token}@")
 
     @property
     def token(self) -> str:
@@ -314,15 +311,15 @@ def __init__(self, url: str, token: str, throws: bool = True, ssl_verify: bool =
         self._token = token
         self._throws = throws
         self._ssl_verify = ssl_verify
-        log.debug("[REST] New instance: %s token=%s throws=%s ssl=%s", url, token, throws,
-                  ssl_verify)
+        log.debug("[REST] New instance: %s token=%s throws=%s ssl=%s", url, token, throws, ssl_verify)
 
     @property
     def url(self) -> str:
         return self._url
 
-    def request(self, method='GET', url=None, path='', params: dict = None,
-                headers: dict = None, throws=None, **kwargs):
+    def request(
+        self, method="GET", url=None, path="", params: dict = None, headers: dict = None, throws=None, **kwargs
+    ):
         """Create new request
         Args:
             method(str): method to be used to create an request
@@ -336,36 +333,36 @@ def request(self, method='GET', url=None, path='', params: dict = None,
         Returns:
 
         """
-        if 'resource' in kwargs:
-            del kwargs['resource']
+        if "resource" in kwargs:
+            del kwargs["resource"]
         full_url = url if url else urljoin(self.url, path)
         full_url = full_url + ".json"
         headers = headers or {}
         params = params or {}
         if throws is None:
             throws = self._throws
         params.update(access_token=self._token)
-        log.debug("[%s] (%s) params={%s} headers={%s} %s", method, full_url, params, headers,
-                  kwargs if kwargs else '')
-        response = requests.request(method=method, url=full_url, headers=headers,
-                                    params=params, verify=self._ssl_verify, **kwargs)
+        log.debug("[%s] (%s) params={%s} headers={%s} %s", method, full_url, params, headers, kwargs if kwargs else "")
+        response = requests.request(
+            method=method, url=full_url, headers=headers, params=params, verify=self._ssl_verify, **kwargs
+        )
         process_response = self._process_response(response, throws=throws)
         return process_response
 
     def get(self, *args, **kwargs):
-        return self.request('GET', *args, **kwargs)
+        return self.request("GET", *args, **kwargs)
 
     def post(self, *args, **kwargs):
-        return self.request('POST', *args, **kwargs)
+        return self.request("POST", *args, **kwargs)
 
     def put(self, *args, **kwargs):
-        return self.request('PUT', *args, **kwargs)
+        return self.request("PUT", *args, **kwargs)
 
     def delete(self, *args, **kwargs):
-        return self.request('DELETE', *args, **kwargs)
+        return self.request("DELETE", *args, **kwargs)
 
     def patch(self, *args, **kwargs):
-        return self.request('PATCH', *args, **kwargs)
+        return self.request("PATCH", *args, **kwargs)
 
     @classmethod
     def _process_response(cls, response: requests.Response, throws=None) -> requests.Response:
diff --git a/threescale_api/defaults.py b/threescale_api/defaults.py
diff --git a/threescale_api/log_config.py b/threescale_api/log_config.py
diff --git a/threescale_api/resources.py b/threescale_api/resources.py
diff --git a/threescale_api/utils.py b/threescale_api/utils.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`def test_x_served_by(api):`
`3`	`2`	`response = api._rest.get(url=api.admin_api_url + '/accounts')`
`4`	`3`	`assert response.status_code == 200`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-`
`2`		`-`
`3`	`1`	`from tests.integration import asserts`
`4`	`2`
`5`	`3`	`def test_list_service_plans(service):`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-`
`2`	`1`	`from tests.integration import asserts`
`3`	`2`
`4`	`3`	`def test_list_service_subscriptions(account):`