Remove prefer_cache parameter

With proper freshness handling of stored responses, prefer_cached argument
becomes obsolete. It was only used by readme client used by packagecontrol.io

Hence it haven't been of any importance for quite a while in PC4.

Author: deathaxe

package_control/clients/bitbucket_client.py

@@ -341,7 +341,7 @@ def _api_url(self, user_repo, suffix=''):
 
         return 'https://api.bitbucket.org/2.0/repositories/%s%s' % (user_repo, suffix)
 
-    def _readme_url(self, user_repo, branch, prefer_cached=False):
+    def _readme_url(self, user_repo, branch):
         """
         Parse the root directory listing for the repo and return the URL
         to any file that looks like a readme
@@ -352,9 +352,6 @@ def _readme_url(self, user_repo, branch, prefer_cached=False):
         :param branch:
             The branch to fetch the readme from
 
-        :param prefer_cached:
-            If a cached directory listing should be used instead of a new HTTP request
-
         :raises:
             DownloaderException: when there is an error downloading
             ClientException: when there is an error parsing the response
@@ -367,7 +364,7 @@ def _readme_url(self, user_repo, branch, prefer_cached=False):
 
         try:
             while listing_url:
-                root_dir_info = self.fetch_json(listing_url, prefer_cached)
+                root_dir_info = self.fetch_json(listing_url)
 
                 for entry in root_dir_info['values']:
                     if entry['path'].lower() in _readme_filenames:

package_control/clients/github_client.py

@@ -530,7 +530,7 @@ def _api_url(self, user_repo, suffix=''):
 
         return 'https://api.github.com/repos/%s%s' % (user_repo, suffix)
 
-    def _readme_url(self, user_repo, branch, prefer_cached=False):
+    def _readme_url(self, user_repo, branch):
         """
         Fetches the raw GitHub API information about a readme
 
@@ -540,9 +540,6 @@ def _readme_url(self, user_repo, branch, prefer_cached=False):
         :param branch:
             The branch to pull the readme from
 
-        :param prefer_cached:
-            If a cached version of the info should be returned instead of making a new HTTP request
-
         :raises:
             DownloaderException: when there is an error downloading
             ClientException: when there is an error parsing the response
@@ -555,7 +552,7 @@ def _readme_url(self, user_repo, branch, prefer_cached=False):
         readme_url = self._api_url(user_repo, '/readme?%s' % query_string)
 
         try:
-            readme_file = self.fetch_json(readme_url, prefer_cached).get('path')
+            readme_file = self.fetch_json(readme_url).get('path')
             if readme_file:
                 return 'https://raw.githubusercontent.com/%s/%s/%s' % (user_repo, branch, readme_file)
 

package_control/clients/json_api_client.py

@@ -10,16 +10,13 @@ class JSONApiClient:
     def __init__(self, settings):
         self.settings = settings
 
-    def fetch(self, url, prefer_cached=False):
+    def fetch(self, url):
         """
         Retrieves the contents of a URL
 
         :param url:
             The URL to download the content from
 
-        :param prefer_cached:
-            If a cached copy of the content is preferred
-
         :raises:
             DownloaderException: when there is an error downloading
 
@@ -35,26 +32,23 @@ def fetch(self, url, prefer_cached=False):
             joiner = '?%s' if url.find('?') == -1 else '&%s'
             url += joiner % params
 
-        return http_get(url, self.settings, 'Error downloading repository.', prefer_cached)
+        return http_get(url, self.settings, 'Error downloading repository.')
 
-    def fetch_json(self, url, prefer_cached=False):
+    def fetch_json(self, url):
         """
         Retrieves and parses the JSON from a URL
 
         :param url:
             The URL to download the JSON from
 
-        :param prefer_cached:
-            If a cached copy of the JSON is preferred
-
         :raises:
             ClientException: when there is an error parsing the response
 
         :return:
             A dict or list from the JSON
         """
 
-        repository_json = self.fetch(url, prefer_cached)
+        repository_json = self.fetch(url)
 
         try:
             return json.loads(repository_json.decode('utf-8'))

package_control/clients/readme_client.py

@@ -55,7 +55,7 @@ def readme_info(self, url):
             query_string = urlencode({'ref': branch})
             readme_json_url = 'https://api.github.com/repos/%s/readme?%s' % (user_repo, query_string)
             try:
-                info = self.fetch_json(readme_json_url, prefer_cached=True)
+                info = self.fetch_json(readme_json_url)
                 contents = base64.b64decode(info['content'])
             except (ValueError):
                 pass

package_control/download_manager.py

@@ -33,7 +33,7 @@
 """A timer used to disconnect all managers after a period of no usage"""
 
 
-def http_get(url, settings, error_message='', prefer_cached=False):
+def http_get(url, settings, error_message=''):
     """
     Performs a HTTP GET request using best matching downloader.
 
@@ -58,9 +58,6 @@ def http_get(url, settings, error_message='', prefer_cached=False):
     :param error_message:
         The error message to include if the download fails
 
-    :param prefer_cached:
-        If cached version of the URL content is preferred over a new request
-
     :raises:
         DownloaderException: if there was an error downloading the URL
 
@@ -80,7 +77,7 @@ def http_get(url, settings, error_message='', prefer_cached=False):
 
     try:
         manager = _grab(url, settings)
-        result = manager.fetch(url, error_message, prefer_cached)
+        result = manager.fetch(url, error_message)
 
     finally:
         if manager:
@@ -337,7 +334,7 @@ def close(self):
             self.downloader.close()
             self.downloader = None
 
