Merge branch 'grid_api' of https://github.com/plotly/python-api into grid_api

Author: theengineear

plotly/exceptions.py

@@ -23,11 +23,12 @@ class PlotlyError(Exception):
     pass
 
 
-class InputError(Exception):
+
+class InputError(PlotlyError):
     pass
 
 
-class PlotlyRequestError(Exception):
+class PlotlyRequestError(PlotlyError):
     def __init__(self, requests_exception):
         self.status_code = requests_exception.response.status_code
         self.HTTPError = requests_exception
@@ -67,6 +68,10 @@ def __str__(self):
     "can't have duplicate column names. Rename "
     "the column \"{}\" and try again."
 )
+## Would Cause Server Errors ##
+
+class PlotlyEmptyDataError(PlotlyError):
+    pass
 
 
 ## Graph Objects Errors ##

plotly/graph_objs/graph_objs_tools.py

@@ -211,7 +211,7 @@ def curtail_val_repr(val, max_chars, add_delim=False):
             # TODO: can we assume this ends in "'"
             r = r[:max_chars - len(end + "'")] + end + "'"
         elif (isinstance(val, list) and
-              max_chars >= len("[{end}]".format(end))):
+              max_chars >= len("[{end}]".format(end=end))):
             r = r[:max_chars - len(end + ']')] + end + ']'
         else:
             r = r[:max_chars - len(end)] + end

plotly/graph_reference/graph_objs_meta.json

@@ -3736,13 +3736,13 @@
             }, 
             "bargap": {
                 "key_type": "style", 
-                "val_types": "number: x >= 0", 
+                "val_types": "number: x in [0, 1)", 
                 "required": false, 
                 "description": "For bar and histogram plots only. Sets the gap between bars (or sets of bars) at different locations."
             }, 
             "bargroupgap": {
                 "key_type": "style", 
-                "val_types": "number: x >= 0", 
+                "val_types": "number: x in [0, 1)", 
                 "required": false, 
                 "description": "For bar and histogram plots only. Sets the gap between bars in the same group. That is, when multiple bar objects are plotted and share the same locations, this sets the distance between bars at each ___location."
             }, 
@@ -3752,6 +3752,18 @@
                 "required": false, 
                 "description": "For box plots only. Sets how groups of box plots appear. If set to 'overlay', a group of boxes will be plotted directly on top of one another at their specified ___location. If set to 'group', the boxes will be centered around their shared ___location, but they will not overlap."
             }, 
