Merge pull request nschloe#273 from nschloe/new-tests

New tests

Author: nschloe

.circleci/config.yml

@@ -11,21 +11,13 @@ jobs:
       - run: apt update
       # <https://stackoverflow.com/a/44333806/353337>
       - run: DEBIAN_FRONTEND=noninteractive apt install tzdata
-      - run: apt install -y texlive-latex-base texlive-latex-extra python3-pip python3-tk wget poppler-utils
+      - run: apt install -y texlive-latex-base texlive-latex-extra python3-pip python3-tk
       - run: pip3 install -U pytest pytest-cov excode black flake8
       - checkout
       - run: cd ~/work
       - run: excode README.md test/zzz_readme_test.py --filter python,test
-      # install latest pgfplots
-      - run: mkdir -p $TEXMFLOCAL
-      - run: wget http://mirrors.ctan.org/install/graphics/pgf/contrib/pgfplots.tds.zip -O /tmp/pgfplots.zip
-      - run: unzip /tmp/pgfplots.zip -d $TEXMFLOCAL
-      - run: texhash
-      # install
-      - run: pip3 install -r test_requirements.txt
       # Install very specific versions of the dependencies; the build is too
       # fragile otherwise.
-      - run: pip3 install matplotlib==2.1.0
       - run: pip3 install .[all]
       - run: pip3 check
       # format and lint

README.md

@@ -172,37 +172,15 @@ please visit
 ### Testing
 
 matplotlib2tikz has automatic unit testing to make sure that the software
-doesn't accidentally get worse over time. In `test/testfunctions/`, a number of
-test cases are specified. Those
-
- * run through matplotlib2tikz,
- * the resulting LaTeX file is compiled into a PDF (`pdflatex`),
- * the PDF is converted into a PNG (`pdftoppm`),
- * a perceptual hash is computed from the PNG and compared to a previously
-   stored version.
+doesn't accidentally get worse over time. In `test/`, a number of
+test cases are specified. Those run through matplotlib2tikz and compare the output with
+a previously stored reference TeX file.
 
 To run the tests, just check out this repository and type
 ```
 pytest
 ```
 
