Merge pull request #27 from nschloe/dollar-replace

Dollar replace

Author: nschloe

.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
     steps:
     - uses: actions/setup-python@v2
       with:
-        python-version: "3.x"
+        python-version: ${{ matrix.python-version }}
     - uses: actions/checkout@v2
     - name: Test with tox
       run: |

README.md

@@ -33,14 +33,13 @@ Because of
 a+b = c
 \]
 (\textit{Pythogoras}),
-and $y = 2^n g$ with $n = 1,\dots,10$, we have $\frac{\Gamma}{2} = 8$.
+and \(y = 2^n g\) with \(n = 1,\dots,10\), we have \(\frac{\Gamma}{2} = 8.\)
 ```
 You can use
 ```
 blacktex -i in.tex
 ```
-to modify a file in-place.
-
+to modify a file in-place. See `blacktex -h` for all options.
 
 ### Installation
 

blacktex/cli.py

@@ -8,7 +8,7 @@ def main(argv=None):
     parser = _get_parser()
     args = parser.parse_args(argv)
 
-    out = blacktex.clean(args.infile.read())
+    out = blacktex.clean(args.infile.read(), args.keep_comments, args.keep_dollar_math)
 
     if args.in_place:
         with open(args.infile.name, "w") as f:
@@ -41,7 +41,14 @@ def _get_parser():
     )
 
     parser.add_argument(
-        "-k", "--keep-comments", action="store_true", help="keep comments"
+        "-c", "--keep-comments", action="store_true", help="keep comments"
+    )
+
+    parser.add_argument(
+        "-d",
+        "--keep-dollar-math",
+        action="store_true",
+        help="keep inline math with $...$",
     )
 
     version_text = "blacktex {}, Python {}.{}.{}".format(

blacktex/main.py

@@ -63,6 +63,25 @@ def _replace_dollar_dollar(string):
     return _substitute_string_ranges(string, ranges, replacements)
 
 
+def _replace_dollar(string):
+    """Replace $...$ by \\(...\\). See <https://tex.stackexchange.com/q/510/13262>."""
+    # (?<!\\\\) checks there is no backslash before (negative lookbehind)
+    # (?:\\\\{2})* matches all even numbers of backslashes
+    p = re.compile("(?<!\\\\)(?:\\\\{2})*\\$")
+    locations = [m.end() for m in p.finditer(string)]
+    assert len(locations) % 2 == 0
+
+    k = 0
+    ranges = []
+    replacements = []
+    while k < len(locations):
+        ranges.append((locations[k] - 1, locations[k + 1]))
+        replacements.append("\\(" + string[locations[k] : locations[k + 1] - 1] + "\\)")
+        k += 2
+
+    return _substitute_string_ranges(string, ranges, replacements)
+
+
 def _replace_obsolete_text_mods(string):
     string = string.replace("{\\bf ", "\\textbf{")
     string = string.replace("{\\it ", "\\textit{")
@@ -246,9 +265,7 @@ def _replace_def_by_newcommand(string):
     replacements = []
     for m in p.finditer(string):
         ranges.append((m.start(), m.end()))
-        replacements.append(
-            "\\newcommand{{{}}}".format(string[m.start() + 4 : m.end()])
-        )
+        replacements.append(f"\\newcommand{{{string[m.start() + 4 : m.end()]}}}")
 
     return _substitute_string_ranges(string, ranges, replacements)
 
@@ -314,17 +331,19 @@ def _si_percentage(string):
     return string
 
 
-def clean(string, keep_comments=False):
+def clean(string, keep_comments=False, keep_dollar=False):
     out = string
     out = _remove_trailing_whitespace(out)
     if not keep_comments:
         out = _remove_comments(out)
+    out = _replace_punctuation_outside_math(out)
     out = _replace_dollar_dollar(out)
+    if not keep_dollar:
+        out = _replace_dollar(out)
     out = _replace_obsolete_text_mods(out)
     out = _remove_whitespace_around_brackets(out)
     out = _add_space_after_single_subsuperscript(out)
     out = _replace_dots(out)
-    out = _replace_punctuation_outside_math(out)
     out = _remove_whitespace_before_punctuation(out)
     out = _add_nbsp_before_reference(out)
     out = _replace_double_nbsp(out)

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = blacktex
-version = 0.3.6
+version = 0.4.0
 author = Nico Schlömer
 author_email = [email protected]
 description = Cleans up your LaTeX files

test/test_blacktex.py

@@ -3,6 +3,20 @@
 import blacktex
 
 
+def test_dollar():
+    input_string = "a $a + b = c$ b"
+    out = blacktex.clean(input_string)
+    assert out == r"a \(a + b = c\) b"
+
+    input_string = r"a \$a + b = c\$ b"
+    out = blacktex.clean(input_string)
+    assert out == r"a \$a + b = c\$ b"
+
+    input_string = r"a \\$a + b = c\\$ b"
+    out = blacktex.clean(input_string)
+    assert out == "a \\\\\n\\(a + b = c\\\\\n\\) b"
+
+
 def test_readme():
     input_string = (
         "Because   of $$a+b=c$$ ({\\it Pythogoras}),\n"
@@ -17,7 +31,8 @@ def test_readme():
         "a+b = c\n"
         "\\]\n"
         "(\\textit{Pythogoras}),\n"
-        "and $y = 2^n g$ with $n = 1,\\dots,10$, we have $\\frac{\\Gamma}{2} = 8$."
+        "and \\(y = 2^n g\\) with \\(n = 1,\\dots,10\\), we have "
+        "\\(\\frac{\\Gamma}{2} = 8\\)."
     )
 
 
@@ -114,17 +129,17 @@ def test_subsuperscript_space():
     out = blacktex.clean(input_string)
     assert out == "2^n g"
 
-    input_string = "$1/n^3$."
+    input_string = "1/n^3"
     out = blacktex.clean(input_string)
-    assert out == "$1/n^3$."
+    assert out == "1/n^3"
 
-    input_string = "${n^3}$."
+    input_string = "n^3"
     out = blacktex.clean(input_string)
-    assert out == "${n^3}$."
+    assert out == "n^3"
 
-    input_string = "$(n^3)$."
+    input_string = "(n^3)"
     out = blacktex.clean(input_string)
-    assert out == "$(n^3)$."
+    assert out == "(n^3)"
 
     input_string = "n^\\alpha"
     out = blacktex.clean(input_string)
@@ -154,7 +169,7 @@ def test_cdots():
 
 def test_punctuation_outside_math():
     input_string = "$a+b.$"
-    out = blacktex.clean(input_string)
+    out = blacktex.clean(input_string, keep_dollar=True)
     assert out == "$a+b$."
 
 
@@ -178,14 +193,14 @@ def test_double_nbsp():
 
 def test_over_frac():
     input_string = "Some ${2\\over 3^{4+x}}$ equation ${\\pi \\over4}$."
-    out = blacktex.clean(input_string)
+    out = blacktex.clean(input_string, keep_dollar=True)
     assert out == "Some $\\frac{2}{3^{4+x}}$ equation $\\frac{\\pi}{4}$."
 
 
 def test_over_frac_warn():
     input_string = "Some $2\\over 3^{4+x}$."
     with pytest.warns(UserWarning):
-        out = blacktex.clean(input_string)
+        out = blacktex.clean(input_string, keep_dollar=True)
     assert out == "Some $2\\over 3^{4+x}$."
 
 
@@ -197,7 +212,7 @@ def test_overline_warn():
 
 def test_linebreak_after_double_backslash():
     input_string = "Some $2\\\\3 4\\\\\n6\\\\[2mm]7$."
-    out = blacktex.clean(input_string)
+    out = blacktex.clean(input_string, keep_dollar=True)
     assert out == "Some $2\\\\\n3 4\\\\\n6\\\\\n[2mm]7$."
 
 
@@ -209,13 +224,13 @@ def test_nbsp_space():
 
 def test_keywords_without_backslash():
     input_string = "maximum and logarithm $max_x log(x)$"
-    out = blacktex.clean(input_string)
+    out = blacktex.clean(input_string, keep_dollar=True)
     assert out == "maximum and logarithm $\\max_x \\log(x)$"
 
 
 def test_curly_around_round_with_exponent():
     input_string = "$(a+b)^n \\left(a+b\\right)^{n+1}$"
-    out = blacktex.clean(input_string)
+    out = blacktex.clean(input_string, keep_dollar=True)
     assert out == "${(a+b)}^n {\\left(a+b\\right)}^{n+1}$"
 
 
@@ -338,4 +353,4 @@ def test_escaped_percentage_sign():
 
 
 if __name__ == "__main__":
-    test_si_percentage()
+    test_dollar()