remove extra spaces, better title handling

Author: nschloe

matplotlib2tikz/axes.py

@@ -36,6 +36,7 @@ def __init__(self, data, obj):
 
         # get plot title
         title = obj.get_title()
+        data["current axis title"] = title
         if title:
             self.axis_options.append("title={{{}}}".format(title))
 

matplotlib2tikz/save.py

@@ -18,7 +18,7 @@
 from . import quadmesh as qmsh
 from . import path
 from . import patch
-from . import text as mytext
+from . import text
 
 from .__about__ import __version__
 
@@ -223,7 +223,6 @@ def get_tikz_code(
 \\usepackage[utf8]{{inputenc}}
 \\usepackage{{pgfplots}}
 \\usepgfplotslibrary{{groupplots}}
-\\usetikzlibrary{{shapes.arrows}}
 \\pgfplotsset{{compat=newest}}
 \\begin{{document}}
 {}
@@ -277,7 +276,7 @@ def _print_pgfplot_libs_message(data):
     pgfplotslibs = ",".join(list(data["pgfplots libs"]))
     tikzlibs = ",".join(list(data["tikz libs"]))
 
-    print("=========================================================")
+    print(70 * "=")
     print("Please add the following lines to your LaTeX preamble:\n")
     print("\\usepackage[utf8]{inputenc}")
     print("\\usepackage{fontspec}  % This line only for XeLaTeX and LuaLaTeX")
@@ -286,7 +285,7 @@ def _print_pgfplot_libs_message(data):
         print("\\usetikzlibrary{" + tikzlibs + "}")
     if pgfplotslibs:
         print("\\usepgfplotslibrary{" + pgfplotslibs + "}")
-    print("=========================================================")
+    print(70 * "=")
     return
 
 
@@ -360,9 +359,6 @@ def _recurse(data, obj):
         elif isinstance(child, mpl.image.AxesImage):
             data, cont = img.draw_image(data, child)
             content.extend(cont, child.get_zorder())
-            # # Really necessary?
-            # data, children_content = _recurse(data, child)
-            # content.extend(children_content)
         elif isinstance(child, mpl.patches.Patch):
             data, cont = patch.draw_patch(data, child)
             content.extend(cont, child.get_zorder())
@@ -384,19 +380,15 @@ def _recurse(data, obj):
             data = legend.draw_legend(data, child)
             if data["legend colors"]:
                 content.extend(data["legend colors"], 0)
-        elif isinstance(
-            child, (mpl.axis.XAxis, mpl.axis.YAxis, mpl.spines.Spine, mpl.text.Text)
-        ):
+        elif isinstance(child, (mpl.text.Text, mpl.text.Annotation)):
+            data, cont = text.draw_text(data, child)
+            content.extend(cont, child.get_zorder())
+        elif isinstance(child, (mpl.axis.XAxis, mpl.axis.YAxis, mpl.spines.Spine)):
             pass
         else:
             warnings.warn(
                 "matplotlib2tikz: Don't know how to handle object {}.".format(
                     type(child)
                 )
             )
-    # XXX: This is ugly
-    if isinstance(obj, (mpl.axes.Subplot, mpl.figure.Figure)):
-        for text in obj.texts:
-            data, cont = mytext.draw_text(data, text)
-            content.extend(cont, text.get_zorder())
     return data, content.flatten()

matplotlib2tikz/text.py

@@ -21,6 +21,12 @@ def draw_text(data, obj):
     #                   -------1--------2---3--4--
     pos = obj.get_position()
     text = obj.get_text()
+
+    if text in ["", data["current axis title"]]:
+        # Text nodes which are direct children of Axes are typically titles.  They are
+        # already captured by the `title` property of pgfplots axes, so skip them here.
+        return data, content
+
     size = obj.get_size()
     bbox = obj.get_bbox_patch()
     converter = mpl.colors.ColorConverter()
@@ -109,8 +115,8 @@ def draw_text(data, obj):
         text = text.replace("\n ", "\\\\")
 
     content.append(
-        "\\node at {}[\n  {}\n]{{{} {}}};\n".format(
-            tikz_pos, ",\n  ".join(properties), " ".join(style), text
+        "\\node at {}[\n  {}\n]{{{}}};\n".format(
+            tikz_pos, ",\n  ".join(properties), " ".join(style + [text])
         )
     )
     return data, content

test/helpers.py

@@ -89,7 +89,7 @@ def compare_mpl_latex(plot):
 
     # Convert PDF to PNG.
     subprocess.check_output(
-        ["pdftoppm", "-png", pdf_file, "test"], stderr=subprocess.STDOUT
+        ["pdftoppm", "-r", "1000", "-png", pdf_file, "test"], stderr=subprocess.STDOUT
     )
     png_path = os.path.join(pdf_dirname, "test-1.png")
 

test/test_annotate.py

@@ -34,3 +34,9 @@ def plot():
 def test():
     assert_equality(plot, "test_annotate_reference.tex")
     return
+
+
+if __name__ == "__main__":
+    import helpers
+    # helpers.compare_mpl_latex(plot)
+    helpers.print_tree(plot())

test/test_annotate_reference.tex

@@ -42,13 +42,13 @@
   anchor=base west,
   text=black,
   rotate=0.0
-]{ text};
+]{text};
 \node at (axis cs:-50,30)[
   scale=0.5,
   anchor=base west,
   text=black,
   rotate=0.0
-]{ arrowstyle};
+]{arrowstyle};
 \end{axis}
 
 \end{tikzpicture}

