Improved warning messages

etpinard · etpinard · commit ecfd7a680f37 · 2014-07-04T17:41:06.000-04:00
- for newline character convertions
- out-of-bounds annotations
- warnings have now a custom format
diff --git a/plotly/matplotlylib/renderer.py b/plotly/matplotlylib/renderer.py
@@ -11,6 +11,10 @@
 from . import mpltools
 from .. graph_objs import *
 
+# Warning format
+def warning_on_one_line(message, category, filename, lineno, file=None, line=None):
+    return ' %s:%s: %s:\n%s\n' % (filename, lineno, category.__name__, message)
+warnings.formatwarning = warning_on_one_line
 
 class PlotlyRenderer(Renderer):
     """A renderer class inheriting from base for rendering mpl plots in plotly.
@@ -499,11 +503,14 @@ def draw_text(self, **props):
         """
         self.msg += "    Attempting to draw an mpl text object\n"
         if not mpltools.check_corners(props['mplobj'], self.mpl_fig):
-            warnings.warn("\n"
-                          "The annotation you're trying to draw lies outside "
-                          "the given figure size. Therefore, the resulting "
-                          "Plotly figure may not be large enough to view the "
-                          "full text.")
+            warnings.warn("Looks like the annotation(s) you are trying " 
+                          "to draw lies/lay outside the given figure size.\n"
+                          "Therefore, the resulting Plotly figure may not be "
+                          "large enough to view the full text.\n"
+                          "To adjust the size of the figure, use the "
+                          "'width' and 'height' keys in the Layout object. "
+                          "Alternatively, use the Margin object to adjust the "
+                          "figure's margins.")
         align = props['mplobj']._multialignment
         if not align:
             align = props['style']['halign'] # mpl default
diff --git a/plotly/tools.py b/plotly/tools.py
@@ -14,6 +14,11 @@
 from . import utils
 from . import exceptions
 
+# Warning format
+def warning_on_one_line(message, category, filename, lineno, file=None, line=None):
+    return ' %s:%s: %s:\n%s\n' % (filename, lineno, category.__name__, message)
+warnings.formatwarning = warning_on_one_line
+
 try:
     from . import matplotlylib
     _matplotlylib_imported = True
@@ -530,7 +535,8 @@ def _replace_newline(obj):
                           "Plotly uses a subset of HTML escape characters "
                           "to do things like newline, bold, italics, etc.\n"
                           "Your newline characters have been converted to "
-                          "'<br>' so they'll show up right!")
+                          "'<br>' so they will show up right on your Plotly "
+                          "figure!")
         return s
     else:
         return obj  # we return the actual reference... but DON'T mutate.
