Merge pull request #293 from nschloe/table_row_sep

Table row sep

Author: nschloe

matplotlib2tikz/__about__.py

@@ -4,5 +4,5 @@
 __email__ = "[email protected]"
 __copyright__ = u"Copyright (c) 2010-2019, {} <{}>".format(__author__, __email__)
 __license__ = "License :: OSI Approved :: MIT License"
-__version__ = "0.7.3"
+__version__ = "0.7.4"
 __status__ = "Development Status :: 5 - Production/Stable"

matplotlib2tikz/line2d.py

@@ -21,9 +21,9 @@ def draw_line2d(data, obj):
     content = []
     addplot_options = []
 
-    # If line is of length 0, do nothing.  Otherwise, an empty \addplot table
-    # will be created, which will be interpreted as an external data source
-    # in either the file '' or '.tex'.  Instead, render nothing.
+    # If line is of length 0, do nothing.  Otherwise, an empty \addplot table will be
+    # created, which will be interpreted as an external data source in either the file
+    # '' or '.tex'.  Instead, render nothing.
     if len(obj.get_xdata()) == 0:
         return data, []
 
@@ -291,7 +291,10 @@ def _table(obj, data):
         xdata = [date.strftime("%Y-%m-%d %H:%M") for date in xdata]
         xformat = "{}"
         col_sep = ","
-        content.append("table [header=false,col sep=comma] {%\n")
+        opts = ["header=false", "col sep=comma"]
+        if data["table_row_sep"] != "\n":
+            opts.append("row sep=" + data["table row sep"])
+        content.append("table [{}] {{%\n".format(",".join(opts)))
         data["current axes"].axis_options.append("date coordinates in=x")
         # Replace float xmin/xmax by datetime
         # <https://github.com/matplotlib/matplotlib/issues/13727>.
@@ -321,12 +324,18 @@ def _table(obj, data):
 
         for (x, y, is_masked) in zip(xdata, ydata, ydata_mask):
             if is_masked:
-                plot_table.append((xformat + col_sep + "nan\n").format(x))
+                plot_table.append(
+                    (xformat + col_sep + "nan" + data["table_row_sep"]).format(x)
+                )
             else:
-                plot_table.append((xformat + col_sep + ff + "\n").format(x, y))
+                plot_table.append(
+                    (xformat + col_sep + ff + data["table_row_sep"]).format(x, y)
+                )
     else:
         for x, y in zip(xdata, ydata):
-            plot_table.append((xformat + col_sep + ff + "\n").format(x, y))
+            plot_table.append(
+                (xformat + col_sep + ff + data["table_row_sep"]).format(x, y)
+            )
 
     if data["externalize tables"]:
         filename, rel_filepath = files.new_filename(data, "table", ".tsv")

matplotlib2tikz/save.py

