Merge branch 'master' into etienne-factories

Conflicts:
	plotly/graph_objs/graph_objs_tools.py

Author: etpinard

Diff for: plotly/graph_objs/graph_objs.py

@@ -563,6 +563,7 @@ def to_string(self, level=0, indent=4, eol='\n', pretty=True, max_chars=80):
         obj_key = NAME_TO_KEY[self.__class__.__name__]
         for key in INFO[obj_key]:  # this sets the order of the keys! nice.
             if key in self:
+                index += 1
                 string += "{eol}{indent}{key}=".format(
                     eol=eol,
                     indent=' ' * indent * (level+1),
@@ -574,16 +575,40 @@ def to_string(self, level=0, indent=4, eol='\n', pretty=True, max_chars=80):
                                                   pretty=pretty,
                                                   max_chars=max_chars)
                 except AttributeError:
-                    val = repr(self[key])
-                    val_chars = max_chars - (indent*(level+1)) - (len(key)+1)
-                    if pretty and (len(val) > val_chars):
-                        string += val[:val_chars - 5] + '...' + val[-1]
-                    else:
-                        string += val
-                if index < len(self) - 1:
+                    if pretty:  # curtail representation if too many chars
+                        max_len = (max_chars -
+                                   indent*(level + 1) -
+                                   len(key + "=") -
+                                   len(eol))
+                        if index < len(self):
+                            max_len -= len(',')  # remember the comma!
+                        if isinstance(self[key], list):
+                            s = "[]"
+                            for iii, entry in enumerate(self[key], 1):
+                                if iii < len(self[key]):
+                                    s_sub = graph_objs_tools.curtail_val_repr(
+                                        entry,
+                                        max_chars=max_len - len(s),
+                                        add_delim=True
+                                    )
+                                else:
+                                    s_sub = graph_objs_tools.curtail_val_repr(
+                                        entry,
+                                        max_chars=max_len - len(s),
+                                        add_delim=False
+                                    )
+                                s = s[:-1] + s_sub + s[-1]
+                                if len(s) == max_len:
+                                    break
+                            string += s
+                        else:
+                            string += graph_objs_tools.curtail_val_repr(
+                                self[key], max_len)
+                    else:  # they want it all!
+                        string += repr(self[key])
+                if index < len(self):
                     string += ","
-                index += 1
-                if index == len(self):
+                if index == len(self):  # TODO: extraneous...
                     break
         string += "{eol}{indent})".format(eol=eol, indent=' ' * indent * level)
         return string
@@ -906,16 +931,41 @@ def to_string(self, level=0, indent=4, eol='\n', pretty=True, max_chars=80):
                                                   pretty=pretty,
                                                   max_chars=max_chars)
                 except AttributeError:
-                    val = repr(self[key])
-                    val_chars = max_chars - (indent*(level+1)) - (len(key)+1)
-                    if pretty and (len(val) > val_chars):
-                        string += val[:val_chars - 5] + '...' + val[-1]
-                    else:
-                        string += val
+                    if pretty:  # curtail representation if too many chars
+                        max_len = (max_chars -
+                                   indent*(level + 1) -
+                                   len(key + "=") -
+                                   len(eol))
+                        if index < len(self):
+                            max_len -= len(',')  # remember the comma!
+                        if isinstance(self[key], list):
+                            s = "[]"
+                            for iii, entry in enumerate(self[key], 1):
+                                if iii < len(self[key]):
+                                    s_sub = graph_objs_tools.curtail_val_repr(
+                                        entry,
+                                        max_chars=max_len - len(s),
+                                        add_delim=True
+                                    )
+                                else:
+                                    s_sub = graph_objs_tools.curtail_val_repr(
+                                        entry,
+                                        max_chars=max_len - len(s),
+                                        add_delim=False
+                                    )
+                                s = s[:-1] + s_sub + s[-1]
+                                if len(s) == max_len:
+                                    break
+                            string += s
+                        else:
+                            string += graph_objs_tools.curtail_val_repr(
+                                self[key], max_len)
+                    else:  # they want it all!
+                        string += repr(self[key])
                 if index < len(self) - 1:
                     string += ","
                 index += 1
-                if index == len(self):
+                if index == len(self):  # TODO: extraneous...
                     break
         left_over_keys = [key for key in self if key not in INFO[obj_key]]
         left_over_keys.sort()

Diff for: plotly/graph_objs/graph_objs_tools.py

@@ -8,6 +8,7 @@
 else:
     from collections import OrderedDict
     import json
+import six
 
 
 from pkg_resources import resource_string
@@ -215,3 +216,32 @@ def make_dict_doc(name):
                 doc += code
             doc += '\n'
     return doc.expandtabs(tab_size)
+
+
+def curtail_val_repr(val, max_chars, add_delim=False):
+    delim = ", "
+    end = ".."
+    if isinstance(val, six.string_types):
+        if max_chars <= len("'" + end + "'"):
+            return ' ' * max_chars
+        elif add_delim and max_chars <= len("'" + end + "'") + len(delim):
+            return "'" + end + "'" + ' ' * (max_chars - len("'" + end + "'"))
+    else:
+        if max_chars <= len(end):
+            return ' ' * max_chars
+        elif add_delim and max_chars <= len(end) + len(delim):
+            return end + ' ' * (max_chars - len(end))
+    if add_delim:
+        max_chars -= len(delim)
+    r = repr(val)
+    if len(r) > max_chars:
+        if isinstance(val, six.string_types):
+            # 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)):
+            r = r[:max_chars - len(end + ']')] + end + ']'
+        else:
+            r = r[:max_chars - len(end)] + end
+    if add_delim:
+        r += delim
+    return r

