feature/python-sdk-refactor General updates, removing unnecessary docstrings, fixing incorrect type annotations, reformatting code for better readability, etc.

Author: angelomelonas

bunq/__init__.py

@@ -1,15 +1,14 @@
+from typing import Type, Any
+
 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.anchor_object_interface import AnchorObjectInterface
+from bunq.sdk.util.type_alias import T
 
 
-def initialize_converter():
-    """
-    :rtype: None
-    """
-
+def initialize_converter() -> None:
     import datetime
     import inspect
 
@@ -33,36 +32,21 @@ def initialize_converter():
     from bunq.sdk.json.anchor_object_adapter import AnchorObjectAdapter
 
     converter.register_adapter(Installation, InstallationAdapter)
-    converter.register_adapter(
-        SessionServer,
-        SessionServerAdapter
-    )
-    converter.register_adapter(
-        InstallationContext,
-        InstallationContextAdapter
-    )
-    converter.register_adapter(
-        ApiEnvironmentType,
-        ApiEnvironmentTypeAdapter
-    )
+    converter.register_adapter(SessionServer, SessionServerAdapter)
+    converter.register_adapter(InstallationContext, InstallationContextAdapter)
+    converter.register_adapter(ApiEnvironmentType, ApiEnvironmentTypeAdapter)
     converter.register_adapter(float, FloatAdapter)
     converter.register_adapter(object_.Geolocation, GeolocationAdapter)
-    converter.register_adapter(
-        object_.MonetaryAccountReference,
-        MonetaryAccountReferenceAdapter
-    )
+    converter.register_adapter(object_.MonetaryAccountReference, MonetaryAccountReferenceAdapter)
     converter.register_adapter(object_.ShareDetail, ShareDetailAdapter)
     converter.register_adapter(datetime.datetime, DateTimeAdapter)
     converter.register_adapter(Pagination, PaginationAdapter)
 
-    def register_anchor_adapter(class_to_register):
+    def register_anchor_adapter(class_to_register: Type[Any]) -> None:
         if issubclass(class_to_register, AnchorObjectInterface):
-            converter.register_adapter(
-                class_to_register,
-                AnchorObjectAdapter
-            )
+            converter.register_adapter(class_to_register, AnchorObjectAdapter)
 
-    def get_class(class_string_to_get):
+    def get_class(class_string_to_get: str) -> Type[Any]:
         if hasattr(object_, class_string_to_get):
             return getattr(object_, class_string_to_get)
 

bunq/sdk/context/api_context.py

@@ -46,15 +46,6 @@ def __init__(self,
                  device_description: str,
                  permitted_ips: List[str] = None,
                  proxy_url: List[str] = None) -> None:
-        """
-
-        :param environment_type:
-        :param api_key:
-        :param device_description:
-        :param permitted_ips:
-        :param proxy_url:
-        """
-
         if permitted_ips is None:
             permitted_ips = []
 
