Now with *real* cacheing!

* no need to reset the graph reference file
* send a hash along with the request to check for an update
* if the request fails *and* there’s no local reference —> error.

Author: theengineear

plotly/graph_reference.py

@@ -4,12 +4,14 @@
 """
 from __future__ import absolute_import
 
+import hashlib
 import json
 import requests
 
 from plotly import exceptions, files, utils
 
-GRAPH_REFERENCE_PATH = '/plot-schema.json'
+GRAPH_REFERENCE_PATH = '/v2/plot-schema'
+
 
 def get_graph_reference():
     """
@@ -19,36 +21,39 @@ def get_graph_reference():
     :raises: (PlotlyError) When graph reference DNE and GET request fails.
 
     """
+    default_config = files.FILE_CONTENT[files.CONFIG_FILE]
     if files.check_file_permissions():
         graph_reference = utils.load_json_dict(files.GRAPH_REFERENCE_FILE)
         config = utils.load_json_dict(files.CONFIG_FILE)
 
         # TODO: https://github.com/plotly/python-api/issues/293
-        default_domain = files.FILE_CONTENT[files.CONFIG_FILE]['plotly_domain']
-        plotly_domain = config.get('plotly_domain', default_domain)
+        plotly_api_domain = config.get('plotly_api_domain',
+                                       default_config['plotly_api_domain'])
     else:
         graph_reference = {}
-        plotly_domain = files.FILE_CONTENT[files.CONFIG_FILE]['plotly_domain']
+        plotly_api_domain = default_config['plotly_api_domain']
 
-    if not graph_reference:
+    sha1 = hashlib.sha1(str(graph_reference)).hexdigest()
 
-        graph_reference_url = plotly_domain + GRAPH_REFERENCE_PATH
+    graph_reference_url = '{}{}?sha1={}'.format(plotly_api_domain,
+                                                GRAPH_REFERENCE_PATH, sha1)
 
-        try:
-            response = requests.get(graph_reference_url)
-            response.raise_for_status()
-        except requests.exceptions.RequestException:
+    try:
+        response = requests.get(graph_reference_url)
+        response.raise_for_status()
+    except requests.exceptions.RequestException:
+        if not graph_reference:
             raise exceptions.PlotlyError(
                 "The schema used to validate Plotly figures has never been "
                 "downloaded to your computer. You'll need to connect to a "
                 "Plotly server at least once to do this.\n"
                 "You're seeing this error because the attempt to download "
                 "the schema from '{}' failed.".format(graph_reference_url)
             )
-
-        # TODO: Hash this so we don't have to load it every time. The server
-        #       will need to accept a hash query param as well.
-        graph_reference = json.loads(response.content)
+    else:
+        data = json.loads(response.content)
+        if data['modified']:
+            graph_reference = data['schema']
 
     return utils.decode_unicode(graph_reference)
 

plotly/tools.py

@@ -82,11 +82,9 @@ def ensure_local_plotly_files():
 
         # make a request to get graph reference if DNE.
         utils.ensure_file_exists(GRAPH_REFERENCE_FILE)
-        graph_reference_dict = utils.load_json_dict(GRAPH_REFERENCE_FILE)
+        utils.save_json_dict(GRAPH_REFERENCE_FILE,
+                             graph_reference.GRAPH_REFERENCE)
 
-        if not graph_reference_dict:
-            utils.save_json_dict(GRAPH_REFERENCE_FILE,
-                                 graph_reference.GRAPH_REFERENCE)
     else:
         warnings.warn("Looks like you don't have 'read-write' permission to "
                       "your 'home' ('~') directory or to our '~/.plotly' "
@@ -230,14 +228,6 @@ def reset_config_file():
     ensure_local_plotly_files()  # put the defaults back
 
 
-### graph reference tools ###
-
-def reset_graph_reference_file():
-    """Temporary until we can use local hash in request for graph reference."""
-    utils.ensure_file_exists(GRAPH_REFERENCE_FILE)
-    utils.save_json_dict(GRAPH_REFERENCE_FILE, {})
-
-
 ### embed tools ###
 
 def get_embed(file_owner_or_url, file_id=None, width="100%", height=525):