Add timeouts (fixes #44) (#45)

tsifrer · Sep 10, 2018 · 54bd623 · 54bd623
1 parent 9c01ecb
commit 54bd623
Showing 1 changed file with 20 additions and 4 deletions.
diff --git a/twitch/api/base.py b/twitch/api/base.py
@@ -6,16 +6,21 @@
 from twitch.conf import backoff_config
 from twitch.constants import BASE_URL
 
+DEFAULT_TIMEOUT = 10
+
 
 class TwitchAPI(object):
+    """Twitch API client."""
 
     def __init__(self, client_id, oauth_token=None):
+        """Initialize the API."""
         super(TwitchAPI, self).__init__()
         self._client_id = client_id
         self._oauth_token = oauth_token
         self._initial_backoff, self._max_retries = backoff_config()
 
     def _get_request_headers(self):
+        """Prepare the headers for the requests."""
         headers = {
             'Accept': 'application/vnd.twitchtv.v5+json',
             'Client-ID': self._client_id
@@ -27,6 +32,7 @@ def _get_request_headers(self):
         return headers
 
     def _request_get(self, path, params=None, json=True, url=BASE_URL):
+        """Perform a HTTP GET request."""
         url = urljoin(url, path)
         headers = self._get_request_headers()
 
@@ -36,7 +42,9 @@ def _request_get(self, path, params=None, json=True, url=BASE_URL):
             backoff = self._initial_backoff
             for _ in range(self._max_retries):
                 time.sleep(backoff)
-                backoff_response = requests.get(url, params=params, headers=headers)
+                backoff_response = requests.get(
+                    url, params=params, headers=headers,
+                    timeout=DEFAULT_TIMEOUT)
                 if backoff_response.status_code < 500:
                     response = backoff_response
                     break
@@ -49,30 +57,38 @@ def _request_get(self, path, params=None, json=True, url=BASE_URL):
             return response
 
     def _request_post(self, path, data=None, params=None, url=BASE_URL):
+        """Perform a HTTP POST request.."""
         url = urljoin(url, path)
 
         headers = self._get_request_headers()
 
-        response = requests.post(url, json=data, params=params, headers=headers)
+        response = requests.post(
+            url, json=data, params=params, headers=headers,
+            timeout=DEFAULT_TIMEOUT)
         response.raise_for_status()
         if response.status_code == 200:
             return response.json()
 
     def _request_put(self, path, data=None, params=None, url=BASE_URL):
+        """Perform a HTTP PUT request."""
         url = urljoin(url, path)
 
         headers = self._get_request_headers()
-        response = requests.put(url, json=data, params=params, headers=headers)
+        response = requests.put(
+            url, json=data, params=params, headers=headers,
+            timeout=DEFAULT_TIMEOUT)
         response.raise_for_status()
         if response.status_code == 200:
             return response.json()
 
     def _request_delete(self, path, params=None, url=BASE_URL):
+        """Perform a HTTP DELETE request."""
         url = urljoin(url, path)
 
         headers = self._get_request_headers()
 
-        response = requests.delete(url, params=params, headers=headers)
+        response = requests.delete(
+            url, params=params, headers=headers, timeout=DEFAULT_TIMEOUT)
         response.raise_for_status()
         if response.status_code == 200:
             return response.json()