test/test_arrows_reference.tex

@@ -34,7 +34,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ -};
+]{-};
 \draw[->,black] (axis cs:2,5.8) -- (axis cs:3.2,5.8);
 \node at (axis cs:2,5.8)[
   scale=0.7,
@@ -45,7 +45,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ -$>$};
+]{-$>$};
 \draw[-|,black] (axis cs:2,4.8) -- (axis cs:3.2,4.8);
 \node at (axis cs:2,4.8)[
   scale=0.7,
@@ -56,7 +56,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ -[};
+]{-[};
 \draw[-latex,black] (axis cs:2,3.8) -- (axis cs:3.2,3.8);
 \node at (axis cs:2,3.8)[
   scale=0.7,
@@ -67,7 +67,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ -$|$$>$};
+]{-$|$$>$};
 \draw[<-,black] (axis cs:2,2.8) -- (axis cs:3.2,2.8);
 \node at (axis cs:2,2.8)[
   scale=0.7,
@@ -78,7 +78,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ $<$-};
+]{$<$-};
 \draw[<->,black] (axis cs:2,1.8) -- (axis cs:3.2,1.8);
 \node at (axis cs:2,1.8)[
   scale=0.7,
@@ -89,7 +89,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ $<$-$>$};
+]{$<$-$>$};
 \draw[latex-,black] (axis cs:2,0.8) -- (axis cs:3.2,0.8);
 \node at (axis cs:2,0.8)[
   scale=0.7,
@@ -100,7 +100,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ $<$$|$-};
+]{$<$$|$-};
 \draw[latex-latex,black] (axis cs:6,6.8) -- (axis cs:7.2,6.8);
 \node at (axis cs:6,6.8)[
   scale=0.7,
@@ -111,7 +111,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ $<$$|$-$|$$>$};
+]{$<$$|$-$|$$>$};
 \draw[|-,black] (axis cs:6,5.8) -- (axis cs:7.2,5.8);
 \node at (axis cs:6,5.8)[
   scale=0.7,
@@ -122,7 +122,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ ]-};
+]{]-};
 \draw[|-|,black] (axis cs:6,4.8) -- (axis cs:7.2,4.8);
 \node at (axis cs:6,4.8)[
   scale=0.7,
@@ -133,7 +133,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ ]-[};
+]{]-[};
 \draw[-latex,very thick,black] (axis cs:6,3.8) -- (axis cs:7.2,3.8);
 \node at (axis cs:6,3.8)[
   scale=0.7,
@@ -144,7 +144,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ fancy};
+]{fancy};
 \draw[-latex,very thick,black] (axis cs:6,2.8) -- (axis cs:7.2,2.8);
 \node at (axis cs:6,2.8)[
   scale=0.7,
@@ -155,7 +155,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ simple};
+]{simple};
 \draw[-latex,very thick,black] (axis cs:6,1.8) -- (axis cs:7.2,1.8);
 \node at (axis cs:6,1.8)[
   scale=0.7,
@@ -166,7 +166,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ wedge};
+]{wedge};
 \draw[|-|,black] (axis cs:6,0.8) -- (axis cs:7.2,0.8);
 \node at (axis cs:6,0.8)[
   scale=0.7,
@@ -177,7 +177,7 @@
   anchor= east,
   text=black,
   rotate=0.0
-]{ $|$-$|$};
+]{$|$-$|$};
 \end{axis}
 
 \end{tikzpicture}

