feature/python-sdk-refactor Updated Type Annotations for all the Exception classes.

Author: angelomelonas

bunq/sdk/exception/EXCEPTIONS.md

@@ -1,5 +1,5 @@
 ## Exceptions
-When you make a request via the SDK, there is a chance of request failing
+When you make a request via the SDK, there is a cobjecthance of request objectfailiobjectng
 due to various reasons. When such a failure happens, an exception
 corresponding to the error occurred is raised.
 
@@ -25,23 +25,23 @@ page here: https://doc.bunq.com/api/1/page/errors
 All the exceptions have the same base exception which looks like this:
 ```python
 class ApiException(Exception):
-    def __init__(self, message, response_code):
-        pass
-        
-    @property
-    def message(self):
+    def __init__(self,
+                 message: str,
+                 response_code: int) -> None:
         """
-        :rtype: str
+
+        :param message:
+        :param response_code:
         """
 
-        return self._message
+        pass
 
     @property
-    def response_code(self):
-        """
-        :rtype: int
-        """
+    def message(self) -> str:
+        return self._message
 
+    @property
+    def response_code(self) -> int:
         return self._response_code
 ```
 This means that each exception will have the response code and the error message 

bunq/sdk/exception/api_exception.py

@@ -1,9 +1,13 @@
 class ApiException(Exception):
-    def __init__(self, message, response_code, response_id):
+    def __init__(self,
+                 message: str,
+                 response_code: int,
+                 response_id: str) -> None:
         """
-        :type response_id: str
-        :type message: str
-        :type response_code: int
+
+        :param message:
+        :param response_code:
+        :param response_id:
         """
 
         self._response_id = response_id
@@ -13,25 +17,13 @@ def __init__(self, message, response_code, response_id):
         super(ApiException, self).__init__(message)
 
     @property
-    def message(self):
-        """
-        :rtype: str
-        """
-
+    def message(self) -> str:
         return self._message
 
     @property
-    def response_code(self):
-        """
-        :rtype: int
-        """
-
+    def response_code(self) -> int:
         return self._response_code
 
     @property
-    def response_id(self):
-        """
-        :rtype: str
-        """
-
+    def response_id(self) -> str:
         return self._response_id

bunq/sdk/exception/bunq_exception.py

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

bunq/sdk/exception/exception_factory.py

@@ -1,3 +1,6 @@
+from typing import List
+
+from bunq.sdk.exception.api_exception import ApiException
 from bunq.sdk.exception.bad_request_exception import BadRequestException
 from bunq.sdk.exception.forbidden_exception import ForbiddenException
 from bunq.sdk.exception.method_not_allowed_exception import MethodNotAllowedException
@@ -28,17 +31,16 @@ class ExceptionFactory:
     @classmethod
     def create_exception_for_response(
             cls,
-            response_code,
-            messages,
-            response_id
-    ):
+            response_code: int,
+            messages: List[str],
+            response_id: str
+    ) -> ApiException:
         """
-        :type response_code: int
-        :type messages: list[str]
-        :type response_id: str
 
+        :param response_code:
+        :param messages:
+        :param response_id:
         :return: The exception according to the status code.
-        :rtype:  ApiException
         """
 
         error_message = cls._generate_message_error(
@@ -97,31 +99,30 @@ def create_exception_for_response(
         )
 
     @classmethod
-    def _generate_message_error(cls, response_code, messages, response_id):
+    def _generate_message_error(cls,
+                                response_code: int,
+                                messages: List[str],
+                                response_id: str) -> str:
         """
-        :type response_code: int
-        :type messages: list[str]
-        :type response_id: str
 
-        :rtype: str
+        :param response_code:
+        :param messages:
+        :param response_id:
         """
 
-        line_response_code = cls._FORMAT_RESPONSE_CODE_LINE \
-            .format(response_code)
+        line_response_code = cls._FORMAT_RESPONSE_CODE_LINE.format(response_code)
         line_response_id = cls._FORMAT_RESPONSE_ID_LINE.format(response_id)
-        line_error_message = cls._FORMAT_ERROR_MESSAGE_LINE.format(
-            cls._GLUE_ERROR_MESSAGE_STRING_EMPTY.join(messages)
-        )
+        line_error_message = cls._FORMAT_ERROR_MESSAGE_LINE.format(cls._GLUE_ERROR_MESSAGE_STRING_EMPTY.join(messages))
 
-        return cls._glue_all_error_message(
-            [line_response_code, line_response_id, line_error_message]
-        )
+        return cls._glue_all_error_message([line_response_code, line_response_id, line_error_message])
 
     @classmethod
-    def _glue_all_error_message(cls, messages):
+    def _glue_all_error_message(cls, messages: List[str]) -> str:
         """
-        :type messages: list[str]
 
+        :param messages:
+        :type messages: List[str]
+        :return:
         :rtype: str
         """