feature/python-sdk-refactor Merge Request fixes and code cleanup.

Author: angelomelonas

bunq/__init__.py

@@ -1,6 +1,8 @@
+from bunq.sdk.context.api_environment_type import ApiEnvironmentType
+from bunq.sdk.context.installation_context import InstallationContext
 from bunq.sdk.http.pagination import Pagination
 from bunq.sdk.json import converter
-from bunq.sdk.model.core.anchored_object_interface import AnchoredObjectInterface
+from bunq.sdk.model.core.anchor_object_interface import AnchorObjectInterface
 
 
 def initialize_converter():
@@ -28,18 +30,19 @@ def initialize_converter():
     from bunq.sdk.json.share_detail_adapter import ShareDetailAdapter
     from bunq.sdk.json.date_time_adapter import DateTimeAdapter
     from bunq.sdk.json.pagination_adapter import PaginationAdapter
+    from bunq.sdk.json.anchor_object_adapter import AnchorObjectAdapter
 
     converter.register_adapter(Installation, InstallationAdapter)
     converter.register_adapter(
         SessionServer,
         SessionServerAdapter
     )
     converter.register_adapter(
-        api_context.InstallationContext,
+        InstallationContext,
         InstallationContextAdapter
     )
     converter.register_adapter(
-        api_context.ApiEnvironmentType,
+        ApiEnvironmentType,
         ApiEnvironmentTypeAdapter
     )
     converter.register_adapter(float, FloatAdapter)
@@ -53,11 +56,10 @@ def initialize_converter():
     converter.register_adapter(Pagination, PaginationAdapter)
 
     def register_anchor_adapter(class_to_register):
-        if issubclass(class_to_register, AnchoredObjectInterface):
-            from bunq.sdk.json.anchored_object_model_adapter import AnchoredObjectModelAdapter
+        if issubclass(class_to_register, AnchorObjectInterface):
             converter.register_adapter(
                 class_to_register,
-                AnchoredObjectModelAdapter
+                AnchorObjectAdapter
             )
 
     def get_class(class_string_to_get):

bunq/sdk/context/api_context.py

@@ -69,9 +69,10 @@ def _initialize_installation(self):
         """
         :rtype: None
         """
+        from bunq.sdk.model.core.installation import Installation
 
         private_key_client = security.generate_rsa_private_key()