test/test_basic_sin.py

@@ -26,3 +26,9 @@ def plot():
 def test():
     assert_equality(plot, "test_basic_sin_reference.tex")
     return
+
+
+if __name__ == "__main__":
+    import helpers
+    # helpers.compare_mpl_latex(plot)
+    helpers.print_tree(plot())

test/test_fancybox.py

@@ -39,7 +39,7 @@ def box1(ax):
 
     ax.add_patch(p_fancy)
 
-    ax.text(0.1, 0.8, " boxstyle='round, pad=0.1'", size=10, transform=ax.transAxes)
+    ax.text(0.1, 0.8, "boxstyle='round, pad=0.1'", size=10, transform=ax.transAxes)
 
     # # draws control points for the fancy box.
     # l = p_fancy.get_path().vertices
@@ -204,5 +204,6 @@ def test():
 
 
 if __name__ == "__main__":
-    from helpers import compare_mpl_latex
-    compare_mpl_latex(plot)
+    import helpers
+    # helpers.compare_mpl_latex(plot)
+    helpers.print_tree(plot())

test/test_fancybox_reference.tex

@@ -29,7 +29,7 @@
   anchor=base west,
   text=black,
   rotate=0.0
-]{  boxstyle='round, pad=0.1'};
+]{boxstyle='round, pad=0.1'};
 \path [draw=black, fill opacity=0] (axis cs:0.3,0.4)
 --(axis cs:0.7,0.4)
 --(axis cs:0.7,0.6)
@@ -62,7 +62,7 @@
   text=black,
   rotate=0.0,
   align=left
-]{ boxstyle='round,pad=0.1\\rounding\_size=0.2'};
+]{boxstyle='round,pad=0.1\\rounding\_size=0.2'};
 \path [draw=black, fill opacity=0] (axis cs:0.3,0.4)
 --(axis cs:0.7,0.4)
 --(axis cs:0.7,0.6)
@@ -95,7 +95,7 @@
   text=black,
   rotate=0.0,
   align=left
-]{ boxstyle='round,pad=0.1'\\mutation\_scale=2};
+]{boxstyle='round,pad=0.1'\\mutation\_scale=2};
 \path [draw=black, fill opacity=0] (axis cs:0.3,0.4)
 --(axis cs:0.7,0.4)
 --(axis cs:0.7,0.6)
@@ -128,7 +128,7 @@
   text=black,
   rotate=0.0,
   align=left
-]{ boxstyle='round, pad=0.3'\\mutation\_aspect=.5};
+]{boxstyle='round, pad=0.3'\\mutation\_aspect=.5};
 \path [draw=green!50.0!black, fill opacity=0] (axis cs:0.3,0.2)
 --(axis cs:0.7,0.2)
 .. controls (axis cs:0.833333333333333,0.2) and (axis cs:0.9,0.266666666666667) .. (axis cs:0.9,0.4)