@@ -68,12 +59,6 @@ def __init__(self,
     def _initialize(self,
                     device_description: str,
                     permitted_ips: List[str]) -> None:
-        """
-
-        :param device_description:
-        :param permitted_ips:
-        """
-
         self._initialize_installation()
         self._register_device(device_description, permitted_ips)
         self._initialize_session()
@@ -101,12 +86,6 @@ def _initialize_installation(self) -> None:
     def _register_device(self,
                          device_description: str,
                          permitted_ips: List[str]) -> None:
-        """
-
-        :param device_description:
-        :param permitted_ips:
-        """
-
         from bunq.sdk.model.core.device_server_internal import DeviceServerInternal
 
         DeviceServerInternal.create(
@@ -127,25 +106,14 @@ def _initialize_session(self) -> None:
         self._session_context = SessionContext(token, expiry_time, user_id)
 
     @classmethod
-    def _get_expiry_timestamp(cls,
-                              session_server: SessionServer) -> datetime.datetime:
-        """
-
-        :param session_server:
-        """
-
+    def _get_expiry_timestamp(cls, session_server: SessionServer) -> datetime.datetime:
         timeout_seconds = cls._get_session_timeout_seconds(session_server)
         time_now = datetime.datetime.now()
 
         return time_now + datetime.timedelta(seconds=timeout_seconds)
 
     @classmethod
     def _get_session_timeout_seconds(cls, session_server: SessionServer) -> int:
-        """
-
-        :param session_server:
-        """
-
         if session_server.user_company is not None:
             return session_server.user_company.session_timeout
         elif session_server.user_person is not None:
@@ -238,11 +206,6 @@ def proxy_url(self) -> str:
         return self._proxy_url
 
     def save(self, path: str = None) -> None:
-        """
-
-        :param path:
-        """
-
         if path is None:
             path = self._PATH_API_CONTEXT_DEFAULT
 
@@ -258,34 +221,23 @@ def to_json(self) -> str:
         return converter.class_to_json(self)
 
     @classmethod
-    def restore(cls, path: str = None) -> 'ApiContext':
-        """
-
-        :param path:
-        """
-
+    def restore(cls, path: str = None) -> ApiContext:
         if path is None:
             path = cls._PATH_API_CONTEXT_DEFAULT
 
         with open(path, cls._FILE_MODE_READ) as file_:
             return cls.from_json(file_.read())
 
     @classmethod
-    def from_json(cls, json_str: str) -> 'ApiContext':
+    def from_json(cls, json_str: str) -> ApiContext:
         """
         Creates an ApiContext instance from JSON string.
 
-        :type json_str:
         """
 
         return converter.json_to_class(ApiContext, json_str)
 
-    def __eq__(self, other: 'ApiContext') -> bool:
-        """
-
-        :param other:
-        """
-
+    def __eq__(self, other: ApiContext) -> bool:
         return (self.token == other.token and
                 self.api_key == other.api_key and
                 self.environment_type == other.environment_type)

bunq/sdk/context/api_environment_type.py

@@ -12,11 +12,6 @@ class ApiEnvironmentType(aenum.AutoNumberEnum):
     SANDBOX = 'https://public-api.sandbox.bunq.com/v1/'
 
     def __init__(self, uri_base: str) -> None:
-        """
-
-        :type uri_base:
-        """
-
         self._uri_base = uri_base
 
     @property

bunq/sdk/context/bunq_context.py

@@ -16,11 +16,6 @@ def __init__(self) -> None:
 
     @classmethod
     def load_api_context(cls, api_context: ApiContext) -> None:
-        """
-
-        :param api_context:
-        """
-
         cls._api_context = api_context
         cls._user_context = UserContext(api_context.session_context.user_id)
         cls._user_context.init_main_monetary_account()
@@ -41,9 +36,4 @@ def user_context(cls) -> UserContext:
 
     @classmethod
     def update_api_context(cls, api_context: ApiContext) -> None:
-        """
-
-        :param api_context:
-        """
-
         cls._api_context = api_context

bunq/sdk/context/installation_context.py

@@ -13,13 +13,6 @@ def __init__(self,
                  token: str,
                  private_key_client: RsaKey,
                  public_key_server: RsaKey) -> None:
-        """
-
-        :param token:
-        :param private_key_client:
-        :param public_key_server:
-        """
-
         self._token = token
         self._private_key_client = private_key_client
         self._public_key_server = public_key_server

bunq/sdk/context/session_context.py

@@ -12,13 +12,6 @@ def __init__(self,
                  token: str,
                  expiry_time: datetime.datetime,
                  user_id: int) -> None:
-        """
-
-        :param token:
-        :param expiry_time:
-        :param user_id:
-        """
-
         self._token = token
         self._expiry_time = expiry_time
         self._user_id = user_id

bunq/sdk/context/user_context.py

@@ -10,11 +10,6 @@ class UserContext:
     _STATUS_ACTIVE = 'ACTIVE'
 
     def __init__(self, user_id: int) -> None:
-        """
-
-        :param user_id:
-        """
-
         self._user_id = user_id
         self._user_person = None
         self._user_company = None
@@ -28,11 +23,6 @@ def __get_user_object() -> BunqModel:
         return endpoint.User.list().value[0].get_referenced_object()
 
     def _set_user(self, user: BunqModel) -> None:
-        """
-
-        :param user:
-        """
-
         if isinstance(user, endpoint.UserPerson):
             self._user_person = user
 

bunq/sdk/exception/EXCEPTIONS.md

@@ -28,12 +28,6 @@ class ApiException(Exception):
     def __init__(self,
                  message: str,
                  response_code: int) -> None:
-        """
-
-        :param message:
-        :param response_code:
-        """
-
         pass
 
     @property

bunq/sdk/exception/api_exception.py

@@ -3,13 +3,6 @@ def __init__(self,
                  message: str,
                  response_code: int,
                  response_id: str) -> None:
-        """
-
-        :param message:
-        :param response_code:
-        :param response_id:
-        """
-
         self._response_id = response_id
         self._message = message
         self._response_code = response_code

bunq/sdk/exception/bunq_exception.py

@@ -1,8 +1,3 @@
 class BunqException(Exception):
     def __init__(self, message: str) -> None:
-        """
-
-        :param message:
-        """
-
         super(BunqException, self).__init__(message)