refactor: rearrange imports and add missing blank lines

More info:
  - Surround top-level function and class definitions with two blank
    lines: https://www.python.org/dev/peps/pep-0008/#blank-lines
  - Imports grouping and ordering:
    https://www.python.org/dev/peps/pep-0008/#imports

Author: pyrooka

ibm_cloud_sdk_core/api_exception.py

@@ -13,8 +13,10 @@
 # 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.
-from typing import Optional
+
 from http import HTTPStatus
+from typing import Optional
+
 from requests import Response
 
 

ibm_cloud_sdk_core/authenticators/authenticator.py

@@ -16,6 +16,7 @@
 
 from abc import ABC, abstractmethod
 
+
 class Authenticator(ABC):
     """This interface defines the common methods and constants associated with an Authenticator implementation."""
     @abstractmethod

ibm_cloud_sdk_core/authenticators/bearer_token_authenticator.py

@@ -18,6 +18,7 @@
 
 from .authenticator import Authenticator
 
+
 class BearerTokenAuthenticator(Authenticator):
     """The BearerTokenAuthenticator will add a user-supplied bearer token
     to requests.

ibm_cloud_sdk_core/authenticators/iam_authenticator.py

@@ -20,6 +20,7 @@
 from ..token_managers.iam_token_manager import IAMTokenManager
 from ..utils import has_bad_first_or_last_char
 
+
 class IAMAuthenticator(IAMRequestBasedAuthenticator):
     """The IAMAuthenticator utilizes an apikey, or client_id and client_secret pair to
     obtain a suitable bearer token, and adds it to requests.

ibm_cloud_sdk_core/authenticators/iam_request_based_authenticator.py

@@ -20,6 +20,7 @@
 
 from .authenticator import Authenticator
 
+
 class IAMRequestBasedAuthenticator(Authenticator):
     """The IAMRequestBasedAuthenticator class contains code that is common to all authenticators
     that need to interact with the IAM tokens service to obtain an access token.

ibm_cloud_sdk_core/authenticators/no_auth_authenticator.py

@@ -16,6 +16,7 @@
 
 from .authenticator import Authenticator
 
+
 class NoAuthAuthenticator(Authenticator):
     """Performs no authentication."""
     authentication_type = 'noAuth'

ibm_cloud_sdk_core/base_service.py

@@ -14,26 +14,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import logging
-from http.cookiejar import CookieJar
+import gzip
 import json as json_import
-from os.path import basename
+import logging
 import platform
 import sys
-import gzip
+from http.cookiejar import CookieJar
+from os.path import basename
 from typing import Dict, List, Optional, Tuple, Union
+from urllib3.util.retry import Retry
 
 import requests
 from requests.adapters import HTTPAdapter
 from requests.structures import CaseInsensitiveDict
-from urllib3.util.retry import Retry
+
 from ibm_cloud_sdk_core.authenticators import Authenticator
-from .version import __version__
-from .utils import (has_bad_first_or_last_char, remove_null_values,
-                    cleanup_values, read_external_sources, strip_extra_slashes)
-from .detailed_response import DetailedResponse
 from .api_exception import ApiException
+from .detailed_response import DetailedResponse
 from .token_managers.token_manager import TokenManager
+from .utils import (has_bad_first_or_last_char, remove_null_values,
+                    cleanup_values, read_external_sources, strip_extra_slashes)
+from .version import __version__
 
 # Uncomment this to enable http debugging
 # import http.client as http_client

ibm_cloud_sdk_core/detailed_response.py

@@ -14,11 +14,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import json
 from typing import Dict, Optional
 
-import json
 import requests
 
+
 class DetailedResponse:
     """Custom class for detailed response returned from APIs.
 

ibm_cloud_sdk_core/get_authenticator.py

@@ -18,6 +18,7 @@
                              CloudPakForDataAuthenticator, IAMAuthenticator, NoAuthAuthenticator)
 from .utils import read_external_sources
 
+
 def get_authenticator_from_environment(service_name: str) -> Authenticator:
     """Look for external configuration of authenticator.
 
@@ -38,6 +39,7 @@ def get_authenticator_from_environment(service_name: str) -> Authenticator:
         authenticator = __construct_authenticator(config)
     return authenticator
 
+
 def __construct_authenticator(config: dict) -> Authenticator:
     auth_type = config.get('AUTH_TYPE').lower() if config.get('AUTH_TYPE') else 'iam'
     authenticator = None

ibm_cloud_sdk_core/token_managers/jwt_token_manager.py

@@ -19,13 +19,11 @@
 
 import jwt
 import requests
+
 from .token_manager import TokenManager
 from ..api_exception import ApiException
 
 
-# pylint: disable=too-many-instance-attributes
-
-
 class JWTTokenManager(TokenManager, ABC):
     """An abstract class to contain functionality for parsing, storing, and requesting JWT tokens.
 

