Merge branch 'master' of https://github.com/plotly/python-api into etienne-factories

Author: etpinard

plotly/matplotlylib/mpltools.py

@@ -7,6 +7,8 @@
 
 import math
 import warnings
+import datetime
+import matplotlib.dates
 
 def check_bar_match(old_bar, new_bar):
     """Check if two bars belong in the same collection (bar chart).
@@ -416,6 +418,17 @@ def prep_ticks(ax, index, ax_type, props):
         return dict()
     # get tick label formatting information
     formatter = axis.get_major_formatter().__class__.__name__
+    if ax_type == 'x' and formatter == 'DateFormatter':
+        axis_dict['type'] = 'date'
+        try:
+            axis_dict['tick0'] = mpl_dates_to_datestrings(axis_dict['tick0'])
+        except KeyError:
+            pass
+        finally:
+            axis_dict.pop('dtick', None)
+            axis_dict.pop('autotick', None)
+            axis_dict['range'] = mpl_dates_to_datestrings(props['xlim'])
+
     if formatter == 'LogFormatterMathtext':
         axis_dict['exponentformat'] = 'e'
     return axis_dict
@@ -442,6 +455,22 @@ def prep_xy_axis(ax, props, x_bounds, y_bounds):
     yaxis.update(prep_ticks(ax, 1, 'y', props))
     return xaxis, yaxis
 
+def mpl_dates_to_datestrings(mpl_dates, format_string="%Y-%m-%d %H:%M:%S"):
+    try:
+        # make sure we have a list
+        mpl_date_list = list(mpl_dates)
+        epoch_times = matplotlib.dates.num2epoch(mpl_date_list)
+        date_times = [datetime.datetime.utcfromtimestamp(epoch_time)
+                      for epoch_time in epoch_times]
+        time_strings = [date_time.strftime(format_string)
+                        for date_time in date_times]
+        if len(time_strings) > 1:
+            return time_strings
+        else:
+            return time_strings[0]
+    except TypeError:
+        return mpl_dates
+
 
 DASH_MAP = {
     '10,0': 'solid',

plotly/matplotlylib/renderer.py

@@ -54,6 +54,7 @@ def __init__(self):
         self.bar_containers = None
         self.current_bars = []
         self.axis_ct = 0
+        self.x_is_mpl_date = False
         self.mpl_x_bounds = (0, 1)
         self.mpl_y_bounds = (0, 1)
         self.msg = "Initialized PlotlyRenderer\n"
@@ -176,6 +177,10 @@ def open_axes(self, ax, props):
         self.plotly_fig['layout']['xaxis{0}'.format(self.axis_ct)] = xaxis
         self.plotly_fig['layout']['yaxis{0}'.format(self.axis_ct)] = yaxis
 
+        # let all subsequent dates be handled properly if required
+        if xaxis.get('type') == 'date':
+            self.x_is_mpl_date = True
+
     def close_axes(self, ax):
         """Close the axes object and clean up.
 