Diff for: plotly/tests/test_optional/test_ipython/__init__.py

@@ -0,0 +1,62 @@
+from __future__ import absolute_import
+
+import plotly.tools as tls
+import imghdr
+import threading
+import six
+import unittest
+version = six.sys.version_info[:2]  # need this for conditional testing
+
+# unittest `skipIf` not supported in 2.6 and IPython not supported in 2.6/3.2
+if version < (2, 7) or (2, 7) < version < (3, 3):
+    pass
+else:
+
+    class TestPlotlyDisplay(unittest.TestCase):
+
+        def setUp(self):
+            plot_info = {"un": "plotlyimagetest", "fid": "2"}
+            url = "https://plot.ly/~{un}/{fid}".format(**plot_info)
+            self.display_obj = tls.embed(url)
+            self.results = {}
+            self.images = {}
+            self.threads = []
+            self.format_to_func = {
+                "jpeg": self.jpeg_worker,
+                "png": self.png_worker,
+                "svg": self.svg_worker,
+                "pdf": self.pdf_worker}
+
+        def test_plotly_display(self):
+            for f_format, func in self.format_to_func.items():
+                self.threads += [threading.Thread(target=func)]
+                self.threads[-1].setDaemon(True)
+                self.threads[-1].start()
+            for thread in self.threads:
+                thread.join()
+            for f_format in self.format_to_func:
+                result = self.results.get(f_format, False)
+                print("{f_format}: {result}".format(f_format=f_format,
+                                                    result=result))
+                print("{image}\n".format(image=self.images[f_format][:72]))
+                assert self.results.get(f_format)
+
+        def jpeg_worker(self):
+            self.images['jpeg'] = self.display_obj._repr_jpeg_()
+            if imghdr.what('', self.images['jpeg']) == "jpeg":
+                self.results["jpeg"] = True
+
+        def png_worker(self):
+            self.images['png'] = self.display_obj._repr_png_()
+            if imghdr.what('', self.images['png']) == "png":
+                self.results["png"] = True
+
+        def svg_worker(self):
+            self.images['svg'] = self.display_obj._repr_svg_()
+            if self.images['svg'][:4] == six.b('<svg'):
+                self.results["svg"] = True
+
+        def pdf_worker(self):
+            self.images['pdf'] = self.display_obj._repr_pdf_()
+            if self.images['pdf'][:4] == six.b('%PDF'):
+                self.results["pdf"] = True

Diff for: plotly/tests/test_optional/test_ipython/test_embed.py

@@ -13,6 +13,7 @@
 import os.path
 import warnings
 import six
+import requests
 
 from plotly import utils
 from plotly import exceptions
@@ -30,6 +31,12 @@ def warning_on_one_line(message, category, filename, lineno, file=None, line=Non
 except ImportError:
     _matplotlylib_imported = False
 
+try:
+    import IPython
+    _ipython_imported = True
+except ImportError:
+    _ipython_imported = False
+
 PLOTLY_DIR = os.path.join(os.path.expanduser("~"), ".plotly")
 CREDENTIALS_FILE = os.path.join(PLOTLY_DIR, ".credentials")
 CONFIG_FILE = os.path.join(PLOTLY_DIR, ".config")
@@ -283,11 +290,21 @@ def embed(file_owner_or_url, file_id=None, width="100%", height=525):
         return html(s, hide=False)
     except:
         pass
-    try:
-        from IPython.display import HTML, display
-        display(HTML(s))
-    except:
-        pass
+    if _ipython_imported:
+        if file_id:
+            url = "{plotly_domain}/~{un}/{fid}".format(
+                plotly_domain=get_config_file()['plotly_domain'],
+                un=file_owner_or_url,
+                fid=file_id)
+        else:
+            url = file_owner_or_url
+        return PlotlyDisplay(url)
+    else:
+        warnings.warn(
+            "Looks like you're not using IPython or Sage to embed this plot. "
+            "If you just want the *embed code*, try using `get_embed()` "
+            "instead."
+            "\nQuestions? [email protected]")
 
 
 ### mpl-related tools ###
@@ -532,3 +549,40 @@ def _replace_newline(obj):
         return s
     else:
         return obj  # we return the actual reference... but DON'T mutate.
+
+
+if _ipython_imported:
+    class PlotlyDisplay(IPython.core.display.HTML):
+        """An IPython display object for use with plotly urls
+
+        PlotlyDisplay objects should be instantiated with a url for a plot.
+        IPython will *choose* the proper display representation from any
+        Python object, and using provided methods if they exist. By defining
+        the following, if an HTML display is unusable, the PlotlyDisplay
+        object can provide alternate representations.
+
+        """
+        def __init__(self, url):
+            self.resource = url
+            self.embed_code = get_embed(url)
+            super(PlotlyDisplay, self).__init__(data=self.embed_code)
+
+        def _repr_svg_(self):
+            url = self.resource + ".svg"
+            res = requests.get(url)
+            return res.content
+
+        def _repr_png_(self):
+            url = self.resource + ".png"
+            res = requests.get(url)
+            return res.content
+
+        def _repr_pdf_(self):
+            url = self.resource + ".pdf"
+            res = requests.get(url)
+            return res.content
+
+        def _repr_jpeg_(self):
+            url = self.resource + ".jpeg"
+            res = requests.get(url)
+            return res.content

Diff for: plotly/tools.py

@@ -1 +1 @@
-__version__ = '1.2.6'
+__version__ = '1.2.7'