@@ -42,6 +42,7 @@ def get_tikz_code(
     include_disclaimer=True,
     standalone=False,
     float_format="{:.15g}",
+    table_row_sep="\n",
 ):
     """Main function. Here, the recursion into the image starts and the
     contents are picked up. The actual file gets written in this routine.
@@ -112,7 +113,7 @@ def get_tikz_code(
     :type extra_axis_parameters: a list or set of strings for the pfgplots axes.
 
     :param extra_tikzpicture_parameters: Extra tikzpicture options to be passed
-                                        (as a set) to pgfplots.
+                                         (as a set) to pgfplots.
 
     :type extra_tikzpicture_parameters: a set of strings for the pfgplots
                                         tikzpicture.
@@ -122,8 +123,24 @@ def get_tikz_code(
                 ``savefig.dpi`` from matplotlib.rcParams. Default is ``None``.
     :type dpi: int
 
-    :returns: None
+    :param show_info: Show extra info on the command line. Default is ``False``.
+    :type show_info: bool
+
+    :param include_disclaimer: Include matplotlib2tikz disclaimer in the output.
+                               Set ``False`` to make tests reproducible.
+                               Default is ``True``.
+    :type include_disclaimer: bool
+
+    :param standalone: Include wrapper code for a standalone LaTeX file.
+    :type standalone: bool
 
+    :param float_format: Format for float entities. Default is ```"{:.15g}"```.
+    :type float_format: str
+
+    :param table_row_sep: Row separator for table data. Default is ```"\\n"```.
+    :type table_row_sep: str
+
+    :returns: None
 
     The following optional attributes of matplotlib's objects are recognized
     and handled:
@@ -179,6 +196,7 @@ def get_tikz_code(
         )
 
     data["float format"] = float_format
+    data["table_row_sep"] = table_row_sep
 
     # print message about necessary pgfplot libs to command line
     if show_info:

test/helpers.py

@@ -33,17 +33,21 @@ def _unidiff_output(expected, actual):
     return "".join(diff)
 
 
-def assert_equality(plot, filename):
+def assert_equality(plot, filename, **extra_get_tikz_code_args):
     plot()
-    code = matplotlib2tikz.get_tikz_code(include_disclaimer=False)
+    code = matplotlib2tikz.get_tikz_code(
+        include_disclaimer=False, **extra_get_tikz_code_args
+    )
     plt.close()
 
     this_dir = os.path.dirname(os.path.abspath(__file__))
     with open(os.path.join(this_dir, filename), "r", encoding="utf-8") as f:
         reference = f.read()
     assert reference == code, _unidiff_output(reference, code)
 
-    code = matplotlib2tikz.get_tikz_code(include_disclaimer=False, standalone=True)
+    code = matplotlib2tikz.get_tikz_code(
+        include_disclaimer=False, standalone=True, **extra_get_tikz_code_args
+    )
     assert _compile(code) is not None
     return
 

test/test_basic_sin.py

@@ -25,7 +25,7 @@ def plot():
 
 
 def test():
-    assert_equality(plot, "test_basic_sin_reference.tex")
+    assert_equality(plot, "test_basic_sin_reference.tex", table_row_sep="\\\\\n")
     return
 
 

test/test_basic_sin_reference.tex

@@ -24,50 +24,50 @@
 ]
 \addplot [semithick, color0, mark=*, mark size=3, mark options={solid}]
 table {%
-0 0
-0.1 0.587785252292473
-0.2 0.951056516295154
-0.3 0.951056516295154
-0.4 0.587785252292473
-0.5 1.22464679914735e-16
-0.6 -0.587785252292473
-0.7 -0.951056516295154
-0.8 -0.951056516295154
-0.9 -0.587785252292473
-1 -2.44929359829471e-16
-1.1 0.587785252292474
-1.2 0.951056516295154
-1.3 0.951056516295154
-1.4 0.587785252292473
-1.5 3.67394039744206e-16
-1.6 -0.587785252292473
-1.7 -0.951056516295154
-1.8 -0.951056516295154
-1.9 -0.587785252292473
+0 0\\
+0.1 0.587785252292473\\
+0.2 0.951056516295154\\
+0.3 0.951056516295154\\
+0.4 0.587785252292473\\
+0.5 1.22464679914735e-16\\
+0.6 -0.587785252292473\\
+0.7 -0.951056516295154\\
+0.8 -0.951056516295154\\
+0.9 -0.587785252292473\\
+1 -2.44929359829471e-16\\
+1.1 0.587785252292474\\
+1.2 0.951056516295154\\
+1.3 0.951056516295154\\
+1.4 0.587785252292473\\
+1.5 3.67394039744206e-16\\
+1.6 -0.587785252292473\\
+1.7 -0.951056516295154\\
+1.8 -0.951056516295154\\
+1.9 -0.587785252292473\\
 };
 \addlegendentry{sin}
 \addplot [very thick, color1, opacity=0.3, mark=*, mark size=3, mark options={solid}]
 table {%
-0 1
-0.1 0.809016994374947
-0.2 0.309016994374947
-0.3 -0.309016994374948
-0.4 -0.809016994374947
-0.5 -1
-0.6 -0.809016994374947
-0.7 -0.309016994374948
-0.8 0.309016994374947
-0.9 0.809016994374947
-1 1
-1.1 0.809016994374947
-1.2 0.309016994374947
-1.3 -0.309016994374947
-1.4 -0.809016994374947
-1.5 -1
-1.6 -0.809016994374948
-1.7 -0.309016994374946
-1.8 0.309016994374947
-1.9 0.809016994374947
+0 1\\
+0.1 0.809016994374947\\
+0.2 0.309016994374947\\
+0.3 -0.309016994374948\\
+0.4 -0.809016994374947\\
+0.5 -1\\
+0.6 -0.809016994374947\\
+0.7 -0.309016994374948\\
+0.8 0.309016994374947\\
+0.9 0.809016994374947\\
+1 1\\
+1.1 0.809016994374947\\
+1.2 0.309016994374947\\
+1.3 -0.309016994374947\\
+1.4 -0.809016994374947\\
+1.5 -1\\
+1.6 -0.809016994374948\\
+1.7 -0.309016994374946\\
+1.8 0.309016994374947\\
+1.9 0.809016994374947\\
 };
 \addlegendentry{cos}
 \end{axis}