ibm_cloud_sdk_core/token_managers/token_manager.py

@@ -15,17 +15,16 @@
 # limitations under the License.
 
 
+import time
 from abc import ABC, abstractmethod
 from threading import Lock
 
-import time
 import requests
 
 from ..api_exception import ApiException
 
 
 # pylint: disable=too-many-instance-attributes
-
 class TokenManager(ABC):
     """An abstract class to contain functionality for parsing, storing, and requesting tokens.
 

ibm_cloud_sdk_core/utils.py

@@ -134,6 +134,7 @@ def string_to_datetime_list(string_list: List[str]) -> List[datetime.datetime]:
         datetime_list.append(string_to_datetime(string_val))
     return datetime_list
 
+
 def datetime_to_string_list(datetime_list: List[datetime.datetime]) -> List[str]:
     """Convert a list of datetime objects to a list of strings.
 
@@ -151,6 +152,7 @@ def datetime_to_string_list(datetime_list: List[datetime.datetime]) -> List[str]
         string_list.append(datetime_to_string(datetime_val))
     return string_list
 
+
 def date_to_string(val: datetime.date) -> str:
     """Convert a date object to string.
 
@@ -176,6 +178,7 @@ def string_to_date(string: str) -> datetime.date:
     """
     return date_parser.parse(string).date()
 
+
 def get_query_param(url_str: str, param: str) -> str:
     """Return a query parameter value from url_str
 
@@ -200,6 +203,7 @@ def get_query_param(url_str: str, param: str) -> str:
     values = query.get(param)
     return values[0] if values else None
 
+
 def convert_model(val: any) -> dict:
     """Convert a model object into an equivalent dict.
 

test/test_api_exception.py

@@ -1,9 +1,12 @@
 # coding=utf-8
 import json
-import responses
+
 import requests
+import responses
+
 from ibm_cloud_sdk_core import ApiException
 
+
 @responses.activate
 def test_api_exception():
     """Test APIException class"""

test/test_base_service.py

@@ -1,23 +1,25 @@
 # coding=utf-8
 # pylint: disable=missing-docstring,protected-access,too-few-public-methods
+import gzip
 import json
-import time
 import os
+import tempfile
+import time
 from shutil import copyfile
 from typing import Optional
-import gzip
-import tempfile
+from urllib3.exceptions import ConnectTimeoutError, MaxRetryError
+
+import jwt
 import pytest
 import responses
 import requests
-import jwt
-from urllib3.exceptions import ConnectTimeoutError, MaxRetryError
-from ibm_cloud_sdk_core import BaseService, DetailedResponse
+
 from ibm_cloud_sdk_core import ApiException
+from ibm_cloud_sdk_core import BaseService, DetailedResponse
 from ibm_cloud_sdk_core import CP4DTokenManager
+from ibm_cloud_sdk_core import get_authenticator_from_environment
 from ibm_cloud_sdk_core.authenticators import (IAMAuthenticator, NoAuthAuthenticator, Authenticator,
                                                BasicAuthenticator, CloudPakForDataAuthenticator)
-from ibm_cloud_sdk_core import get_authenticator_from_environment
 from ibm_cloud_sdk_core.utils import strip_extra_slashes
 
 

test/test_basic_authenticator.py

@@ -1,7 +1,9 @@
 # pylint: disable=missing-docstring
 import pytest
+
 from ibm_cloud_sdk_core.authenticators import BasicAuthenticator
 
+
 def test_basic_authenticator():
     authenticator = BasicAuthenticator('my_username', 'my_password')
     assert authenticator is not None
@@ -12,6 +14,7 @@ def test_basic_authenticator():
     authenticator.authenticate(request)
     assert request['headers']['Authorization'] == 'Basic bXlfdXNlcm5hbWU6bXlfcGFzc3dvcmQ='
 
+
 def test_basic_authenticator_validate_failed():
     with pytest.raises(ValueError) as err:
         BasicAuthenticator('my_username', None)

