feat(Quality): Add Quality Tools: Flake8 & BugBear

.flake8

@@ -0,0 +1,18 @@
+[flake8]
+extend-exclude = venv*,*lib,*test
+
+max-line-length = 160
+max-doc-length = 160
+indent-size = 2
+show_source = True
+statistics = True
+count = True
+
+ignore =
+    D10
+    D204
+    D401
+    E126
+
+require-plugins =
+    flake8-bugbear

.github/workflows/quality.yaml

@@ -0,0 +1,31 @@
+# Copyright 2022 Expedia, Inc.
+#
+# 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.
+
+name: Quality Checks
+on: push
+jobs:
+  flake8-lint:
+    runs-on: ubuntu-latest
+    name: Lint
+    steps:
+      - name: Check out source repository
+        uses: actions/checkout@v3
+      - name: Set up Python environment
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: Install Dependencies
+        run: pip install -r requirements.txt
+      - name: flake8 Lint
+        uses: py-actions/flake8@v2

QUALITY.md

@@ -0,0 +1,6 @@
+# Run Quality Checks
+
+To run the code quality checks, run the following command:
+```bash
+flake8
+```

generator/scripts/add-imports.py

@@ -15,9 +15,7 @@
 # limitations under the License.
 
 
-"""
-Add imports to all generated models.
-"""
+"""Add imports to all generated models."""
 
 import pathlib
 import ast

openworld/__init__.py

@@ -11,4 +11,3 @@
 # 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.
-

openworld/sdk/__init__.py

@@ -11,4 +11,3 @@
 # 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.
-

openworld/sdk/core/client/__init__.py

@@ -11,4 +11,3 @@
 # 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.
-

openworld/sdk/core/client/api.py

@@ -18,7 +18,7 @@
 from typing import Any, Dict, Optional
 from datetime import datetime
 
-from openworld.sdk.core.constant import header as header_constant, body, constant
+from openworld.sdk.core.constant import header as header_constant
 from openworld.sdk.core.util import log as log_util
 from openworld.sdk.core.constant import log as log_constant
 from http import HTTPStatus
