Update cache and refresh related tests.

CHANGES.rst

@@ -31,6 +31,8 @@ Unreleased
    fetch the name of an unloaded Subreddit, use ``str(sub_instance)``, or
    ``unicode(sub_instance)``.
  * **[CHANGE]** Removed :class:`praw.Config` instance attribute ``is_reddit``.
+ * **[CHANGE]** :meth:`~praw.__init__.BaseReddit.evict` now returns the number
+   of items evicted.
  * **[FEATURE]** Added :meth:`get_message` to fetch a single Message object
    by its ID.
  * **[FEATURE]** Added :meth:`get_sticky` to get a Subreddit's sticky post.

praw/__init__.py

@@ -431,10 +431,15 @@ def _json_reddit_objecter(self, json_data):
         return json_data
 
     def evict(self, urls):
-        """Evict url(s) from the cache."""
+        """Evict url(s) from the cache.
+
+        :param urls: An iterable containing normalized urls.
+        :returns: The number of items removed from the cache.
+
+        """
         if isinstance(urls, six.string_types):
             urls = (urls,)
-        self.handler.evict(urls)
+        return self.handler.evict(urls)
 
     @decorators.oauth_generator
     def get_content(self, url, params=None, limit=0, place_holder=None,

praw/handlers.py

@@ -62,12 +62,12 @@ def evict(cls, urls):  # pylint: disable=W0613
         """Method utilized to evict entries for the given urls.
 
         :param urls: An iterable containing normalized urls.
-        :returns: Whether or not an item was removed from the cache.
+        :returns: The number of items removed from the cache.
 
         By default this method returns False as a cache need not be present.
 
         """
-        return False
+        return 0
 
     def __del__(self):
         """Cleanup the HTTP session."""
@@ -167,17 +167,17 @@ def clear_cache(cls):
     def evict(cls, urls):
         """Remove items from cache matching URLs.
 
-        Return whether or not any items were removed.
+        Return the number of items removed.
 
         """
         if isinstance(urls, text_type):
             urls = [urls]
         urls = set(normalize_url(url) for url in urls)
-        retval = False
+        retval = 0
         with cls.ca_lock:
             for key in list(cls.cache):
                 if key[0] in urls:
-                    retval = True
+                    retval += 1
                     del cls.cache[key]
                     del cls.timeouts[key]
         return retval

tests/cassettes/test_cache.json

@@ -0,0 +1 @@
+{"http_interactions": [{"request": {"body": {"string": "passwd=1111&user=PyAPITestUser4&api_type=json", "encoding": "utf-8"}, "headers": {"Content-Length": ["45"], "Accept-Encoding": ["gzip, deflate"], "Accept": ["*/*"], "User-Agent": ["PRAW_test_suite PRAW/3.0a1 Python/2.7.5 Darwin-13.4.0-x86_64-i386-64bit"], "Connection": ["keep-alive"], "Content-Type": ["application/x-www-form-urlencoded"]}, "method": "POST", "uri": "https://api.reddit.com/api/login/.json"}, "response": {"body": {"base64_string": "H4sIAAAAAAAAAxzLSW7DMAxA0asIXCsAJWqyzpFdUQSkBrhtYjm2d4HvHqTb//Bf8LuPBbJ6Qdu2se2Q1de3VlD54P+8tFZv83GsH+p835tW8Bh15n2GrMCb4YXX57JiwNCnFgqjI05WCrbSJPRkcRJGcV6ScQRaQRnj76d9fhPNZIIhbdH4C7qLTVeM2cdMXsdOtjIyYxAyVD0xuklMSC70IskWilSqh/M83wAAAP//AwCUmy91ywAAAA==", "encoding": "UTF-8"}, "headers": {"x-xss-protection": ["1; mode=block"], "x-content-type-options": ["nosniff"], "content-encoding": ["gzip"], "transfer-encoding": ["chunked"], "set-cookie": ["__cfduid=df070d7ded7b04d44b1bf6b933d17f3531430233054; expires=Wed, 27-Apr-16 14:57:34 GMT; path=/; domain=.reddit.com; HttpOnly", "secure_session=; Domain=reddit.com; Max-Age=-1430233055; Path=/; expires=Thu, 01-Jan-1970 00:00:01 GMT; HttpOnly", "reddit_session=17191613%2C2015-04-28T07%3A57%3A35%2C7f32da0aa06b313d53a049b16846fcb82c373cd5; Domain=reddit.com; Path=/; HttpOnly"], "server": ["cloudflare-nginx"], "connection": ["keep-alive"], "x-ua-compatible": ["IE=edge"], "pragma": ["no-cache"], "cache-control": ["no-cache, no-cache"], "date": ["Tue, 28 Apr 2015 14:57:35 GMT"], "x-frame-options": ["SAMEORIGIN"], "x-moose": ["majestic"], "content-type": ["application/json; charset=UTF-8"], "cf-ray": ["1de39ecff94003dc-DFW"]}, "status": {"message": "OK", "code": 200}, "url": "https://api.reddit.com/api/login/.json"}, "recorded_at": "2015-04-28T14:57:37"}, {"request": {"body": {"string": "passwd=1111&uh=51o5bapqnp0606f9e6ca043a82bc0eceb6f8209ba0b45b8143&user=PyAPITestUser2&api_type=json", "encoding": "utf-8"}, "headers": {"Content-Length": ["99"], "Accept-Encoding": ["gzip, deflate"], "Accept": ["*/*"], "User-Agent": ["PRAW_test_suite PRAW/3.0a1 Python/2.7.5 Darwin-13.4.0-x86_64-i386-64bit"], "Connection": ["keep-alive"], "Content-Type": ["application/x-www-form-urlencoded"]}, "method": "POST", "uri": "https://api.reddit.com/api/login/.json"}, "response": {"body": {"base64_string": "H4sIAAAAAAAAAxzLTY7DIAxA4asgr6mUYGwD5+huNKogmGb6E6okuyp3rzrb9+m94bb1BZJ5g65rXzdI5ufXGqh5z/95Ua2Xed9fX2r5sak18Ox1ztsMycAS9XrdW390DWEUjL5K88jBFSeeceLWsGislZijDy2ANTD1fv/T7y84uMBi3TDSafAnF86DJJKEZCNpYG6TRCxC4lAJWyOvY1F2cZQolTgXOI7jAwAA//8DAG/+8OvKAAAA", "encoding": "UTF-8"}, "headers": {"x-xss-protection": ["1; mode=block"], "x-content-type-options": ["nosniff"], "content-encoding": ["gzip"], "transfer-encoding": ["chunked"], "set-cookie": ["__cfduid=dc19bd73cf18348a7ab86d7e35bd059991430233055; expires=Wed, 27-Apr-16 14:57:35 GMT; path=/; domain=.reddit.com; HttpOnly", "secure_session=; Domain=reddit.com; Max-Age=-1430233055; Path=/; expires=Thu, 01-Jan-1970 00:00:01 GMT; HttpOnly", "reddit_session=7302867%2C2015-04-28T07%3A57%3A35%2C95e866fc793b75723e53ff54e1be6291797d56ab; Domain=reddit.com; Path=/; HttpOnly"], "server": ["cloudflare-nginx"], "connection": ["keep-alive"], "x-ua-compatible": ["IE=edge"], "pragma": ["no-cache"], "cache-control": ["no-cache, no-cache"], "date": ["Tue, 28 Apr 2015 14:57:35 GMT"], "x-frame-options": ["SAMEORIGIN"], "x-moose": ["majestic"], "content-type": ["application/json; charset=UTF-8"], "cf-ray": ["1de39ed3d98c03dc-DFW"]}, "status": {"message": "OK", "code": 200}, "url": "https://api.reddit.com/api/login/.json"}, "recorded_at": "2015-04-28T14:57:38"}, {"request": {"body": {"string": "", "encoding": "utf-8"}, "headers": {"Connection": ["keep-alive"], "Cookie": ["reddit_session=7302867%2C2015-04-28T07%3A57%3A35%2C95e866fc793b75723e53ff54e1be6291797d56ab; __cfduid=dc19bd73cf18348a7ab86d7e35bd059991430233055"], "Accept-Encoding": ["gzip, deflate"], "Accept": ["*/*"], "User-Agent": ["PRAW_test_suite PRAW/3.0a1 Python/2.7.5 Darwin-13.4.0-x86_64-i386-64bit"]}, "method": "GET", "uri": "https://api.reddit.com/r/reddit_api_test/new.json?limit=5"}, "response": {"body": {"base64_string": "H4sIAOCfP1UC/+2XXW/bNhSG/4qmi14t0bdkp9hF16LAgG0N2g1D0RQERdIWZ0kUSMpuEOS/j4eSEkmxgbaZ2wzznXRInvOeDz6QbtwNr6l74bi/cqV5vXZ/dFyKNTamG7cStMCqgOUtzZYtzvCnFY0Xfhj5wSonfrL0lzHJ0zwlNPJXUYRzHwfLAKcpBU+k4CWVrDYePtzchdLRJAoVFeawxVWsXJ1LRinXCDccaaY0bM1xXTOK8muzqW7L0pgqRjlGrMoZuLy5NSbV5t1ZcLXHC3jX7JNGha5K2POs1M9/ODtz3r1Eb16/ds7Onq31czBSvnVIiZX66cqt6JU72Bt4+PnNq/fw4tm3q9o+mxPDpsHj773DcWiICufBVvINU8agZcus+vXaCDVpKiFhY59oq5hEkjXGCLs/fLTuSCsZsjW431nyeoNWJeYS9bH6BW6rHsWJ8HcQeW2aYsvmmxcsTZO29nWFSwVSSMnJZmLp4hsZWIn6TgZudSEk+L68fnH5yx9G/p9GbQgx6rZCRFQVq61siKSIkMw8B3C0aaTYznpqDBIFi1HcglNqp2cw6KKt8hpz2z9b2aHpqMtSJyjUiUhhzZRHT9IYVYgohWyL78N36Rxep2Jnc7e5jDowm0I8Laa5VWTDJyauEAyEe9f7hskKgzjIwJPebHi9oZBe10MPjIhgUjDP1hpXUFdzr9B9k4lpVpd9EEd+mPqRn56D9Fba4hVaNxeet9vt+ht3bqJ8eexJ0YYRXwmRYwnLmuvSaoPhcF7CsQtnrdNy0aRMijQJsjzBeZ7Evp/5UbiIoiCLSUoxXqYkXdIoi+OkY0mXEGo1GZKKgqRPinb0arkqbM5jSoxeBZ1fpS1XsyGByb3fZCvWwFNwa9r75CDWexoDZgyXYfn4cImq+khwaQMtcSmknYIZV0IQfOLK47kC7bN3+yFRhs7OiBKEURw+kijTqPtY0tdowpH9NAgWUdIL+t/S4Cs/aQpWluIx3zTWwXfiDlPZcbhjiq+0IJtc2FrPyBOB5BN5/gXymAZaBpgbiypcIFXwfRTq+zyjkL9IwuSxFDqo4HOJZA46v+HCeWcOHqBTtsx6oU+ITo3EUCZMtZEiiDoX0v4BHodOAxQOfKt8sx+hUNZ/58dhxulH6OuwMVg+nxu2iR4MMDKT24IVay5qpOU1Ch/w467nY36EyyD1wyyY80MZgOy7GgeZsO+P5/Lti7+cV2NpZsKvHTsUcz4YIUma9kJOfPj+fCiCEx8O3v//Ch+K4Iv40PX8IR+ixRPhQy/k2/DBzq25h3ZsJxXK2aqbT4h0e/sPVDpH2UMWAAA=", "encoding": "UTF-8"}, "headers": {"content-length": ["998"], "x-xss-protection": ["1; mode=block"], "x-reddit-tracking": ["https://pixel.redditmedia.com/pixel/of_destiny.png?v=iUmmJuP8%2FUw3vEpphKEkrZhRWUSC0jy1erUuNMD00vIqzbYw%2FgNi7sPWsCJjpM9%2FoeBzgkuiBmVNYgBuNSotYyhtLeyPwJFh"], "x-content-type-options": ["nosniff"], "content-encoding": ["gzip"], "vary": ["accept-encoding"], "x-ratelimit-remaining": ["299"], "server": ["cloudflare-nginx"], "connection": ["keep-alive"], "x-ua-compatible": ["IE=edge"], "pragma": ["no-cache"], "cache-control": ["no-cache, no-cache"], "date": ["Tue, 28 Apr 2015 14:57:36 GMT"], "x-frame-options": ["SAMEORIGIN"], "x-moose": ["majestic"], "content-type": ["application/json; charset=UTF-8"], "cf-ray": ["1de39ed7a9f503dc-DFW"], "x-ratelimit-used": ["1"], "x-ratelimit-reset": ["144"]}, "status": {"message": "OK", "code": 200}, "url": "https://api.reddit.com/r/reddit_api_test/new.json?limit=5"}, "recorded_at": "2015-04-28T14:57:38"}, {"request": {"body": {"string": "kind=self&title=Test+Cache%3A+vd79ua7axfd4802301fbc059094cb6b6cd30f33ab0a191a66d&sr=reddit_api_test&uh=vd79ua7axfd4802301fbc059094cb6b6cd30f33ab0a191a66d&text=BODY&api_type=json", "encoding": "utf-8"}, "headers": {"Content-Length": ["177"], "Accept-Encoding": ["gzip, deflate"], "Accept": ["*/*"], "User-Agent": ["PRAW_test_suite PRAW/3.0a1 Python/2.7.5 Darwin-13.4.0-x86_64-i386-64bit"], "Connection": ["keep-alive"], "Cookie": ["reddit_session=7302867%2C2015-04-28T07%3A57%3A35%2C95e866fc793b75723e53ff54e1be6291797d56ab; __cfduid=dc19bd73cf18348a7ab86d7e35bd059991430233055"], "Content-Type": ["application/x-www-form-urlencoded"]}, "method": "POST", "uri": "https://api.reddit.com/api/submit/.json"}, "response": {"body": {"base64_string": "H4sIAAAAAAAAAyzMQQrDIBCF4asMsw6ZRdqNVylFRAc0RA3jFBfBuxebLv/vwbtwb7WggQtZpEpDA6/3Ahicuh9/5EADGFXPZoh676twCElXXzMJ3WHdmaxyU/I1Zy7aaHs8hSNNtN75yIQLYArz7d5mF5d5im72j2OMLwAAAP//AwA2q/zolgAAAA==", "encoding": "UTF-8"}, "headers": {"x-ratelimit-remaining": ["298"], "x-xss-protection": ["1; mode=block"], "x-content-type-options": ["nosniff"], "content-encoding": ["gzip"], "transfer-encoding": ["chunked"], "server": ["cloudflare-nginx"], "connection": ["keep-alive"], "x-ua-compatible": ["IE=edge"], "pragma": ["no-cache"], "cache-control": ["no-cache, no-cache"], "date": ["Tue, 28 Apr 2015 14:57:36 GMT"], "x-frame-options": ["SAMEORIGIN"], "x-moose": ["majestic"], "content-type": ["application/json; charset=UTF-8"], "cf-ray": ["1de39edb8a6203dc-DFW"], "x-ratelimit-used": ["2"], "x-ratelimit-reset": ["144"]}, "status": {"message": "OK", "code": 200}, "url": "https://api.reddit.com/api/submit/.json"}, "recorded_at": "2015-04-28T14:57:39"}, {"request": {"body": {"string": "", "encoding": "utf-8"}, "headers": {"Connection": ["keep-alive"], "Cookie": ["reddit_session=7302867%2C2015-04-28T07%3A57%3A35%2C95e866fc793b75723e53ff54e1be6291797d56ab; __cfduid=dc19bd73cf18348a7ab86d7e35bd059991430233055"], "Accept-Encoding": ["gzip, deflate"], "Accept": ["*/*"], "User-Agent": ["PRAW_test_suite PRAW/3.0a1 Python/2.7.5 Darwin-13.4.0-x86_64-i386-64bit"]}, "method": "GET", "uri": "https://www.reddit.com/r/reddit_api_test/comments/345reh/test_cache/.json"}, "response": {"body": {"base64_string": "H4sIAOGfP1UC/71UyW7bMBD9FVWHnOJos2QrQQ9tigAFiiZA20ORBMRwkcVaEgWSshME+fdyKCuOjS7opTfxzfJm5s3o9ilcy46H50H4SRoru1V4GoQcLDjoKWwVr8HUaM7Uj5SlLdCHlDO6zBZ5ztJyCZCWRbmgtBKQLOa0SvJMQBGLJcVMrJYN16JzGW73VDY7YOGqBYkuoRFNdaYF59IS6CWxwlh0pdB1ghP66Jy6oWkc1AougYiWCkz59OwgM9AxFlP9Igtmt+LBktq2DfqcNPbizWwWfLkk11dXwWx2srIXCHK5CVgDxry9C1t+F054jx/vrz98x0fkX3ed/3YRk9OU8fMu4WtqZMV4xBq5FsYBVg/CV79auUJdm0ZpdNw1OhihiRa9A9H79t6nY4MWxM9g79nIbk2qBqQmO66dQfqpZ/NcixqZV04UP7bYPUA7kTb+WUFjsBTWSLY+QEZ+VwYY1b2UAYOtlcbcN4/vbj5+deV/c9WmyNENLWGqbUXny0Ymw5QW7jvB0L7XanOkqQM0SZaveGvJud+eCbD10NIOpNfPT3YSnYxd2pykNlcF2tx47EEbrybEjCFe4j392M7v7Vxtfe/Yi7uMP4lytJhwOF9pCC5E+KJ9By0Oxh0G2avUC90CVoyWSEdHGx1N043GkAhBwoDVIvKDsU5Eeair028cSDLP4rRIlnlxht0M2s+ztrY/j6Ltdrs7wjPH8e/MB3Octr5SioJGs5W28d3ivgSXGHYebPiiHGABDxWfL+M0i5OKsjgv43LOaEELxrO4yjKgMSRlAkXB/e9lbIgMlk1NZVk8NdWjNLhsQ79RVhANViqEvPnoeDbSHC0LbvBeYgzh4y9ykKb2nhj6/OwvwV03HsIuGRXVuOqjx2nwH3+zfy/n/icoVl1C9gUAAA==", "encoding": "UTF-8"}, "headers": {"content-length": ["691"], "x-xss-protection": ["1; mode=block"], "x-reddit-tracking": ["https://pixel.redditmedia.com/pixel/of_destiny.png?v=yUDfQxRxyRNp5YXSYd2%2Bdr9PHilt5g4oyWJGWCnKKfbEiE%2FpXtPL8XxnnYhZZucK7gGWijABJF%2F4glKlYppzAcm5xWDaCiQw"], "x-content-type-options": ["nosniff"], "content-encoding": ["gzip"], "vary": ["accept-encoding"], "x-ratelimit-remaining": ["297"], "server": ["cloudflare-nginx"], "connection": ["keep-alive"], "x-ua-compatible": ["IE=edge"], "pragma": ["no-cache"], "cache-control": ["no-cache, no-cache"], "date": ["Tue, 28 Apr 2015 14:57:37 GMT"], "x-frame-options": ["SAMEORIGIN"], "x-moose": ["majestic"], "content-type": ["application/json; charset=UTF-8"], "cf-ray": ["1de39ee07dd50108-DFW"], "x-ratelimit-used": ["3"], "x-ratelimit-reset": ["143"]}, "status": {"message": "OK", "code": 200}, "url": "https://www.reddit.com/r/reddit_api_test/comments/345reh/test_cache/.json"}, "recorded_at": "2015-04-28T14:57:40"}, {"request": {"body": {"string": "", "encoding": "utf-8"}, "headers": {"Accept-Encoding": ["gzip, deflate"], "SKIP_BETAMAX": [0], "Accept": ["*/*"], "User-Agent": ["PRAW_test_suite PRAW/3.0a1 Python/2.7.5 Darwin-13.4.0-x86_64-i386-64bit"], "Connection": ["keep-alive"], "Cookie": ["reddit_session=7302867%2C2015-04-28T07%3A57%3A35%2C95e866fc793b75723e53ff54e1be6291797d56ab; __cfduid=dc19bd73cf18348a7ab86d7e35bd059991430233055"]}, "method": "GET", "uri": "https://api.reddit.com/r/reddit_api_test/new.json?limit=5"}, "response": {"body": {"base64_string": "H4sIAOKfP1UC/+2YXW/bNhSG/4qmi14tESVZkpViF12LAgO2NWg3DEMzEBRJWZwl0SApu0GQ/z4eWkok1Qa6uGk3NHfSIXnOez74QPaNvxYt8y88/2ehjWhX/veez4gh1nTjN5JVRFewXLcZ40VK4q4sU8opoiEhNE7yMENZyJc8RAiRMIpyUvKUoLwAT7QSNVO8tR7e39yFMvEkCpMNEbDF17wuzxVnTBhMNgIbrg1sLUjbcoaLa7up7eramhrOBMG8KTi4vLm1Jt0V+7Pg6oAX8G74B4Mr09Sw51ltnn93dua9e4nfvH7tnZ09W5nnYGRi69GaaP3Dld+wK3+wb+Dhxzev/oSXwL1dte7Znhg2DR5/7R2OQ0NUOA+2Wqy5tgajOu7Ur1ZWqE1TSwUb+0Q7zRVWfGONsPv9X84d7RTHrgb3O2vRrnFZE6FwH6tfEK7q8SJRvILIK9sUVzZkX4iyTdq615LUGqTQWtD1xLKPb2UQLds7GaQzlVTg+/L6xeVPv1n5v1u1EcRouwZT2TS8dbIhkqZScfscwtHNRsntrKfWoHC4HMWtBGNuegaDqbqmaIlw/XOVHZqO91maBEcmkSms2fKYSRqjClGtsWvxffh9OsfXmdy53F0uow7MppBMi2lvFV2LiUloDAPh3/V+w1VDQBxkEKhgNrzBUMhg38MAjJgSWvHA1Zo0UFd7r/B9k6lt1j77cBGjKA2XSXoO0jvlilcZs7kIgt1u19+4cxvl38eeFG0Y8VLKgihYNsLUThsMh/cSjl14W5blHcnIh5ItliiKUVgWFCU5yhe0SIuUshiVcUwKC5Q8JGnKRgnhztAhqThGfVJsT69O6MrlPKbE6FWy+VXaCj0bEpjc+02uYht4Cm9te58g9tUhJtHuCWJHIfX/gJjt4RwkU4j1TZ5DDMXoZIgdiP0QiK1MWi83KVcyTcKsSEhRJAuEMhRHyzgOswVNGSF5StOcxdlikRyFWJj0SX2zEOs9jQEzhsuw/PhwiZv2keDShUaRWio3BTOuRCD4iSuncwXa5+72x0QZOjsjShjFi+hEokyjHmJJX6MJRw7TIFzGSS/om6XBAz9pKl7X8pRvGufgK3GH6+xxuGOLr42k60K6Ws/IE4PkJ/J8BvLYBjoG2BuLG1JhXYlDFOr7PKMQWiZRciqFjir4VCLZg94vpPLe2YNH6JTlWS/0P0SnjSJQJsKMlSKpPpfK/Y31OHQaoHDkW+WL/RCKVPu3+4/t8zPj6YfQw7AxWD6dG66JAQwwtpPbgZUYIVts1DWOPuLHXc/H/IjyMEVRFs75oS1ADl2No0w49Ivn8u2LP7xXY2l2wq89NxRzPlghSZr2Qr4MH9zc2nvoxnZSoYKX+/mESLe3/wAwrB4D6BYAAA==", "encoding": "UTF-8"}, "headers": {"content-length": ["1048"], "x-xss-protection": ["1; mode=block"], "x-reddit-tracking": ["https://pixel.redditmedia.com/pixel/of_destiny.png?v=ptDwG%2FS17cDBFahg2eFBXnHZi401AKrvWF%2BPx8DK5%2BqOVCzKCbktgETOUZCpbafBooBwUoTVXZCB%2FBtM5AsSIiiUDuNnkQQj"], "x-content-type-options": ["nosniff"], "content-encoding": ["gzip"], "vary": ["accept-encoding"], "x-ratelimit-remaining": ["296"], "server": ["cloudflare-nginx"], "connection": ["keep-alive"], "x-ua-compatible": ["IE=edge"], "pragma": ["no-cache"], "cache-control": ["no-cache, no-cache"], "date": ["Tue, 28 Apr 2015 14:57:38 GMT"], "x-frame-options": ["SAMEORIGIN"], "x-moose": ["majestic"], "content-type": ["application/json; charset=UTF-8"], "cf-ray": ["1de39ee32b2403dc-DFW"], "x-ratelimit-used": ["4"], "x-ratelimit-reset": ["143"]}, "status": {"message": "OK", "code": 200}, "url": "https://api.reddit.com/r/reddit_api_test/new.json?limit=5"}, "recorded_at": "2015-04-28T14:57:40"}], "recorded_with": "betamax/0.4.2"}