-    def fetch(self, url, error_message, prefer_cached=False):
+    def fetch(self, url, error_message):
         """
         Downloads a URL and returns the contents
 
@@ -347,9 +344,6 @@ def fetch(self, url, error_message, prefer_cached=False):
         :param error_message:
             The error message to include if the download fails
 
-        :param prefer_cached:
-            If cached version of the URL content is preferred over a new request
-
         :raises:
             DownloaderException: if there was an error downloading the URL
 
@@ -496,7 +490,7 @@ def fetch(self, url, error_message, prefer_cached=False):
             raise exception
 
         try:
-            return self.downloader.download(url, error_message, timeout, 3, prefer_cached)
+            return self.downloader.download(url, error_message, timeout, 3)
 
         except (RateLimitException) as e:
             # rate limits are normally reset after an hour

package_control/downloaders/curl_downloader.py

@@ -37,7 +37,7 @@ def close(self):
 
         pass
 
-    def download(self, url, error_message, timeout, tries, prefer_cached=False):
+    def download(self, url, error_message, timeout, tries):
         """
         Downloads a URL and returns the contents
 
@@ -55,9 +55,6 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The int number of times to try and download the URL in the case of
             a timeout or HTTP 503 error
 
-        :param prefer_cached:
-            If a cached version should be returned instead of trying a new request
-
         :raises:
             RateLimitException: when a rate limit is hit
             DownloaderException: when any other download error occurs
@@ -66,7 +63,7 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The string contents of the URL
         """
 
-        if prefer_cached or self.is_cache_fresh(url):
+        if self.is_cache_fresh(url):
             cached = self.retrieve_cached(url)
             if cached:
                 return cached

package_control/downloaders/oscrypto_downloader.py

@@ -57,7 +57,7 @@ def close(self):
         self.socket = None
         self.using_proxy = False
 
-    def download(self, url, error_message, timeout, tries, prefer_cached=False):
+    def download(self, url, error_message, timeout, tries):
         """
         Downloads a URL and returns the contents
 
@@ -79,9 +79,6 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The int number of times to try and download the URL in the case of
             a timeout or HTTP 503 error
 
-        :param prefer_cached:
-            If a cached version should be returned instead of trying a new request
-
         :raises:
             RateLimitException: when a rate limit is hit
             DownloaderException: when any other download error occurs
@@ -90,7 +87,7 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The string contents of the URL
         """
 
-        if prefer_cached or self.is_cache_fresh(url):
+        if self.is_cache_fresh(url):
             cached = self.retrieve_cached(url)
             if cached:
                 return cached
@@ -157,7 +154,7 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
                         if not location.startswith('/'):
                             location = os.path.dirname(url_info.path) + location
                         location = url_info.scheme + '://' + url_info.netloc + location
-                    return self.download(location, error_message, timeout, tried, prefer_cached)
+                    return self.download(location, error_message, timeout, tried)
 
                 # Make sure we obey Github's rate limiting headers
                 self.handle_rate_limit(resp_headers, url)

package_control/downloaders/urllib_downloader.py

@@ -50,7 +50,7 @@ def close(self):
             handler.close()
         self.opener = None
 
-    def download(self, url, error_message, timeout, tries, prefer_cached=False):
+    def download(self, url, error_message, timeout, tries):
         """
         Downloads a URL and returns the contents
 
@@ -72,9 +72,6 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The int number of times to try and download the URL in the case of
             a timeout or HTTP 503 error
 
-        :param prefer_cached:
-            If a cached version should be returned instead of trying a new request
-
         :raises:
             RateLimitException: when a rate limit is hit
             DownloaderException: when any other download error occurs
@@ -83,7 +80,7 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The string contents of the URL
         """
 
-        if prefer_cached or self.is_cache_fresh(url):
+        if self.is_cache_fresh(url):
             cached = self.retrieve_cached(url)
             if cached:
                 return cached

package_control/downloaders/wget_downloader.py

@@ -40,7 +40,7 @@ def close(self):
 
         pass
 
-    def download(self, url, error_message, timeout, tries, prefer_cached=False):
+    def download(self, url, error_message, timeout, tries):
         """
         Downloads a URL and returns the contents
 
@@ -58,9 +58,6 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The int number of times to try and download the URL in the case of
             a timeout or HTTP 503 error
 
-        :param prefer_cached:
-            If a cached version should be returned instead of trying a new request
-
         :raises:
             RateLimitException: when a rate limit is hit
             DownloaderException: when any other download error occurs
@@ -69,7 +66,7 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The string contents of the URL
         """
 
-        if prefer_cached or self.is_cache_fresh(url):
+        if self.is_cache_fresh(url):
             cached = self.retrieve_cached(url)
             if cached:
                 return cached

package_control/downloaders/wininet_downloader.py

@@ -212,7 +212,7 @@ def close(self):
         self.use_count = 0
         self.was_offline = None
 
-    def download(self, url, error_message, timeout, tries, prefer_cached=False):
+    def download(self, url, error_message, timeout, tries):
         """
         Downloads a URL and returns the contents
 
@@ -230,9 +230,6 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The int number of times to try and download the URL in the case of
             a timeout or HTTP 503 error
 
-        :param prefer_cached:
-            If a cached version should be returned instead of trying a new request
-
         :raises:
             RateLimitException: when a rate limit is hit
             DownloaderException: when any other download error occurs
@@ -242,7 +239,7 @@ def download(self, url, error_message, timeout, tries, prefer_cached=False):
             The string contents of the URL
         """
 
-        if prefer_cached or self.is_cache_fresh(url):
+        if self.is_cache_fresh(url):
             cached = self.retrieve_cached(url)
             if cached:
                 return cached