test/test_bearer_authenticator.py

@@ -3,6 +3,7 @@
 
 from ibm_cloud_sdk_core.authenticators import BearerTokenAuthenticator
 
+
 def test_bearer_authenticator():
     authenticator = BearerTokenAuthenticator('my_bearer_token')
     assert authenticator is not None
@@ -15,6 +16,7 @@ def test_bearer_authenticator():
     authenticator.authenticate(request)
     assert request['headers']['Authorization'] == 'Bearer james bond'
 
+
 def test_bearer_validate_failed():
     with pytest.raises(ValueError) as err:
         BearerTokenAuthenticator(None)

test/test_cp4d_authenticator.py

@@ -1,9 +1,9 @@
 # pylint: disable=missing-docstring
 import json
 
+import jwt
 import pytest
 import responses
-import jwt
 
 from ibm_cloud_sdk_core.authenticators import CloudPakForDataAuthenticator
 

test/test_cp4d_token_manager.py

@@ -2,10 +2,12 @@
 import json
 import time
 
-import responses
 import jwt
+import responses
+
 from ibm_cloud_sdk_core import CP4DTokenManager
 
+
 @responses.activate
 def test_request_token():
     url = "https://test"

test/test_detailed_response.py

@@ -4,12 +4,15 @@
 
 import responses
 import requests
+
 from ibm_cloud_sdk_core import DetailedResponse
 
+
 def clean(val):
     """Eliminate all whitespace and convert single to double quotes"""
     return val.translate(str.maketrans('', '', ' \n\t\r')).replace("'", "\"")
 
+
 @responses.activate
 def test_detailed_response_dict():
     responses.add(responses.GET,
@@ -31,6 +34,7 @@ def test_detailed_response_dict():
     #assert clean(detailed_response.get_headers().__str__()) in response_str
     assert clean(detailed_response.get_status_code().__str__()) in response_str
 
+
 @responses.activate
 def test_detailed_response_list():
     responses.add(responses.GET,

test/test_iam_authenticator.py

@@ -1,9 +1,9 @@
 # pylint: disable=missing-docstring
 import json
 
+import jwt
 import pytest
 import responses
-import jwt
 
 from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
 

test/test_iam_token_manager.py

@@ -2,9 +2,9 @@
 import os
 import time
 
-import responses
 import jwt
 import pytest
+import responses
 
 from ibm_cloud_sdk_core import IAMTokenManager, ApiException, get_authenticator_from_environment
 

test/test_jwt_token_manager.py

@@ -2,11 +2,13 @@
 import time
 import threading
 from typing import Optional
+
 import jwt
 import pytest
 
 from ibm_cloud_sdk_core import JWTTokenManager, DetailedResponse
 
+
 class JWTTokenManagerMockImpl(JWTTokenManager):
     def __init__(self, url: Optional[str] = None, access_token: Optional[str] = None) -> None:
         self.url = url
@@ -45,9 +47,11 @@ def request_token(self) -> DetailedResponse:
         time.sleep(0.5)
         return response
 
+
 def _get_current_time() -> int:
     return int(time.time())
 
+
 def test_get_token():
     url = "https://iam.cloud.ibm.com/identity/token"
     token_manager = JWTTokenManagerMockImpl(url)
@@ -70,6 +74,7 @@ def test_get_token():
     assert token != "old_dummy"
     assert token_manager.request_count == 2
 
+
 def test_paced_get_token():
     url = "https://iam.cloud.ibm.com/identity/token"
     token_manager = JWTTokenManagerMockImpl(url)
@@ -82,6 +87,7 @@ def test_paced_get_token():
         thread.join()
     assert token_manager.request_count == 1
 
+
 def test_is_token_expired():
     token_manager = JWTTokenManagerMockImpl(None, access_token=None)
     assert token_manager._is_token_expired() is True
@@ -90,11 +96,13 @@ def test_is_token_expired():
     token_manager.expire_time = _get_current_time() - 3600
     assert token_manager._is_token_expired()
 
+
 def test_abstract_class_instantiation():
     with pytest.raises(TypeError) as err:
         JWTTokenManager(None)
     assert str(err.value).startswith("Can't instantiate abstract class JWTTokenManager with abstract")
 
+
 def test_disable_ssl_verification():
     token_manager = JWTTokenManagerMockImpl('https://iam.cloud.ibm.com/identity/token')
     token_manager.set_disable_ssl_verification(True)