@@ -71,7 +71,6 @@ def call(self, method: str, url: str, obj: Any = None, request_headers: Optional
         :return: response as object
         :rtype: Any
         """
-
         self.__auth_client.refresh_token()
 
         request_headers = ApiClient.__fill_request_headers(request_headers)

openworld/sdk/core/client/auth_client.py

@@ -79,7 +79,6 @@ def refresh_token(self) -> None:
         :return: the new token.
         :rtype: requests.Response
         """
-
         if not self.__token.is_about_expired():
             return
 

openworld/sdk/core/configuration/__init__.py

@@ -11,4 +11,3 @@
 # 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.
-

openworld/sdk/core/configuration/auth_config.py

@@ -20,11 +20,13 @@
 
 from openworld.sdk.core.model.exception import client as client_exception
 
+DEFAULT_CREDENTIALS = Credentials(key=EMPTY_STRING, secret=EMPTY_STRING)
+
 
 @dataclass
 class AuthConfig:
     def __init__(self,
-                 credentials: Credentials = Credentials(key=EMPTY_STRING, secret=EMPTY_STRING),
+                 credentials: Credentials = DEFAULT_CREDENTIALS,
                  auth_endpoint: str = AUTH_ENDPOINT):
         r"""Holds authentication config data.
 
@@ -40,7 +42,7 @@ def __init__(self,
     def __post_init__(self):
         missing = list()
 
-        for attribute in [('Key',self.__credentials.key),
+        for attribute in [('Key', self.__credentials.key),
                           ('Secret', self.__credentials.secret),
                           ('Auth_Endpoint', self.__auth_endpoint)]:
 

openworld/sdk/core/configuration/client_config.py

@@ -37,16 +37,14 @@ def __init__(self,
         :param endpoint: An optional API endpoint to use for requests.
         :param auth_endpoint: An optional API endpoint to use for authentication.
         """
-
         self.__auth_config = AuthConfig(Credentials(key, secret), auth_endpoint)
         self.__endpoint = endpoint
 
         self.__post_init__()
 
     def __post_init__(self):
         if not self.__endpoint:
-            raise client_exception.OpenWorldConfigurationException(
-                message.NONE_VALUE_NOT_ALLOWED_FOR_MESSAGE_TEMPLATE.format(self.__endpoint))
+            raise client_exception.OpenWorldConfigurationException(message.NONE_VALUE_NOT_ALLOWED_FOR_MESSAGE_TEMPLATE.format(self.__endpoint))
 
     @property
     def auth_config(self) -> AuthConfig:

openworld/sdk/core/constant/__init__.py

@@ -11,4 +11,3 @@
 # 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.
-

openworld/sdk/core/constant/log.py

@@ -12,9 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import requests
-
-from openworld.sdk.core.constant import constant
 
 TOKEN_RENEWAL_IN_PROCESS: str = "Renewing token"
 
@@ -29,11 +26,11 @@
 NEW_TOKEN_EXPIRATION_TEMPLATE: str = 'New token expires in {0} seconds'
 
 HTTP_HEADERS_LOG_MESSAGE_TEMPLATE: str = '\tHeaders: \n' \
-                                '\t--- BEGIN ---\n' \
-                                '{0}' \
-                                '\t--- END ---\n'
+                                         '\t--- BEGIN ---\n' \
+                                         '{0}' \
+                                         '\t--- END ---\n'
 
 HTTP_BODY_LOG_MESSAGE_TEMPLATE: str = '\n\tBody: \n' \
-                             '\t--- BEGIN ---\n' \
-                             '{0}' \
-                             '\t--- END ---\n'
+                                      '\t--- BEGIN ---\n' \
+                                      '{0}' \
+                                      '\t--- END ---\n'

openworld/sdk/core/model/__init__.py

@@ -11,4 +11,3 @@
 # 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.
-

openworld/sdk/core/model/authentication.py

@@ -32,6 +32,7 @@
 @dataclass
 class Credentials:
     """A pair of client key and secret."""
+
     key: str
     secret: str
 
@@ -40,6 +41,7 @@ class Credentials:
 @dataclass
 class _TokenResponse:
     """A model of an API response."""
+
     access_token: str
     expires_in: int
     scope: str
@@ -59,8 +61,7 @@ def __init__(self, data: Dict):
         self.lock = Lock()
         self.__expiration_time = datetime.datetime.now() + datetime.timedelta(seconds=self.__token.expires_in)
 
-        LOG.info(log.OPENWORLD_LOG_MESSAGE_TEMPLATE.format(
-            log.NEW_TOKEN_EXPIRATION_TEMPLATE.format(str(self.__token.expires_in))))
+        LOG.info(log.OPENWORLD_LOG_MESSAGE_TEMPLATE.format(log.NEW_TOKEN_EXPIRATION_TEMPLATE.format(str(self.__token.expires_in))))
 
     @property
     def refresh_token(self) -> str:
@@ -78,8 +79,7 @@ def is_expired(self):
         return datetime.datetime.now() >= self.__expiration_time
 
     def is_about_expired(self):
-        return datetime.datetime.now() + datetime.timedelta(
-            seconds=REFRESH_TOKEN_TIME_GAP_IN_SECONDS) >= self.__expiration_time
+        return datetime.datetime.now() + datetime.timedelta(seconds=REFRESH_TOKEN_TIME_GAP_IN_SECONDS) >= self.__expiration_time
 
     def update(self, data: Dict):
         self.__token = _TokenResponse.from_dict(data)
@@ -89,6 +89,7 @@ def update(self, data: Dict):
 @dataclass
 class HttpBearerAuth(AuthBase):
     r"""Holds Bearer access token."""
+
     __access_token: str
 
     def __init__(self, access_token):

openworld/sdk/core/setup.py

@@ -14,23 +14,26 @@
 
 from setuptools import setup
 
-setup(
-    name='openworld-sdk-python-core',
-    # TODO: Version should be received from another party (say GitHub actions)
-    version='0.0.1-alpha.1',
-    packages=[
-        'openworld.sdk.core',
-        'openworld.sdk.core.configuration',
-        'openworld.sdk.core.client',
-        'openworld.sdk.core.constant',
-        'openworld.sdk.core.model',
-        'openworld.sdk.core.model.exception',
-        'openworld.sdk.core.util'
-    ],
-    package_dir={'openworld.sdk.core': '.'},
-    license='Apache License, Version 2.0',
-    author='Expedia Group',
-    install_requires=['dataclasses_json', 'uri', 'requests', 'python-dateutil'],
-    description='The Open World SDK for Python allows Expedia Group partners to easily build Python applications that '
-                'leverage the Open World (TM) platform. '
-)
+setup(name='openworld-sdk-python-core',
+      # TODO: Version should be received from another party (say GitHub actions)
+      version='0.0.1-alpha.1',
+      packages=[
+          'openworld.sdk.core',
+          'openworld.sdk.core.configuration',
+          'openworld.sdk.core.client',
+          'openworld.sdk.core.constant',
+          'openworld.sdk.core.model',
+          'openworld.sdk.core.model.exception',
+          'openworld.sdk.core.util'
+      ],
+      package_dir={'openworld.sdk.core': '.'},
+      license='Apache License, Version 2.0',
+      author='Expedia Group',
+      install_requires=[
+          'dataclasses_json',
+          'uri',
+          'requests',
+          'python-dateutil'
+      ],
+      description='The Open World SDK for Python allows Expedia Group partners to easily build Python applications that leverage the Open World (TM) platform.'
+      )

openworld/sdk/core/util/__init__.py

@@ -11,4 +11,3 @@
 # 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.
-

openworld/sdk/core/util/log.py

@@ -27,7 +27,7 @@ def response_log(response: requests.Response):
     if not headers_log.endswith('\n'):
         headers_log += '\n'
 
-    result: str = f'\nResponse:\n' + \
+    result: str = '\nResponse:\n' + \
                   log.HTTP_HEADERS_LOG_MESSAGE_TEMPLATE.format(headers_log) + \
                   log.HTTP_BODY_LOG_MESSAGE_TEMPLATE.format('\t\t' + response.text + '\n')
 

requirements.txt

@@ -4,4 +4,6 @@ dataclasses_json
 build
 setuptools
 virtualenv
-coverage
+coverage
+flake8~=6.0.0
+flake8-bugbear~=22.12.6

validate_test_coverage.py

@@ -17,10 +17,10 @@
 
 MINIMUM_REQUIRED_COVERAGE_PERCENTAGE: int = 90
 FAILURE_MESSAGE_TEMPLATE: str = 'Coverage Validation Failed!\n' \
-                       'Minimum Required Coverage Percentage: {0}%\n' \
-                       'Current Coverage Percentage: {1}%'
+                                'Minimum Required Coverage Percentage: {0}%\n' \
+                                'Current Coverage Percentage: {1}%'
 SUCCESS_MESSAGE_TEMPLATE: str = 'Coverage Validation Succeed!\n' \
-                       'Current Coverage Percentage: {0}%'
+                                'Current Coverage Percentage: {0}%'
 
 
 def validate_test_coverage(report: dict):