Type hinting

Author: SchrodingersGat

inventree/api.py

@@ -78,7 +78,7 @@ def __init__(self, host=None, **kwargs):
         if kwargs.get('connect', True):
             self.connect()
 
-    def setHostName(self, host):
+    def setHostName(self, host: str):
         """Validate that the provided base URL is valid"""
 
         if host is None:
@@ -136,7 +136,7 @@ def connect(self):
             if not self.token:
                 self.requestToken()
 
-    def constructApiUrl(self, endpoint_url):
+    def constructApiUrl(self, endpoint_url: str) -> str:
         """Construct an API endpoint URL based on the provided API URL.
 
         Arguments:
@@ -263,14 +263,14 @@ def requestToken(self):
 
         return self.token
 
-    def request(self, api_url, **kwargs):
+    def request(self, url: str, **kwargs):
         """ Perform a URL request to the Inventree API """
 
         if not self.connected:
             # If we have not established a connection to the server yet, attempt now
             self.connect()
 
-        api_url = self.constructApiUrl(api_url)
+        api_url = self.constructApiUrl(url)
 
         data = kwargs.get('data', kwargs.get('json', {}))
         files = kwargs.get('files', {})
@@ -391,7 +391,7 @@ def request(self, api_url, **kwargs):
 
         return response
 
-    def delete(self, url, **kwargs):
+    def delete(self, url: str, **kwargs):
         """ Perform a DELETE request. Used to remove a record in the database.
 
         """
@@ -410,7 +410,7 @@ def delete(self, url, **kwargs):
 
         return response
 
-    def post(self, url, data, **kwargs):
+    def post(self, url: str, data: dict, **kwargs):
         """ Perform a POST request. Used to create a new record in the database.
 
         Args:
@@ -447,7 +447,7 @@ def post(self, url, data, **kwargs):
 
         return data
 
-    def patch(self, url, data, **kwargs):
+    def patch(self, url: str, data: dict, **kwargs):
         """
         Perform a PATCH request.
 
@@ -485,7 +485,7 @@ def patch(self, url, data, **kwargs):
 
         return data
 
-    def put(self, url, data, **kwargs):
+    def put(self, url: str, data: dict, **kwargs):
         """
         Perform a PUT request. Used to update existing records in the database.
 
@@ -521,7 +521,7 @@ def put(self, url, data, **kwargs):
 
         return data
 
-    def get(self, url, **kwargs):
+    def get(self, url: str, **kwargs):
         """ Perform a GET request.
 
         For argument information, refer to the 'request' method