-The final pHash may depend on any of the tools used during the process. For
-example, if your version of [Pillow](https://pypi.org/project/Pillow/)
-is too old, the pHash function might operate slightly differently and produce a
-slightly different pHash, resulting in a failing test. If tests are failing on
-your local machine, you should first make sure to have an up-to-date Pillow.
-
-If you would like to contribute a test, just take a look at the examples in
-`test/testfunctions/`. Essentially a test consists of three things:
-
-  * a description,
-  * a pHash, and
-  * a function that creates the image in matplotlib.
-
-Just add your file, add it to `test/testfunction/__init__.py`, and run the
-tests. A failing test will always print out the pHash, so you can leave it
-empty in the first run and fill it in later to make the test pass.
-
 ### Distribution
 
 To create a new release

matplotlib2tikz/files.py

@@ -5,7 +5,7 @@
 
 
 def _gen_filename(data, nb_key, ext):
-    name = data["base name"] + "-%03d%s" % (data[nb_key], ext)
+    name = data["base name"] + "-{:03d}{}".format(data[nb_key], ext)
     return os.path.join(data["output dir"], name), name
 
 

matplotlib2tikz/save.py

@@ -4,6 +4,7 @@
 
 import codecs
 import os
+import tempfile
 import warnings
 
 import matplotlib as mpl
@@ -23,8 +24,8 @@
 
 
 def get_tikz_code(
-    filepath,
     figure="gcf",
+    filepath=None,
     figurewidth=None,
     figureheight=None,
     textsize=10.0,
@@ -38,15 +39,13 @@ def get_tikz_code(
     extra_tikzpicture_parameters=None,
     dpi=None,
     show_info=True,
+    include_disclaimer=True,
 ):
     """Main function. Here, the recursion into the image starts and the
     contents are picked up. The actual file gets written in this routine.
 
     :param figure: either a Figure object or 'gcf' (default).
 
-    :param filepath: The file to which the TikZ output will be written.
-    :type filepath: str
-
     :param figurewidth: If not ``None``, this will be used as figure width
                         within the TikZ/PGFPlots output. If ``figureheight``
                         is not given, ``matplotlib2tikz`` will try to preserve
@@ -141,8 +140,16 @@ def get_tikz_code(
     data["rel data path"] = tex_relative_path_to_data
     data["externalize tables"] = externalize_tables
     data["override externals"] = override_externals
-    data["output dir"] = os.path.dirname(filepath)
-    data["base name"] = os.path.splitext(os.path.basename(filepath))[0]
+
+    if filepath:
+        data["output dir"] = os.path.dirname(filepath)
+    else:
+        directory = tempfile.mkdtemp()
+        data["output dir"] = directory
+
+    data["base name"] = (
+        os.path.splitext(os.path.basename(filepath))[0] if filepath else "tmp"
+    )
     data["strict"] = strict
     data["tikz libs"] = set()
     data["pgfplots libs"] = set()
@@ -181,11 +188,12 @@ def get_tikz_code(
     if "is_in_groupplot_env" in data and data["is_in_groupplot_env"]:
         content.extend("\\end{groupplot}\n\n")
 
-    disclaimer = "This file was created by matplotlib2tikz v%s." % __version__
-
     # write disclaimer to the file header
     code = """"""
-    code += _tex_comment(disclaimer)
+
+    if include_disclaimer:
+        disclaimer = "This file was created by matplotlib2tikz v%s." % __version__
+        code += _tex_comment(disclaimer)
 
     # write the contents
     if wrap and axis_environment:
@@ -207,15 +215,18 @@ def get_tikz_code(
     return code
 
 
-def save(*args, encoding=None, **kwargs):
+def save(filepath, *args, encoding=None, **kwargs):
     """Same as `get_tikz_code()`, but actually saves the code to a file.
 
+    :param filepath: The file to which the TikZ output will be written.
+    :type filepath: str
+
     :param encoding: Sets the text encoding of the output file, e.g. 'utf-8'.
                      For supported values: see ``codecs`` module.
     :returns: None
     """
     code = get_tikz_code(*args, **kwargs)
-    file_handle = codecs.open(args[0], "w", encoding)
+    file_handle = codecs.open(filepath, "w", encoding)
     try:
         file_handle.write(code)
     except UnicodeEncodeError:

test/create_tex

@@ -21,20 +21,20 @@ def _main():
 
     if not os.path.isdir(test_dir):
         os.mkdir(test_dir)
-    tex_file_path = os.path.join(test_dir, 'acid.tex')
+    tex_file_path = os.path.join(test_dir, "acid.tex")
 
     # directory where all the generated files will end up
-    data_dir = os.path.join(test_dir, 'data')
+    data_dir = os.path.join(test_dir, "data")
     if not os.path.isdir(data_dir):
         os.mkdir(data_dir)
 
     # how to get from the LaTeX file to the data
-    tex_relative_path_to_data = './data'
+    tex_relative_path_to_data = "./data"
 
-    figure_width = '7.5cm'
+    figure_width = "7.5cm"
 
     # open file for writing
-    file_handle = open(tex_file_path, 'w')
+    file_handle = open(tex_file_path, "w")
 
     write_document_header(file_handle, figure_width)
 
@@ -44,41 +44,38 @@ def _main():
         test_list = testfunctions.__all__
 
     for name in test_list:
-        print('Test function %s...' % name)
+        print("Test function %s..." % name)
 
         # import the test
-        test = import_module('testfunctions.' + name)
+        test = import_module("testfunctions." + name)
 
         pp.cla()
         pp.clf()
 
         # plot the test example
         test.plot()
-        tikz_path = os.path.join(data_dir, name + '.tex')
+        tikz_path = os.path.join(data_dir, name + ".tex")
         tikz_tex_path = os.path.join(
-                tex_relative_path_to_data,
-                os.path.basename(tikz_path)
-                )
+            tex_relative_path_to_data, os.path.basename(tikz_path)
+        )
         # convert to tikz
         matplotlib2tikz.save(
             tikz_path,
             figurewidth=figure_width,
             tex_relative_path_to_data=tex_relative_path_to_data,
-            show_info=False
-            )
-        tikz = '\\input{%s}' % tikz_tex_path
+            show_info=False,
+        )
+        tikz = "\\input{%s}" % tikz_tex_path
         # file_handle.write('\\input{%s}\n' % tikz_tex_path)
 
         # plot reference figure
-        pdf_path = os.path.join(data_dir, name + '.pdf')
+        pdf_path = os.path.join(data_dir, name + ".pdf")
         pp.savefig(pdf_path)
-        pdf_path = os.path.join(
-                tex_relative_path_to_data,
-                os.path.basename(pdf_path)
-                )
+        pdf_path = os.path.join(tex_relative_path_to_data, os.path.basename(pdf_path))
 
         # Open figure, insert PDF
-        file_handle.write('''%% test plot %s
+        file_handle.write(
+            """%% test plot %s
 \\begin{figure}%%
 \\centering%%
 \\begin{tabular}{cc}
@@ -89,19 +86,20 @@ def _main():
 \\caption{%s.}%%
 \\end{figure}\\clearpage
 
-''' % (name, pdf_path, tikz, test.desc)
-            )
-        print('done.')
+"""
+            % (name, pdf_path, tikz, test.desc)
+        )
+        print("done.")
     write_document_closure(file_handle)
     file_handle.close()
     return
 
 
 def write_document_header(file_handle, figure_width):
-    '''Write the LaTeX document header to the file.
-    '''
+    """Write the LaTeX document header to the file.
+    """
     file_handle.write(
-        '''\\documentclass[landscape]{scrartcl}
+        """\\documentclass[landscape]{scrartcl}
 \\usepackage[utf8]{inputenc}
 \\usepackage{fontspec}
 \\usepackage{graphicx}
@@ -111,66 +109,62 @@ def write_document_header(file_handle, figure_width):
 \\pgfplotsset{compat=newest}
 \\newlength\\figwidth%%
 \\setlength\\figwidth{%s}
-\\begin{document}''' % figure_width
+\\begin{document}"""
+        % figure_width
     )
     return
 
 
 def write_document_closure(file_handle):
-    '''Write the LaTeX document closure to the file.
-    '''
-    file_handle.write('\\end{document}')
+    """Write the LaTeX document closure to the file.
+    """
+    file_handle.write("\\end{document}")
     return
 
 
-def write_file_comparison_entry(file_handle,
-                                pdf_path,
-                                tikz_path,
-                                test_id,
-                                comment
-                                ):
-    '''Write the Tikz vs. PDF comparison figures to the LaTeX file.
-    '''
-    file_handle.write('% test plot ' + str(test_id) + '\n'
-                      '\\begin{figure}%\n'
-                      '\\centering%\n'
-                      '\\begin{tabular}{cc}\n'
-                      '\includegraphics[width=\\figwidth]'
-                      '{' + str(pdf_path) + '}%\n'
-                      '&\n'
-                      '\input{' + str(tikz_path) + '}%\n'
-                      '\\end{tabular}\n'
-                      '\\caption{' + str(comment) + ' (test ID ' +
-                      str(test_id) + ').}%\n'
-                      '\\end{figure}\\clearpage\n\n'
-                      )
+def write_file_comparison_entry(file_handle, pdf_path, tikz_path, test_id, comment):
+    """Write the Tikz vs. PDF comparison figures to the LaTeX file.
+    """
+    file_handle.write(
+        "% test plot " + str(test_id) + "\n"
+        "\\begin{figure}%\n"
+        "\\centering%\n"
+        "\\begin{tabular}{cc}\n"
+        "\includegraphics[width=\\figwidth]"
+        "{" + str(pdf_path) + "}%\n"
+        "&\n"
+        "\input{" + str(tikz_path) + "}%\n"
+        "\\end{tabular}\n"
+        "\\caption{" + str(comment) + " (test ID " + str(test_id) + ").}%\n"
+        "\\end{figure}\\clearpage\n\n"
+    )
     return
 
 
 def _parse_options():
-    '''Parse input options.'''
+    """Parse input options."""
     import argparse
-    parser = argparse.ArgumentParser(
-            description='Acid test for matplotlib2tikz.'
-            )
+
+    parser = argparse.ArgumentParser(description="Acid test for matplotlib2tikz.")
     parser.add_argument(
-            '--dir', '-d',
-            metavar='TEST_DIR',
-            type=str,
-            default='./tex/',
-            help='directory for the test output (default: ./tex/)'
-            )
+        "--dir",
+        "-d",
+        metavar="TEST_DIR",
+        type=str,
+        default="./tex/",
+        help="directory for the test output (default: ./tex/)",
+    )
     parser.add_argument(
-            'tests',
-            metavar='TEST_NAME',
-            nargs='*',
-            type=str,
-            help='tests to perform (default: all)'
-            )
+        "tests",
+        metavar="TEST_NAME",
+        nargs="*",
+        type=str,
+        help="tests to perform (default: all)",
+    )
     args = parser.parse_args()
     return args.dir, args.tests
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # execute the test
     _main()