Merge pull request bear#544 from vEpiphyte/logging_ratelimit

jeremylow · web-flow · commit c416c1c751f0 · 2018-02-17T06:39:55.000-05:00
Logging ratelimit
diff --git a/tests/test_rate_limit.py b/tests/test_rate_limit.py
@@ -231,3 +231,32 @@ def testLimitsViaHeadersWithSleep(self):
         self.assertEqual(api.rate_limit.get_limit('/search/tweets').limit, 63)
         self.assertEqual(api.rate_limit.get_limit('/search/tweets').remaining, 63)
         self.assertEqual(api.rate_limit.get_limit('/search/tweets').reset, 626672700)
+
+    @responses.activate
+    def testLimitsViaHeadersWithSleepLimitReached(self):
+        api = twitter.Api(
+            consumer_key='test',
+            consumer_secret='test',
+            access_token_key='test',
+            access_token_secret='test',
+            sleep_on_rate_limit=True)
+
+        # Add handler for ratelimit check - this forces the codepath which goes through the time.sleep call
+        url = '%s/application/rate_limit_status.json?tweet_mode=compat' % api.base_url
+        responses.add(
+            method=responses.GET, url=url,
+            body='{"resources": {"search": {"/search/tweets": {"limit": 1, "remaining": 0, "reset": 1}}}}',
+            match_querystring=True)
+
+        # Get initial rate limit data to populate api.rate_limit object
+        url = "https://api.twitter.com/1.1/search/tweets.json?tweet_mode=compat&q=test&count=15&result_type=mixed"
+        responses.add(
+            method=responses.GET,
+            url=url,
+            body='{}',
+            match_querystring=True,
+            adding_headers=HEADERS)
+
+        resp = api.GetSearch(term='test')
+        self.assertTrue(api.rate_limit)
+        self.assertEqual(resp, [])
diff --git a/twitter/api.py b/twitter/api.py
@@ -26,6 +26,7 @@
 import time
 import base64
 import re
+import logging
 import requests
 from requests_oauthlib import OAuth1, OAuth2
 import io
@@ -77,6 +78,7 @@
 # A singleton representing a lazily instantiated FileCache.
 DEFAULT_CACHE = object()
 
+logger = logging.getLogger(__name__)
 
 class Api(object):
     """A python interface into the Twitter API
@@ -230,7 +232,7 @@ def __init__(self,
         self._debugHTTP = debugHTTP
         self._shortlink_size = 19
         if timeout and timeout < 30:
-            warn("Warning: The Twitter streaming API sends 30s keepalives, the given timeout is shorter!")
+            warnings.warn("Warning: The Twitter streaming API sends 30s keepalives, the given timeout is shorter!")
         self._timeout = timeout
         self.__auth = None
 
@@ -275,7 +277,6 @@ def __init__(self,
                             application_only_auth)
 
         if debugHTTP:
-            import logging
             try:
                 import http.client as http_client  # python3
             except ImportError:
@@ -5051,7 +5052,9 @@ def _RequestUrl(self, url, verb, data=None, json=None, enforce_auth=True):
 
                 if limit.remaining == 0:
                     try:
-                        time.sleep(max(int(limit.reset - time.time()) + 2, 0))
+                        stime = max(int(limit.reset - time.time()) + 2, 0)
+                        logger.debug('Rate limited requesting [%s], sleeping for [%s]', url, stime)
+                        time.sleep(stime)
                     except ValueError:
                         pass
 