-        from bunq.sdk.model.core.installation import Installation
+
         installation = Installation.create(
             self,
             security.public_key_to_string(private_key_client.publickey())
@@ -111,6 +112,7 @@ def _initialize_session(self):
         """
 
         from bunq.sdk.model.core.session_server import SessionServer
+
         session_server = SessionServer.create(self).value
         token = session_server.token.token
         expiry_time = self._get_expiry_timestamp(session_server)

bunq/sdk/http/api_client.py

@@ -11,7 +11,7 @@
 
 class ApiClient(object):
     """
-    :type _api_context: bunq.sdk.context.ApiContext
+    :type _api_context: ApiContext
     """
 
     # Error constants
@@ -32,7 +32,7 @@ class ApiClient(object):
     ]
 
     # HTTPS type of proxy, the only used at bunq
-    _FIELD_PROXY_HTTPS = 'https'
+    FIELD_PROXY_HTTPS = 'https'
 
     # Header constants
     HEADER_ATTACHMENT_DESCRIPTION = 'X-Bunq-Attachment-Description'
@@ -49,33 +49,33 @@ class ApiClient(object):
     HEADER_RESPONSE_ID_LOWER_CASED = 'x-bunq-client-response-id'
 
     # Default header values
-    _USER_AGENT_BUNQ = 'bunq-sdk-python/1.10.16'
+    USER_AGENT_BUNQ = 'bunq-sdk-python/1.10.16'
     GEOLOCATION_ZERO = '0 0 0 0 NL'
     LANGUAGE_EN_US = 'en_US'
     REGION_NL_NL = 'nl_NL'
     CACHE_CONTROL_NONE = 'no-cache'
 
     # Request method names
     METHOD_POST = 'POST'
-    _METHOD_PUT = 'PUT'
-    _METHOD_GET = 'GET'
-    _METHOD_DELETE = 'DELETE'
+    METHOD_PUT = 'PUT'
+    METHOD_GET = 'GET'
+    METHOD_DELETE = 'DELETE'
 
     # Delimiter between path and params in URL
-    _DELIMITER_URL_QUERY = '?'
+    DELIMITER_URL_QUERY = '?'
 
     # Status code for successful execution
     STATUS_CODE_OK = 200
 
     # Fields for fetching errors
-    _FIELD_ERROR = 'Error'
-    _FIELD_ERROR_DESCRIPTION = 'error_description'
+    FIELD_ERROR = 'Error'
+    FIELD_ERROR_DESCRIPTION = 'error_description'
 
     # Empty string
-    _STRING_EMPTY = ''
+    STRING_EMPTY = ''
 
     # Empty bytes
-    _BYTES_EMPTY = b''
+    BYTES_EMPTY = b''
 
     def __init__(self, api_context):
         self._api_context = api_context
@@ -97,8 +97,7 @@ def post(self, uri_relative, request_bytes, custom_headers):
             custom_headers
         )
 
-    def _request(self, method, uri_relative, request_bytes, params,
-                 custom_headers):
+    def _request(self, method, uri_relative, request_bytes, params, custom_headers):
         """
         :type method: str
         :type uri_relative: str
@@ -109,11 +108,11 @@ def _request(self, method, uri_relative, request_bytes, params,
         :return: BunqResponseRaw
         """
 
+        from bunq.sdk.context.bunq_context import BunqContext
+
         uri_relative_with_params = self._append_params_to_uri(uri_relative, params)
         if uri_relative not in self._URIS_NOT_REQUIRING_ACTIVE_SESSION:
             if self._api_context.ensure_session_active():
-                from bunq.sdk.context.bunq_context import BunqContext
-
                 BunqContext.update_api_context(self._api_context)
 
         all_headers = self._get_all_headers(
@@ -128,7 +127,7 @@ def _request(self, method, uri_relative, request_bytes, params,
             self._get_uri_full(uri_relative_with_params),
             data=request_bytes,
             headers=all_headers,
-            proxies={self._FIELD_PROXY_HTTPS: self._api_context.proxy_url},
+            proxies={self.FIELD_PROXY_HTTPS: self._api_context.proxy_url},
         )
 
         self._assert_response_success(response)
@@ -153,7 +152,7 @@ def _append_params_to_uri(cls, uri, params):
         """
 
         if params:
-            return uri + cls._DELIMITER_URL_QUERY + urlencode(params)
+            return uri + cls.DELIMITER_URL_QUERY + urlencode(params)
 
         return uri
 
@@ -189,7 +188,7 @@ def _get_default_headers(cls):
         """
 
         return {
-            cls.HEADER_USER_AGENT: cls._USER_AGENT_BUNQ,
+            cls.HEADER_USER_AGENT: cls.USER_AGENT_BUNQ,
             cls.HEADER_REQUEST_ID: cls._generate_random_request_id(),
             cls.HEADER_GEOLOCATION: cls.GEOLOCATION_ZERO,
             cls.HEADER_LANGUAGE: cls.LANGUAGE_EN_US,
@@ -264,8 +263,8 @@ def _fetch_error_descriptions(self, error_dict):
 
         error_descriptions = []
 
-        for error in error_dict[self._FIELD_ERROR]:
-            description = error[self._FIELD_ERROR_DESCRIPTION]
+        for error in error_dict[self.FIELD_ERROR]:
+            description = error[self.FIELD_ERROR_DESCRIPTION]
             error_descriptions.append(description)
 
         return error_descriptions
@@ -297,7 +296,7 @@ def put(self, uri_relative, request_bytes, custom_headers):
         """
 
         return self._request(
-            self._METHOD_PUT,
+            self.METHOD_PUT,
             uri_relative,
             request_bytes,
             {},
@@ -314,9 +313,9 @@ def get(self, uri_relative, params, custom_headers):
         """
 
         return self._request(
-            self._METHOD_GET,
+            self.METHOD_GET,
             uri_relative,
-            self._BYTES_EMPTY,
+            self.BYTES_EMPTY,
             params,
             custom_headers
         )
@@ -330,9 +329,9 @@ def delete(self, uri_relative, custom_headers):
         """
 
         return self._request(
-            self._METHOD_DELETE,
+            self.METHOD_DELETE,
             uri_relative,
-            self._BYTES_EMPTY,
+            self.BYTES_EMPTY,
             {},
             custom_headers
         )

bunq/sdk/json/anchored_object_model_adapter.py renamed to bunq/sdk/json/anchor_object_adapter.py

@@ -1,12 +1,12 @@
-from bunq import AnchoredObjectInterface
+from bunq import AnchorObjectInterface
 from bunq.sdk.exception.bunq_exception import BunqException
 from bunq.sdk.json import converter
 from bunq.sdk.model.generated import endpoint
 from bunq.sdk.model.generated import object_
 
 
-class AnchoredObjectModelAdapter(converter.JsonAdapter):
-    _ERROR_MODEL_NOT_FOUND = '{} is not in endpoint nor object.'
+class AnchorObjectAdapter(converter.JsonAdapter):
+    __ERROR_MODEL_NOT_FOUND = '{} is not in endpoint nor object.'
 
     __STRING_FORMAT_UNDERSCORE = '_'
 
@@ -28,7 +28,7 @@ def deserialize(cls, cls_target, obj_raw):
 
         if isinstance(
                 model_,
-                AnchoredObjectInterface
+                AnchorObjectInterface
         ) and model_.is_all_field_none():
             for field in model_.__dict__:
                 object_class = cls._get_object_class(field)
@@ -67,4 +67,4 @@ def _get_object_class(cls, class_name):
         except AttributeError:
             pass
 
-        raise BunqException(cls._ERROR_MODEL_NOT_FOUND.format(class_name))
+        raise BunqException(cls.__ERROR_MODEL_NOT_FOUND.format(class_name))

bunq/sdk/json/api_environment_type_adapter.py

@@ -1,25 +1,23 @@
-from bunq.sdk.context import api_context
+from bunq.sdk.context.api_environment_type import ApiEnvironmentType
 from bunq.sdk.json import converter
 
 
 class ApiEnvironmentTypeAdapter(converter.JsonAdapter):
     @classmethod
     def deserialize(cls, target_class, name):
         """
-        :type target_class: api_context.ApiEnvironmentType|type
+        :type target_class: ApiEnvironmentType|type
         :type name: str
 
         :rtype: context.ApiEnvironmentType
         """
 
-        _ = target_class
-
-        return api_context.ApiEnvironmentType[name]
+        return ApiEnvironmentType[name]
 
     @classmethod
     def serialize(cls, api_environment_type):
         """
-        :type api_environment_type: api_context.ApiEnvironmentType
+        :type api_environment_type: ApiEnvironmentType
 
         :rtype: str
         """

bunq/sdk/json/converter.py

@@ -4,9 +4,9 @@
 import sys
 import warnings
 
-# Indentation size we use for the serialized JSON output
 from bunq.sdk.exception.bunq_exception import BunqException
 
+# Indentation size we use for the serialized JSON output
 _JSON_INDENT = 4
 
 
@@ -32,8 +32,7 @@ class JsonAdapter(object):
     _PREFIX_KEY_PROTECTED = '_'
 
     # Constants to fetch param types from the docstrings
-    _TEMPLATE_PATTERN_PARAM_TYPES = \
-        ':type (_?{}):[\s\n\r]+([\w.]+)(?:\[([\w.]+)\])?'
+    _TEMPLATE_PATTERN_PARAM_TYPES = ':type (_?{}):[\s\n\r]+([\w.]+)(?:\[([\w.]+)\])?'
     _PATTERN_PARAM_NAME_TYPED_ANY = ':type (\w+):'
     _SUBMATCH_INDEX_NAME = 1
     _SUBMATCH_INDEX_TYPE_MAIN = 2

bunq/sdk/json/geolocation_adapter.py

@@ -26,8 +26,6 @@ def deserialize(cls, target_class, obj):
         :raise: NotImplementedError
         """
 
-        _ = target_class, obj
-
         raise NotImplementedError()
 
     @classmethod

bunq/sdk/json/installation_context_adapter.py

@@ -1,4 +1,3 @@
-from bunq.sdk.context import api_context
 from bunq.sdk.json import converter
 from bunq.sdk.security import security
 
@@ -20,10 +19,10 @@ class InstallationContextAdapter(converter.JsonAdapter):
     @classmethod
     def deserialize(cls, target_class, obj):
         """
-        :type target_class: api_context.InstallationContext|type
+        :type target_class: InstallationContext|type
         :type obj: dict
 
-        :rtype: context.InstallationContext
+        :rtype: InstallationContext
         """
 
         installation_context = target_class.__new__(target_class)
@@ -48,7 +47,7 @@ def deserialize(cls, target_class, obj):
     @classmethod
     def serialize(cls, installation_context):
         """
-        :type installation_context: api_context.InstallationContext
+        :type installation_context: InstallationContext
 
         :rtype: dict
         """

bunq/sdk/json/monetary_account_reference_adapter.py

@@ -17,9 +17,7 @@ def deserialize(cls, target_class, obj):
             obj
         )
 
-        return target_class.create_from_label_monetary_account(
-            label_monetary_account
-        )
+        return target_class.create_from_label_monetary_account(label_monetary_account)
 
     @classmethod
     def serialize(cls, monetary_account_reference):

bunq/sdk/json/pagination_adapter.py

@@ -25,7 +25,7 @@ def deserialize(cls, target_class, pagination_response):
         :type target_class: Pagination|type
         :type pagination_response: dict
 
-        :rtype: client.Pagination
+        :rtype: Pagination
         """
 
         pagination = Pagination()
@@ -103,6 +103,4 @@ def serialize(cls, pagination):
         :raise: NotImplementedError
         """
 
-        _ = pagination
-
         raise NotImplementedError()