@@ -190,6 +195,7 @@ def close_axes(self, ax):
         """
         self.draw_bars(self.current_bars)
         self.msg += "  Closing axes\n"
+        self.x_is_mpl_date = False
 
     def draw_bars(self, bars):
 
@@ -250,6 +256,9 @@ def draw_bar(self, coll):
             y = [bar['y1'] for bar in trace]
             bar_gap = mpltools.get_bar_gap([bar['x0'] for bar in trace],
                                            [bar['x1'] for bar in trace])
+            if self.x_is_mpl_date:
+                x = [bar['x0'] for bar in trace]
+                x = mpltools.mpl_dates_to_datestrings(x)
         else:
             self.msg += "    Attempting to draw a horizontal bar chart\n"
             old_rights = [bar_props['x1'] for bar_props in trace]
@@ -357,6 +366,10 @@ def draw_marked_line(self, **props):
                 yaxis='y{0}'.format(self.axis_ct),
                 line=line,
                 marker=marker)
+            if self.x_is_mpl_date:
+                marked_line['x'] = mpltools.mpl_dates_to_datestrings(
+                    marked_line['x']
+                )
             self.plotly_fig['data'] += marked_line,
             self.msg += "    Heck yeah, I drew that line\n"
         else:

plotly/tests/test_core/test_get_figure/test_get_figure.py

@@ -91,17 +91,17 @@ def is_trivial(obj):
 
 
 def test_get_figure():
-    un = 'plotlyimagetest'
+    un = 'PlotlyImageTest'
     ak = '786r5mecv0'
     file_id = 2
     py.sign_in(un, ak)
     print("getting: https://plot.ly/~{0}/{1}/".format(un, file_id))
     print("###########################################\n\n")
-    fig = py.get_figure('plotlyimagetest', str(file_id))
+    fig = py.get_figure('PlotlyImageTest', str(file_id))
 
 
 def test_get_figure_with_url():
-    un = 'plotlyimagetest'
+    un = 'PlotlyImageTest'
     ak = '786r5mecv0'
     url = "https://plot.ly/~PlotlyImageTest/2/"
     py.sign_in(un, ak)
@@ -112,7 +112,7 @@ def test_get_figure_with_url():
 
 @raises(exceptions.PlotlyError)
 def test_get_figure_invalid_1():
-    un = 'plotlyimagetest'
+    un = 'PlotlyImageTest'
     ak = '786r5mecv0'
     url = "https://plot.ly/~PlotlyImageTest/a/"
     py.sign_in(un, ak)
@@ -123,7 +123,7 @@ def test_get_figure_invalid_1():
 
 @raises(exceptions.PlotlyError)
 def test_get_figure_invalid_2():
-    un = 'plotlyimagetest'
+    un = 'PlotlyImageTest'
     ak = '786r5mecv0'
     url = "https://plot.ly/~PlotlyImageTest/-1/"
     py.sign_in(un, ak)
@@ -134,7 +134,7 @@ def test_get_figure_invalid_2():
 
 @raises(exceptions.PlotlyError)
 def test_get_figure_does_not_exist():
-    un = 'plotlyimagetest'
+    un = 'PlotlyImageTest'
     ak = '786r5mecv0'
     url = "https://plot.ly/~PlotlyImageTest/1000000000/"
     py.sign_in(un, ak)
@@ -144,17 +144,17 @@ def test_get_figure_does_not_exist():
 
 
 def test_get_figure_raw():
-    un = 'plotlyimagetest'
+    un = 'PlotlyImageTest'
     ak = '786r5mecv0'
     file_id = 2
     py.sign_in(un, ak)
     print("getting: https://plot.ly/~{0}/{1}/".format(un, file_id))
     print("###########################################\n\n")
-    fig = py.get_figure('plotlyimagetest', str(file_id), raw=True)
+    fig = py.get_figure('PlotlyImageTest', str(file_id), raw=True)
 
 
 def test_all():
-    un = 'plotlyimagetest'
+    un = 'PlotlyImageTest'
     ak = '786r5mecv0'
     run_test = False
     end_file = 2
@@ -173,8 +173,8 @@ def test_all():
             try:
                 print("testing: https://plot.ly/~{0}/{1}".format(un, file_id))
                 print("###########################################\n\n")
-                fig = py.get_figure('plotlyimagetest', str(file_id))
-                fig_raw = py.get_figure('plotlyimagetest',
+                fig = py.get_figure('PlotlyImageTest', str(file_id))
+                fig_raw = py.get_figure('PlotlyImageTest',
                                         str(file_id),
                                         raw=True)
             except exceptions.PlotlyError:

plotly/tests/test_core/test_get_requests/test_get_requests.py

@@ -46,7 +46,7 @@ def test_user_does_not_exist():
 
 
 def test_file_does_not_exist():
-    username = 'plotlyimagetest'
+    username = 'PlotlyImageTest'
     api_key = '786r5mecv0'
     file_owner = 'get_test_user'
     file_id = 1000
@@ -67,7 +67,7 @@ def test_file_does_not_exist():
 
 
 def test_wrong_api_key():  # TODO: does this test the right thing?
-    username = 'plotlyimagetest'
+    username = 'PlotlyImageTest'
     api_key = 'invalid-apikey'
     file_owner = 'get_test_user'
     file_id = 0
@@ -84,7 +84,7 @@ def test_wrong_api_key():  # TODO: does this test the right thing?
 # TODO
 
 def test_private_permission_defined():
-    username = 'plotlyimagetest'
+    username = 'PlotlyImageTest'
     api_key = '786r5mecv0'
     file_owner = 'get_test_user'
     file_id = 1  # 1 is a private file
@@ -124,7 +124,7 @@ def test_missing_headers():
 
 
 def test_valid_request():
-    username = 'plotlyimagetest'
+    username = 'PlotlyImageTest'
     api_key = '786r5mecv0'
     file_owner = 'get_test_user'
     file_id = 0

plotly/tests/test_core/test_plotly/test_plot.py

@@ -13,12 +13,12 @@
 from plotly.exceptions import PlotlyError
 
 
-# username for tests: 'plotlyimagetest'
+# username for tests: 'PlotlyImageTest'
 # api_key for account: '786r5mecv0'
 
 
 def test_plot_valid():
-    py.sign_in('plotlyimagetest', '786r5mecv0')
+    py.sign_in('PlotlyImageTest', '786r5mecv0')
     fig = {
         'data':[
             {

plotly/tests/test_core/test_stream/test_stream.py

@@ -13,7 +13,7 @@
 import plotly.plotly as py
 from plotly import exceptions
 
-un = 'pythonapi'
+un = 'PythonAPI'
 ak = 'ubpiol2cve'
 tk = 'vaia8trjjb'
 

plotly/tests/test_optional/test_ipython/test_embed.py

@@ -15,7 +15,7 @@
     class TestPlotlyDisplay(unittest.TestCase):
 
         def setUp(self):
-            plot_info = {"un": "plotlyimagetest", "fid": "2"}
+            plot_info = {"un": "PlotlyImageTest", "fid": "2"}
             url = "https://plot.ly/~{un}/{fid}".format(**plot_info)
             self.display_obj = tls.embed(url)
             self.results = {}

plotly/tools.py

@@ -72,9 +72,8 @@ def check_file_permissions():
 def ensure_local_plotly_files():
     """Ensure that filesystem is setup/filled out in a valid way"""
     if _file_permissions:
-        if not os.path.isdir(PLOTLY_DIR):
-            os.mkdir(PLOTLY_DIR)
         for fn in [CREDENTIALS_FILE, CONFIG_FILE]:
+            utils.ensure_file_exists(fn)
             contents = utils.load_json_dict(fn)
             for key, val in list(_FILE_CONTENT[fn].items()):
                 # TODO: removed type checking below, may want to revisit
@@ -134,8 +133,7 @@ def get_credentials_file(*args):
 
 def reset_credentials_file():
     ensure_local_plotly_files()  # make sure what's there is OK
-    f = open(CREDENTIALS_FILE, 'w')
-    f.close()
+    utils.save_json_dict(CREDENTIALS_FILE, {})
     ensure_local_plotly_files()  # put the defaults back
 
 

plotly/utils.py

@@ -9,6 +9,10 @@
 import json
 import os.path
 import sys
+import threading
+
+### incase people are using threadig, we lock file reads
+lock = threading.Lock()
 
 
 ### general file setup tools ###
@@ -17,13 +21,15 @@ def load_json_dict(filename, *args):
     """Checks if file exists. Returns {} if something fails."""
     data = {}
     if os.path.exists(filename):
+        lock.acquire()
         with open(filename, "r") as f:
             try:
                 data = json.load(f)
                 if not isinstance(data, dict):
                     data = {}
             except:
-                pass # TODO: issue a warning and bubble it up
+                data = {}  # TODO: issue a warning and bubble it up
+        lock.release()
         if args:
             d = dict()
             for key in args:
@@ -36,13 +42,32 @@ def load_json_dict(filename, *args):
 
 
 def save_json_dict(filename, json_dict):
-    """Will error if filename is not appropriate, but it's checked elsewhere.
-    """
+    """Save json to file. Error if path DNE, not a dict, or invalid json."""
     if isinstance(json_dict, dict):
+        # this will raise a TypeError if something goes wrong
+        json_string = json.dumps(json_dict, indent=4)
+        lock.acquire()
         with open(filename, "w") as f:
-            f.write(json.dumps(json_dict, indent=4))
+            f.write(json_string)
+        lock.release()
     else:
-        raise TypeError("json_dict was not a dictionay. couldn't save.")
+        raise TypeError("json_dict was not a dictionary. not saving.")
+
+
+def ensure_file_exists(filename):
+    """Given a valid filename, make sure it exists (will create if DNE)."""
+    if not os.path.exists(filename):
+        head, tail = os.path.split(filename)
+        ensure_dir_exists(head)
+        with open(filename, 'w') as f:
+            pass  # just create the file
+
+
+def ensure_dir_exists(directory):
+    """Given a valid directory path, make sure it exists."""
+    if dir:
+        if not os.path.isdir(directory):
+            os.makedirs(directory)
 
 
 ### Custom JSON encoders ###

plotly/version.py

@@ -1 +1 @@
-__version__ = '1.2.8'
+__version__ = '1.2.9'