exceptions

Author: mmatera

generate/testdata.py

@@ -1,18 +1,15 @@
-import re
-
 import os.path as osp
 import pickle
+import re
 import subprocess
 import tempfile
 from typing import Dict, Optional, Union
 
 import matplotlib
 import matplotlib.pyplot as plt
-
+from doc2rst import DOCTEST_RST_DATA_PCL
 from mathics import __version__, settings, version_info, version_string
-from mathics import settings
 from mathics.doc.utils import load_doctest_data
-from doc2rst import DOCTEST_RST_DATA_PCL
 
 ASY_LATEX_BLOCK = re.compile(r"\\begin{asy}([\s\S]+?)\\end{asy}")
 IMAGE_LATEX_ENTRY = re.compile(r"(?m)\\includegraphics\[(.*?)\]{(.*?)}")
@@ -23,7 +20,6 @@
 SKIP_ASY = False
 
 
-
 def convert_asy_code(content: str, key=""):
     """Convert asy code into a png picture.
     Return a LaTeX includegraphics instruction"""
@@ -36,7 +32,9 @@ def convert_asy_code(content: str, key=""):
     tmp_path, _ = osp.split(tmp_filename)
     result = tmp_filename[:-4] + ".png"
     if not SKIP_ASY:
-        subprocess.run(["asy", "-f", "png", "-render", "70", tmp_filename], cwd=tmp_path)
+        subprocess.run(
+            ["asy", "-f", "png", "-render", "70", tmp_filename], cwd=tmp_path
+        )
     result = osp.abspath(result)
     return r"\includegraphics[]{" + result + "}"
 
@@ -46,7 +44,7 @@ def convert_latex_to_png(content, key=""):
     Generate a png image from LaTeX
     code.
     """
-    tmp_filename = get_tmp_filename(prefix="eq_"+key, suffix=".png")
+    tmp_filename = get_tmp_filename(prefix="eq_" + key, suffix=".png")
     try:
         latex_to_img(f"${content}$", tmp_filename)
     except ValueError as e:
@@ -57,7 +55,7 @@ def convert_latex_to_png(content, key=""):
 
 
 def convert_mathics_latex_to_RsT(
-        out_latex: Optional[Union[str, dict]], key=""
+    out_latex: Optional[Union[str, dict]], key=""
 ) -> Optional[Union[str, dict]]:
     """
     Convert a LaTeX block into a RsT compatible
@@ -74,7 +72,9 @@ def convert_mathics_latex_to_RsT(
     assert isinstance(out_latex, str)
     # out_latex is a string
     out_latex = str(out_latex).strip()
-    out_latex = ASY_LATEX_BLOCK.sub(lambda m: convert_asy_code(m.group(1), key), out_latex)
+    out_latex = ASY_LATEX_BLOCK.sub(
+        lambda m: convert_asy_code(m.group(1), key), out_latex
+    )
     out_latex = out_latex.strip()
     img_match = IMAGE_LATEX_ENTRY.fullmatch(out_latex)
     if img_match:
@@ -94,7 +94,6 @@ def convert_mathics_latex_to_RsT(
     return f":math:`{out_latex}`\n"
 
 
-
 def convert_output_to_rst(test_data, key=""):
     """
     Convert the output data from a doctest
@@ -104,9 +103,11 @@ def convert_output_to_rst(test_data, key=""):
     try:
         converted_data = {
             "query": test_data["query"],
-            "results": [convert_result_to_rst(item, key) for item in test_data["results"]],
+            "results": [
+                convert_result_to_rst(item, key) for item in test_data["results"]
+            ],
         }
-    except ValueError, RuntimeError:
+    except (ValueError, RuntimeError):
         print("Result from ", test_data["query"], "could not be converted.")
         return None
     return converted_data
@@ -120,7 +121,10 @@ def convert_result_to_rst(result_dict, key=""):
     converted_result = {
         "line": result_dict["line"],
         "form": "RsT",
-        "out": [convert_mathics_latex_to_RsT(out_line, key) for out_line in result_dict["out"]],
+        "out": [
+            convert_mathics_latex_to_RsT(out_line, key)
+            for out_line in result_dict["out"]
+        ],
         "result": convert_mathics_latex_to_RsT(result_dict["result"], key),
     }
     for key in result_dict:
@@ -136,11 +140,12 @@ def convert_test_data_to_rst(latex_test_data):
     """
     rst_tex_data = {}
     for key, test in latex_test_data.items():
-        rst_tex_data[key] = convert_output_to_rst(test, ("_".join(key[:-1])).replace(" ", "_")+"_")
+        rst_tex_data[key] = convert_output_to_rst(
+            test, ("_".join(key[:-1])).replace(" ", "_") + "_"
+        )
     return rst_tex_data
 
 
-
 def get_tmp_filename(prefix="", suffix=""):
     # This produces a random name, where the png file is going to be stored.
     # LaTeX does not have a native way to store an figure embedded in
@@ -158,23 +163,31 @@ def latex_to_img(tex, fn):
     https://stackoverflow.com/questions/1381741/converting-latex-code-to-images-or-other-displayble-format-with-python
     """
     matplotlib.rcParams["text.latex.preamble"] = (
-        "\\usepackage{multicol}\n" "\\usepackage{amsmath}\n" "\\usepackage{amssymb}\n" "\\usepackage{graphicx}\n"
+        "\\usepackage{multicol}\n"
+        "\\usepackage{amsmath}\n"
+        "\\usepackage{amssymb}\n"
+        "\\usepackage{graphicx}\n"
     )
     # LaTeX from matplotlib does not accept linebreaks or
     # the \text command. Use \mbox instead.
-    tex = tex.replace(r'\text{',r'\mbox{')
+    tex = tex.replace(r"\text{", r"\mbox{")
     tex = tex.replace("\n", " ")
     # TODO: adjust the size of the figure.
-    plt.figure(figsize=(3,1))
+    plt.figure(figsize=(3, 1))
     plt.rc("text", usetex=True)
     plt.rc("font", family="serif")
     plt.axis("off")
     plt.text(0.05, 0.5, f"{tex}", size=12)
-    plt.savefig(fn, format="png", bbox_inches='tight', backend="pgf", dpi=250,)
+    plt.savefig(
+        fn,
+        format="png",
+        bbox_inches="tight",
+        backend="pgf",
+        dpi=250,
+    )
     plt.close()
 
 
-
 def read_doctest_data(quiet=False) -> Optional[Dict[tuple, dict]]:
     """
     Read doctest information from PCL file and return this.
@@ -193,7 +206,6 @@ def read_doctest_data(quiet=False) -> Optional[Dict[tuple, dict]]:
         return {}
 
 
-
 def main():
     """Generate a pickle file with outputs compatible with RsT"""
     latex_test_data = read_doctest_data()
@@ -203,7 +215,5 @@ def main():
     print("done.")
 
 
-
-    
-if __name__ == "__main__":    
+if __name__ == "__main__":
     main()