Fix type hints and pep8 syntax errors

Signed-off-by: Roald Nefs <info@roaldnefs.com>

Author: roaldnefs

transip/__init__.py

@@ -18,11 +18,11 @@
 # along with python-transip.  If not, see <https://www.gnu.org/licenses/>.
 """Wrapper for the TransIP API."""
 
+from typing import Dict, Optional, Any, Type, Union
+
 import importlib
 import requests
-import base64
-
-from typing import Dict, Optional, Any, Type
+import os
 
 from transip.exceptions import TransIPHTTPError, TransIPParsingError
 from transip.utils import generate_message_signature, generate_nonce
@@ -44,7 +44,7 @@ class TransIP:
         api_version (str): TransIP API version to use
         access_token (str): The TransIP API access token
         private_key (str): The content of the private key for accessing the
-            TransIP API 
+            TransIP API
         private_key_file (str): Path to the private key for accessing the
             TransIP API
     """
@@ -69,7 +69,7 @@ def __init__(
         self.session: requests.Session = requests.Session()
 
         # Set authentication information
-        self._login: str = login
+        self._login: Optional[str] = login
         self._access_token: Optional[str] = access_token
         self._private_key: Optional[str] = private_key
         self._private_key_file: Optional[str] = private_key_file
@@ -116,7 +116,6 @@ def _request_access_token(self) -> str:
             TransIPParsingError: If the requested access token couldn't be
                 extracted from the API response.
         """
-
         url: str = self._build_url('/auth')
         payload: Dict[str, Any] = {
             "login": self._login,
@@ -137,14 +136,22 @@ def _request_access_token(self) -> str:
         }
 
         headers: Dict[str, str] = self.headers.copy()
-        request: requests.Request = requests.Request("POST", url, headers=headers, json=payload)
-        prepped: requests.PreparedRequest = self.session.prepare_request(request)
+        request: requests.Request = requests.Request(
+            "POST", url, headers=headers, json=payload
+        )
+        prepped: requests.PreparedRequest = self.session.prepare_request(
+            request
+        )
 
         # Get the prepped body for signature generation
-        body: str = prepped.body
+        body: Union[bytes, str] = prepped.body or ''
+        if isinstance(body, bytes):
+            body = body.decode('ascii')
 
         # Generate a signature if the request body
-        signature: str = generate_message_signature(body, self._private_key)
+        signature: str = generate_message_signature(
+            body, self._private_key  # type: ignore
+        )
 
         # Add 'Signature' header to the prepared request
         prepped.headers["Signature"] = signature
@@ -165,13 +172,13 @@ def _read_private_key(self) -> str:
 
         Returns:
             str: The private key content
-        
+
         Raises:
             RuntimeError: If the private key file doesn't exist
         """
-        if os.path.exists(self._private_key_file):
+        if os.path.exists(self._private_key_file):  # type: ignore
             try:
-                with open(self._private_key_file) as keyfile:
+                with open(self._private_key_file) as keyfile:  # type: ignore
                     return keyfile.read()
             except IOError as exc:
                 raise RuntimeError("The private key couldn't be read") from exc
@@ -181,11 +188,12 @@ def _read_private_key(self) -> str:
     def _set_auth_info(self) -> None:
         """
         Set authentication information based upon the defined attributes.
-        
+
         Raises:
             ValueError: If the required attributes are not defined.
         """
-        if not self._access_token and not self._private_key and not self._private_key_file:
+        if (not self._access_token and not self._private_key and not
+                self._private_key_file):
             raise ValueError(
                 "At least one of access_token, private_key and "
                 "private_key_file should be defined"
@@ -270,7 +278,7 @@ def request(
     def _validate_response(self, response: requests.Response) -> Any:
         """
         Validate the API response.
-        
+
         Raises:
             TransIPHTTPError: When the return code of the request is not 2xx
             TransIPParsingError: When the content couldn't be parsed as JSON

transip/utils.py

@@ -17,8 +17,9 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with python-transip.  If not, see <https://www.gnu.org/licenses/>.
 
+from typing import Union
+
 import base64
-import os
 import secrets
 import string
 
@@ -29,45 +30,49 @@
 from cryptography.hazmat.primitives.asymmetric.padding import PKCS1v15
 
 
-def load_rsa_private_key(key: str) -> RSAPrivateKey:
+def load_rsa_private_key(key: Union[bytes, str]) -> RSAPrivateKey:
     """
     Convert the private key string to RSAPrivateKey object.
-    
+
     Returns:
         RSAPrivateKey: The private RSA key.
     """
     # Convert the key string to bytes
     if isinstance(key, str):
-        key: bytes = key.encode()
-    
+        key = key.encode()
+
     return serialization.load_pem_private_key(
         key, password=None, backend=default_backend()
     )
 
 
-def generate_message_signature(message: str, private_key: str) -> str:
+def generate_message_signature(
+    message: Union[str, bytes],
+    private_key: Union[RSAPrivateKey, str]
+) -> str:
     """Return the BASE64 encoded SHA514 signature of a message.
-    
+
     Args:
         message (str): The message to sign.
         private_key (str): The private key content used to sign the message.
-    
+
     Returns:
         str: The BASE64 encoded SHA514 signature of a message.
     """
     # Convert the message string to bytes
     if isinstance(message, str):
-        message: bytes = message.encode()
+        message = message.encode()
 
     # Convert the private key content to a RSAPrivateKey object
     if isinstance(private_key, str):
-        private_key: RSAPrivateKey = load_rsa_private_key(private_key)
+        private_key = load_rsa_private_key(private_key)
 
     # Sign the message using the RSAPrivateKey object
-    signature: str = private_key.sign(message, PKCS1v15(), SHA512())
+    signature: bytes = private_key.sign(message, PKCS1v15(), SHA512())
 
     # Return the BASE64 encoded SHA512 signature
-    return base64.b64encode(signature)
+    b64_bytes: bytes = base64.b64encode(signature)
+    return b64_bytes.decode('ascii')
 
 
 def generate_nonce(length: int) -> str:
@@ -80,5 +85,5 @@ def generate_nonce(length: int) -> str:
     Returns:
         str: The nonce of specified characters.
     """
-    alphabet = string.ascii_letters + string.digits
+    alphabet: str = string.ascii_letters + string.digits
     return ''.join(secrets.choice(alphabet) for i in range(length))