Handle beamer overlay marks and report only the exact graphics file if given with an extension (#8)

Co-authored-by: Tobias Raabe <[email protected]>

Author: brettviren

CHANGES.rst

@@ -8,6 +8,14 @@ in reverse chronological order. Releases follow `semantic versioning
 <https://anaconda.org/pytask/latex-dependency-scanner>`_.
 
 
+0.0.4 - 2021-08-08
+------------------
+
+- :gh:`8` changes ``scan`` such that only one path to an image file is returned if the
+  image extension is given and file does not exist. Also, beamer overlays are ignored.
+  Thanks to :ghuser:`brettviren`!
+
+
 0.0.3 - 2021-03-05
 ------------------
 

src/latex_dependency_scanner/scanner.py

@@ -1,11 +1,11 @@
 """Includes the ability to scan a LaTeX document."""
 import re
+from os.path import splitext
 from pathlib import Path
 from typing import List
 from typing import Optional
 from typing import Union
 
-
 COMMON_TEX_EXTENSIONS = [".ltx", ".tex"]
 """List[str]: List of typical file extensions that contain latex"""
 
@@ -37,7 +37,9 @@
 
 REGEX_TEX = re.compile(
     r"\\(?P<type>usepackage|RequirePackage|include|addbibresource|bibliography|putbib|"
-    r"includegraphics|input|(sub)?import|lstinputlisting)(\[[^\[\]]*\])?"
+    r"includegraphics|input|(sub)?import|lstinputlisting)"
+    r"(<[^<>]*>)?"
+    r"(\[[^\[\]]*\])?"
     r"({(?P<relative_to>[^{}]*)})?{(?P<file>[^{}]*)}",
     re.M,
 )
@@ -130,7 +132,11 @@ def yield_nodes_from_node(
                 elif match.group("type") in ["input", "include", "import", "subimport"]:
                     common_extensions = [".tex"]
                 elif match.group("type") == "includegraphics":
-                    common_extensions = COMMON_GRAPHICS_EXTENSIONS
+                    ext = splitext(path)[-1]
+                    if ext in COMMON_GRAPHICS_EXTENSIONS:
+                        common_extensions = [ext]
+                    else:
+                        common_extensions = COMMON_GRAPHICS_EXTENSIONS
                 elif match.group("type") == "lstinputlistings":
                     common_extensions = [""]
                 else:

tests/test_scan.py

@@ -82,65 +82,75 @@ def test_input_or_include_without_extension_and_file(tmp_path, directive):
 @needs_latexmk
 @pytest.mark.end_to_end
 @pytest.mark.parametrize("image_ext", COMMON_GRAPHICS_EXTENSIONS)
-def test_includegraphics(tmp_path, image_ext):
-    """Test includegraphics.
+@pytest.mark.parametrize("has_extension", [True, False])
+@pytest.mark.parametrize("file_exists", [True, False])
+def test_includegraphics(tmp_path, image_ext, has_extension, file_exists):
+    """Test includegraphics with/out extensions and if (not) the image file exists.
 
     Using post-script image files does not work with latexmk, since the .ps-file is
     converted to .pdf every run and latexmk will interpret it as a new file every time.
     Can be resolved by allowing pdflatex as the builder.
 
     """
-    if image_ext == ".ps":
+    if image_ext == ".ps" and file_exists:
         pytest.xfail(
             ".ps does not work with latexmk: https://tex.stackexchange.com/a/67904."
         )
-    if image_ext == ".eps":
+    if image_ext == ".eps" and file_exists:
         pytest.xfail(
             ".eps maybe needs \\graphicspath: https://tex.stackexchange.com/a/98886."
         )
 
-    source = """
-    \\documentclass{article}
-    \\usepackage{graphicx}
-    % \\usepackage{auto-pst-pdf} necessary for .ps-files.
-    \\begin{document}
-    \\includegraphics{image}
-    \\end{document}
+    source = f"""
+    \\documentclass{{article}}
+    \\usepackage{{graphicx}}
+    \\begin{{document}}
+    \\includegraphics{{image{image_ext if has_extension else ''}}}
+    \\end{{document}}
     """
     tmp_path.joinpath("document.tex").write_text(textwrap.dedent(source))
 
     # In case no extension is passed, we pick the pdf.
     _image_ext = image_ext if image_ext else ".pdf"
-    shutil.copy(TEST_RESOURCES / f"image{_image_ext}", tmp_path / f"image{_image_ext}")
 
-    compile_pdf(tmp_path / "document.tex", tmp_path / "bld" / "document.pdf")
+    if file_exists:
+        shutil.copy(
+            TEST_RESOURCES / f"image{_image_ext}", tmp_path / f"image{_image_ext}"
+        )
+        compile_pdf(tmp_path / "document.tex", tmp_path / "bld" / "document.pdf")
 
     nodes = scan(tmp_path.joinpath("document.tex"))
 
-    assert nodes == [
-        tmp_path.joinpath("document.tex"),
-        tmp_path.joinpath(f"image{_image_ext}"),
-    ]
+    expected = [tmp_path.joinpath("document.tex")]
+    if has_extension or file_exists:
+        expected.append(tmp_path.joinpath(f"image{_image_ext}"))
+    else:
+        expected.extend(
+            [
+                (tmp_path / "image").with_suffix(suffix)
+                for suffix in COMMON_GRAPHICS_EXTENSIONS
+            ]
+        )
+
+    assert nodes == expected
 
 
 @pytest.mark.end_to_end
-def test_includegraphics_without_extension_and_non_existent_file(tmp_path):
-    source = """
-    \\documentclass{article}
-    \\usepackage{graphicx}
-    \\begin{document}
-    \\includegraphics{image}
-    \\end{document}
+def test_includegraphics_with_beamer_overlay(tmp_path):
+    source = r"""
+    \documentclass{beamer}
+    \usepackage{graphicx}
+    \begin{document}
+    \begin{frame}
+    \includegraphics<1>{image.pdf}
+    \end{frame}
+    \end{document}
     """
     tmp_path.joinpath("document.tex").write_text(textwrap.dedent(source))
 
     nodes = scan(tmp_path.joinpath("document.tex"))
 
-    expected = [tmp_path / "document.tex"] + [
-        (tmp_path / "image").with_suffix(suffix)
-        for suffix in COMMON_GRAPHICS_EXTENSIONS
-    ]
-    assert nodes == expected
+    assert nodes == [tmp_path.joinpath("document.tex"), tmp_path.joinpath("image.pdf")]
 
 
 @needs_latexmk