add scale and the associated tests

Author: chriddyp

plotly/plotly/plotly.py

@@ -545,7 +545,7 @@ class image:
 
     """
     @staticmethod
-    def get(figure_or_data, format='png', width=None, height=None):
+    def get(figure_or_data, format='png', width=None, height=None, scale=None):
         """
         Return a static image of the plot described by `figure`.
 
@@ -570,6 +570,13 @@ def get(figure_or_data, format='png', width=None, height=None):
                 "supported file types here: "
                 "https://plot.ly/python/static-image-export/"
             )
+        if scale is not None:
+            try:
+                scale = float(scale)
+            except:
+                raise exceptions.PlotlyError(
+                    "Invalid scale parameter. Scale must be a number."
+                )
 
         headers = _api_v2.headers()
         headers['plotly_version'] = version.__version__
@@ -580,7 +587,8 @@ def get(figure_or_data, format='png', width=None, height=None):
             payload['width'] = width
         if height is not None:
             payload['height'] = height
-
+        if scale is not None:
+            payload['scale'] = scale
         url = _api_v2.api_url('images/')
 
         res = requests.post(
@@ -614,21 +622,22 @@ def get(figure_or_data, format='png', width=None, height=None):
                                              "not be translated.")
             raise exceptions.PlotlyError(return_data['error'])
 
-
     @classmethod
-    def ishow(cls, figure_or_data, format='png', width=None, height=None):
+    def ishow(cls, figure_or_data, format='png', width=None, height=None,
+              scale=None):
         """
         Display a static image of the plot described by `figure`
         in an IPython Notebook.
 
         """
         if format == 'pdf':
-            raise exceptions.PlotlyError("Aw, snap! "
+            raise exceptions.PlotlyError(
+                "Aw, snap! "
                 "It's not currently possible to embed a pdf into "
                 "an IPython notebook. You can save the pdf "
                 "with the `image.save_as` or you can "
                 "embed an png, jpeg, or svg.")
-        img = cls.get(figure_or_data, format, width, height)
+        img = cls.get(figure_or_data, format, width, height, scale)
         from IPython.display import display, Image, SVG
         if format == 'svg':
             display(SVG(img))
@@ -637,7 +646,7 @@ def ishow(cls, figure_or_data, format='png', width=None, height=None):
 
     @classmethod
     def save_as(cls, figure_or_data, filename, format=None, width=None,
-                height=None):
+                height=None, scale=None):
         """
         Save a image of the plot described by `figure` locally as `filename`.
 
@@ -655,7 +664,7 @@ def save_as(cls, figure_or_data, filename, format=None, width=None,
         elif not ext and format:
             filename += '.' + format
 
-        img = cls.get(figure_or_data, format, width, height)
+        img = cls.get(figure_or_data, format, width, height, scale)
 
         f = open(filename, 'wb')
         f.write(img)

plotly/tests/test_core/test_image/__init__.py

@@ -19,21 +19,21 @@ def setUp(self):
 
 
 def _generate_image_get_returns_valid_image_test(image_format,
-                                                 width, height):
+                                                 width, height, scale):
     def test(self):
-        image = py.image.get(self.data, image_format, width, height)
+        image = py.image.get(self.data, image_format, width, height, scale)
         if image_format in ['png', 'jpeg']:
             assert imghdr.what('', image) == image_format
 
     return test
 
 
 def _generate_image_save_as_saves_valid_image(image_format,
-                                              width, height):
+                                              width, height, scale):
     def _test(self):
         f, filename = tempfile.mkstemp('.{}'.format(image_format))
         py.image.save_as(self.data, filename, format=image_format,
-                         width=width, height=height)
+                         width=width, height=height, scale=scale)
         if image_format in ['png', 'jpeg']:
             assert imghdr.what(filename) == image_format
         else:
@@ -46,7 +46,8 @@ def _test(self):
 kwargs = {
     'format': ['png', 'jpeg', 'pdf', 'svg'],
     'width': [None, 300],
-    'height': [None, 300]
+    'height': [None, 300],
+    'scale': [None, 5]
 }
 
 for args in itertools.product(kwargs['format'], kwargs['width'],