+            "boxgap": {
+                "key_type": "style", 
+                "val_types": "number: x in [0, 1)", 
+                "required": false, 
+                "description": "For box plots only. Sets the gap between boxes at different locations (i.e. x-labels). If there are multiple boxes at a single x-label, then this sets the gap between these sets of boxes.For example, if 0, then there is no gap between boxes. If 0.25, then this gap occupies 25% of the available space and the box width (or width of the set of boxes) occupies the remaining 75%."
+            }, 
+            "boxgroupgap": {
+                "key_type": "style", 
+                "val_types": "number: x in [0, 1)", 
+                "required": false, 
+                "description": "For box plots only. Sets the gap between boxes in the same group, where a group is the set of boxes with the same ___location (i.e. x-label). For example, if 0, then there is no gap between boxes. If 0.25, then this gap occupies 25% of the available space and the box width occupies the remaining 75%."
+            }, 
             "radialaxis": {
                 "key_type": "object", 
                 "val_types": "dictionary-like object", 
@@ -3868,13 +3880,13 @@
                 "key_type": "style", 
                 "val_types": "number", 
                 "required": false, 
-                "description": "Sets the 'x' position of this legend.Use in conjunction with 'xref' and 'xanchor' to fine-tune the ___location of this legend."
+                "description": "Sets the 'x' position of this legend. Use in conjunction with 'xref' and 'xanchor' to fine-tune the ___location of this legend."
             }, 
             "y": {
                 "key_type": "style", 
                 "val_types": "number", 
                 "required": false, 
-                "description": "Sets the 'y' position of this legend.Use in conjunction with 'yref' and 'yanchor' to fine-tune the ___location of this legend."
+                "description": "Sets the 'y' position of this legend. Use in conjunction with 'yref' and 'yanchor' to fine-tune the ___location of this legend."
             }, 
             "traceorder": {
                 "key_type": "style", 
@@ -3964,22 +3976,22 @@
                 "key_type": "plot_info", 
                 "val_types": "number", 
                 "required": false, 
-                "description": "Sets the 'x' position of this annotation.Use in conjunction with 'xref' and 'xanchor' to fine-tune the ___location of this annotation."
+                "description": "Sets the 'x' position of this annotation. Use in conjunction with 'xref' and 'xanchor' to fine-tune the ___location of this annotation."
             }, 
             "y": {
                 "key_type": "plot_info", 
                 "val_types": "number", 
                 "required": false, 
-                "description": "Sets the 'y' position of this annotation.Use in conjunction with 'yref' and 'yanchor' to fine-tune the ___location of this annotation."
+                "description": "Sets the 'y' position of this annotation. Use in conjunction with 'yref' and 'yanchor' to fine-tune the ___location of this annotation."
             }, 
             "xref": {
-                "key_type": "style", 
+                "key_type": "plot_info", 
                 "val_types": "'paper' | 'x1' | 'x2' | etc", 
                 "required": false, 
                 "description": "Sets the x coordinate system which this object refers to. If you reference an axis, e.g., 'x2', the object will move with pan-and-zoom to stay fixed to this point. If you reference the 'paper', it remains fixed regardless of pan-and-zoom. In other words, if set to 'paper', the 'x' ___location refers to the distance from the left side of the plotting area in normalized coordinates where 0 is 'left' and 1 is 'right'. If set to refer to an xaxis' , e.g., 'x1', 'x2', 'x3', etc., the 'x' ___location will refer to the ___location in terms of this axis."
             }, 
             "yref": {
-                "key_type": "style", 
+                "key_type": "plot_info", 
                 "val_types": "'paper' | 'y1' | 'y2' | etc", 
                 "required": false, 
                 "description": "Sets the y coordinate system which this object refers to. If you reference an axis, e.g., 'y2', the object will move with pan-and-zoom to stay fixed to this point. If you reference the 'paper', it remains fixed regardless of pan-and-zoom. In other words, if set to 'paper', the 'y' ___location refers to the distance from the left side of the plotting area in normalized coordinates where 0 is 'bottom' and 1 is 'top'. If set to refer to an yaxis' , e.g., 'y1', 'y2', 'y3', etc., the 'y' ___location will refer to the ___location in terms of this axis."

plotly/matplotlylib/mpltools.py

@@ -7,8 +7,9 @@
 
 import math
 import warnings
-import datetime
 import matplotlib.dates
+import pytz
+
 
 def check_bar_match(old_bar, new_bar):
     """Check if two bars belong in the same collection (bar chart).
@@ -418,7 +419,7 @@ 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':
+    if ax_type == 'x' and 'DateFormatter' in formatter:
         axis_dict['type'] = 'date'
         try:
             axis_dict['tick0'] = mpl_dates_to_datestrings(axis_dict['tick0'])
@@ -455,13 +456,15 @@ 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"):
+    """Convert matplotlib dates to formatted datestrings for plotly.
+
+    Info on mpl dates: http://matplotlib.org/api/dates_api.html
+
+    """
     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]
+        date_times = matplotlib.dates.num2date(mpl_dates, tz=pytz.utc)
         time_strings = [date_time.strftime(format_string)
                         for date_time in date_times]
         if len(time_strings) > 1:

plotly/plotly/__init__.py

@@ -8,7 +8,19 @@
 
 """
 from . plotly import (
-    sign_in, update_plot_options, get_plot_options, get_credentials, iplot,
-    plot, iplot_mpl, plot_mpl, get_figure, Stream, image, grid_ops,
-    meta_ops, file_ops
+    sign_in,
+    update_plot_options,
+    get_plot_options,
+    get_credentials,
+    iplot,
+    plot,
+    iplot_mpl,
+    plot_mpl,
+    get_figure,
+    Stream,
+    image,
+    grid_ops,
+    meta_ops,
+    file_ops,
+    get_config
 )

plotly/plotly/plotly.py

@@ -45,44 +45,48 @@
 
 _plot_options = dict()
 
+_config = dict()
+
 ### test file permissions and make sure nothing is corrupted ###
 tools.ensure_local_plotly_files()
 
 ### _credentials stuff ###
 
 
-def sign_in(username, api_key):
-    """Set module-scoped _credentials for session. Verify with plotly."""
-    global _credentials
+def sign_in(username, api_key, **kwargs):
+    """Set module-scoped _credentials for session. Optionally, set config info.
+    """
     _credentials['username'], _credentials['api_key'] = username, api_key
     # TODO: verify these _credentials with plotly
 
+    _config['plotly_domain'] = kwargs.get('plotly_domain')
+    _config['plotly_streaming_domain'] = kwargs.get('plotly_streaming_domain')
+    _config['plotly_api_domain'] = kwargs.get('plotly_api_domain')
+    # TODO: verify format of config options
+
 
 ### plot options stuff ###
 
 def update_plot_options(**kwargs):
     """ Update the module-level _plot_options
     """
-    global _plot_options
     _plot_options.update(kwargs)
 
 
 def get_plot_options():
     """ Returns a copy of the user supplied plot options.
     Use `update_plot_options()` to change.
     """
-    global _plot_options
     return copy.copy(_plot_options)
 
 
 def get_credentials():
-    """ Returns a copy of the user supplied credentials.
-    """
-    global _credentials
-    if ('username' in _credentials) and ('api_key' in _credentials):
-        return copy.copy(_credentials)
-    else:
-        return tools.get_credentials_file()
+    """Returns the credentials that will be sent to plotly."""
+    credentials = tools.get_credentials_file()
+    for credentials_key in credentials:
+        if _credentials.get(credentials_key):
+            credentials[credentials_key] = _credentials[credentials_key]
+    return credentials
 
 
 ### plot stuff ###
@@ -128,6 +132,15 @@ def _plot_option_logic(plot_options):
     return options
 
 
+def get_config():
+    """Returns either module config or file config."""
+    config = tools.get_config_file()
+    for config_key in config:
+        if _config.get(config_key):
+            config[config_key] = _config[config_key]
+    return config
+
+
 def plot(figure_or_data, validate=True, **plot_options):
     """Create a unique url for this plot in Plotly and optionally open url.
 
@@ -165,6 +178,12 @@ def plot(figure_or_data, validate=True, **plot_options):
                                          "plot option.\nHere's why you're "
                                          "seeing this error:\n\n{0}"
                                          "".format(err))
+        if not figure['data']:
+            raise exceptions.PlotlyEmptyDataError(
+                "Empty data list found. Make sure that you populated the "
+                "list of data objects you're sending and try again.\n"
+                "Questions? [email protected]"
+            )
     for entry in figure['data']:
         for key, val in list(entry.items()):
             try:
@@ -299,7 +318,7 @@ def get_figure(file_owner_or_url, file_id=None, raw=False):
     `graph objects`.
 
     """
-    plotly_rest_url = tools.get_config_file()['plotly_domain']
+    plotly_rest_url = get_config()['plotly_domain']
     if file_id is None:  # assume we're using a url
         url = file_owner_or_url
         if url[:len(plotly_rest_url)] != plotly_rest_url:
@@ -405,7 +424,7 @@ def open(self):
         http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/s7_streaming/s7_streaming.ipynb
         """
 
-        streaming_url = tools.get_config_file()['plotly_streaming_domain']
+        streaming_url = get_config()['plotly_streaming_domain']
         self._stream = chunked_requests.Stream(streaming_url,
                                                80,
                                                {'Host': streaming_url,
@@ -554,7 +573,7 @@ def get(figure_or_data, format='png', width=None, height=None):
         if height is not None:
             payload['height'] = height
 
-        url = tools.get_config_file()['plotly_domain'] + "/apigenimage/"
+        url = get_config()['plotly_domain'] + "/apigenimage/"
         res = requests.post(url,
                             data=json.dumps(payload,
                                             cls=utils._plotlyJSONEncoder),
@@ -721,7 +740,7 @@ def upload(cls, grid, filename,
 
         grid.id = grid_id
 
-        plotly_domain = tools.get_config_file()['plotly_domain']
+        plotly_domain = get_config()['plotly_domain']
         grid_url = '{}/~{}'.format(plotly_domain, grid_id.replace(':', '/'))
 
         if meta is not None:
@@ -889,7 +908,7 @@ def response_handler(cls, response):
 
     @classmethod
     def api_url(cls, resource):
-        return ('{}/v2/{}'.format(tools.get_config_file()['plotly_api_domain'],
+        return ('{}/v2/{}'.format(get_config()['plotly_api_domain'],
                 resource))
 
     @classmethod
@@ -937,7 +956,7 @@ def _send_to_plotly(figure, **plot_options):
                    origin='plot',
                    kwargs=kwargs)
 
-    url = tools.get_config_file()['plotly_domain'] + "/clientresp"
+    url = get_config()['plotly_domain'] + "/clientresp"
 
     r = requests.post(url, data=payload)
     r.raise_for_status()

plotly/tests/test_core/test_graph_objs/test_to_string.py

@@ -30,3 +30,9 @@ def test_to_string():
     fig_string = fig.to_string(pretty=False)
     comp_string = 'Figure(\n    data=Data([\n        Scatter(\n            x=[1, 2, 3, 4],\n            y=[10, 15, 13, 17]\n        ),\n        Scatter(\n            x=[1, 2, 3, 4],\n            y=[16, 5, 11, 9]\n        )\n    ]),\n    layout=Layout(\n        autosize=False,\n        width=500,\n        height=500,\n        margin=Margin(\n            l=65,\n            r=50,\n            b=65,\n            t=65\n        )\n    )\n)'
     assert fig_string == comp_string
+
+
+def test_nested_list():
+    z = [[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12,
+          13, 14, 15, 16, 17, 18, 19, 20, 21]]
+    print Contour(z=z).to_string()

plotly/tests/test_core/test_plotly/test_credentials.py

@@ -1,3 +1,4 @@
+from unittest import TestCase
 import plotly.plotly.plotly as py
 import plotly.tools as tls
 
@@ -24,4 +25,40 @@ def test_sign_in():
     assert creds['username'] == un
     assert creds['api_key'] == ak
     # TODO, and check it!
-    # assert creds['stream_ids'] == si
+    # assert creds['stream_ids'] == si
+
+
+class TestSignIn(TestCase):
+
+    def test_get_config(self):
+        plotly_domain = 'test ___domain'
+        plotly_streaming_domain = 'test streaming ___domain'
+        config1 = py.get_config()
+        py._config['plotly_domain'] = plotly_domain
+        config2 = py.get_config()
+        py._config['plotly_streaming_domain'] = plotly_streaming_domain
+        config3 = py.get_config()
+        self.assertEqual(config2['plotly_domain'], plotly_domain)
+        self.assertNotEqual(
+            config2['plotly_streaming_domain'], plotly_streaming_domain
+        )
+        self.assertEqual(
+            config3['plotly_streaming_domain'], plotly_streaming_domain
+        )
+
+    def test_sign_in_with_config(self):
+        username = 'place holder'
+        api_key = 'place holder'
+        plotly_domain = 'test ___domain'
+        plotly_streaming_domain = 'test streaming ___domain'
+        py.sign_in(
+            username,
+            api_key,
+            plotly_domain=plotly_domain,
+            plotly_streaming_domain=plotly_streaming_domain
+        )
+        config = py.get_config()
+        self.assertEqual(config['plotly_domain'], plotly_domain)
+        self.assertEqual(
+            config['plotly_streaming_domain'], plotly_streaming_domain
+        )