Keep only scanned dependencies if they already exist and release v0.0.10. (#16)

Author: tobiasraabe

CHANGES.rst

@@ -7,6 +7,13 @@ all releases are available on `Anaconda.org
 <https://anaconda.org/pytask/pytask-latex>`_.
 
 
+0.0.10 - 2021-01-16
+-------------------
+
+- :gh:`16` fixes the scanner by keeping only scanned dependencies which exist. Convert
+  args to strings.
+
+
 0.0.9 - 2020-12-28
 ------------------
 

README.rst

@@ -10,6 +10,10 @@
 .. image:: https://codecov.io/gh/pytask-dev/pytask-latex/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/pytask-dev/pytask-latex
 
+.. image:: https://results.pre-commit.ci/badge/github/pytask-dev/pytask-latex/main.svg
+    :target: https://results.pre-commit.ci/latest/github/pytask-dev/pytask-latex/main
+    :alt: pre-commit.ci status
+
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
     :target: https://github.com/psf/black
 
@@ -134,7 +138,7 @@ For example, to compile your document with XeLaTeX, use
     def task_compile_latex_document():
         pass
 
-The options ``jobname``, ``output-directory`` and the ``.tex`` file which will be
+The options ``--jobname``, ``--output-directory`` and the ``.tex`` file which will be
 compiled are automatically handled and inferred from the ``@pytask.mark.depends_on`` and
 ``@pytask.mark.produces`` markers.
 
@@ -180,11 +184,11 @@ to include the latex decorator in the parametrization just like with
         [
             (
                 "document.pdf",
-                (["--pdf", "--interaction=nonstopmode", "--synctex=1", "--cd"],),
+                ("--pdf", "--interaction=nonstopmode", "--synctex=1", "--cd"),
             ),
             (
                 "document.dvi",
-                (["--dvi", "--interaction=nonstopmode", "--synctex=1", "--cd"],),
+                ("--dvi", "--interaction=nonstopmode", "--synctex=1", "--cd"),
             ),
         ],
     )
@@ -216,12 +220,14 @@ infer_latex_dependencies
     `latex-dependency-scanner <https://github.com/pytask-dev/latex-dependency-scanner>`_
     if the following configuration value is true which is also the default.
 
+    .. code-block:: ini
+
         infer_latex_dependencies = true
 
     Since the package is in its early development phase and LaTeX provides a myriad of
     ways to include files as well as providing shortcuts for paths (e.g.,
     ``\graphicspath``), there are definitely some rough edges left. File an issue here
-    or in the other project to make us aware of the problem.
+    or in the other project in case of a problem.
 
 
 Changes

environment.yml

@@ -25,3 +25,4 @@ dependencies:
   - pre-commit
   - pytest-cov
   - pytest-xdist
+  - virtualenv=20.0.33

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.9
+current_version = 0.0.10
 parse = (?P<major>\d+)\.(?P<minor>\d+)(\.(?P<patch>\d+))(\-?((dev)?(?P<dev>\d+))?)
 serialize = 
 	{major}.{minor}.{patch}dev{dev}

setup.py

@@ -3,7 +3,7 @@
 
 setup(
     name="pytask-latex",
-    version="0.0.9",
+    version="0.0.10",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
     entry_points={"pytask": ["pytask_latex = pytask_latex.plugin"]},

src/pytask_latex/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.9"
+__version__ = "0.0.10"

src/pytask_latex/collect.py

@@ -6,6 +6,7 @@
 from pathlib import Path
 from typing import Iterable
 from typing import Optional
+from typing import Sequence
 from typing import Union
 
 from _pytask.config import hookimpl
@@ -33,14 +34,15 @@ def latex(options: Optional[Union[str, Iterable[str]]] = None):
     """
     if options is None:
         options = DEFAULT_OPTIONS.copy()
-    elif isinstance(options, str):
-        options = [options]
-
+    else:
+        options = _to_list(options)
+    options = [str(i) for i in options]
     return options
 
 
 def compile_latex_document(latex):
     """Replaces the dummy function provided by the user."""
+    print("Executing " + " ".join(latex) + ".")  # noqa: T001
     subprocess.run(latex, check=True)
 
 
@@ -101,9 +103,7 @@ def pytask_collect_task_teardown(session, task):
 
 
 def _get_node_from_dictionary(obj, key, fallback=0):
-    if isinstance(obj, Path):
-        pass
-    elif isinstance(obj, dict):
+    if isinstance(obj, dict):
         obj = obj.get(key) or obj.get(fallback)
     return obj
 
@@ -135,18 +135,22 @@ def _add_latex_dependencies_retroactively(task, session):
     # Scan the LaTeX document for included files.
     latex_dependencies = set(scan(source.path))
 
-    # Remove duplicated dependencies which have already been added by the user.
+    # Remove duplicated dependencies which have already been added by the user and those
+    # which do not exist.
     existing_paths = {
         i.path for i in task.depends_on.values() if isinstance(i, FilePathNode)
     }
-    new_dependencies = latex_dependencies - existing_paths
+    new_deps = latex_dependencies - existing_paths
+    new_existing_deps = {i for i in new_deps if i.exists()}
 
+    # Put scanned dependencies in a dictionary with incrementing keys.
     used_integer_keys = [i for i in task.depends_on if isinstance(i, int)]
     max_int = max(used_integer_keys) if used_integer_keys else 0
+    new_existing_deps = dict(enumerate(new_existing_deps, max_int + 1))
 
-    new_dependencies = dict(enumerate(new_dependencies, max_int + 1))
+    # Collect new dependencies and add them to the task.
     collected_dependencies = _collect_nodes(
-        session, task.path, task.name, new_dependencies
+        session, task.path, task.name, new_existing_deps
     )
     task.depends_on = {**task.depends_on, **collected_dependencies}
 
@@ -211,3 +215,29 @@ def _prepare_cmd_options(session, task, args):
             latex_document.as_posix(),
         ]
     )
+
+
+def _to_list(scalar_or_iter):
+    """Convert scalars and iterables to list.
+
+    Parameters
+    ----------
+    scalar_or_iter : str or list
+
+    Returns
+    -------
+    list
+
+    Examples
+    --------
+    >>> _to_list("a")
+    ['a']
+    >>> _to_list(["b"])
+    ['b']
+
+    """
+    return (
+        [scalar_or_iter]
+        if isinstance(scalar_or_iter, str) or not isinstance(scalar_or_iter, Sequence)
+        else list(scalar_or_iter)
+    )

src/pytask_latex/parametrize.py

@@ -8,4 +8,4 @@ def pytask_parametrize_kwarg_to_marker(obj, kwargs):
     """Register kwargs as latex marker."""
     if callable(obj):
         if "latex" in kwargs:
-            mark.latex(*kwargs.pop("latex"))(obj)
+            mark.latex(kwargs.pop("latex"))(obj)

tests/conftest.py

@@ -2,10 +2,15 @@
 import os
 import shutil
 import sys
+from pathlib import Path
 
 import pytest
 from click.testing import CliRunner
 
+
+TEST_RESOURCES = Path(__file__).parent / "resources"
+
+
 needs_latexmk = pytest.mark.skipif(
     shutil.which("latexmk") is None, reason="latexmk needs to be installed."
 )

tests/resources/image.png

@@ -6,6 +6,7 @@
 from _pytask.mark import Mark
 from conftest import needs_latexmk
 from conftest import skip_on_github_actions_with_win
+from conftest import TEST_RESOURCES
 from pytask import cli
 from pytask import main
 from pytask_latex.execute import pytask_execute_task_setup
@@ -384,7 +385,7 @@ def task_compile_document():
 @pytest.mark.end_to_end
 def test_compile_document_w_wrong_flag(tmp_path):
     """Test that wrong flags raise errors."""
-    tmp_path.joinpath("sub", "resources").mkdir(parents=True)
+    tmp_path.joinpath("sub").mkdir(parents=True)
 
     task_source = """
     import pytask
@@ -411,3 +412,40 @@ def task_compile_document():
     assert session.exit_code == 1
     assert len(session.tasks) == 1
     assert isinstance(session.execution_reports[0].exc_info[1], CalledProcessError)
+
+
+@needs_latexmk
+@pytest.mark.end_to_end
+def test_compile_document_w_image(runner, tmp_path):
+    task_source = f"""
+    import pytask
+    import shutil
+
+    @pytask.mark.produces("image.png")
+    def task_create_image():
+        shutil.copy(
+            "{TEST_RESOURCES.joinpath("image.png").as_posix()}",
+            "{tmp_path.joinpath("image.png").as_posix()}"
+        )
+
+    @pytask.mark.latex
+    @pytask.mark.depends_on("document.tex")
+    @pytask.mark.produces("document.pdf")
+    def task_compile_document():
+        pass
+
+    """
+    tmp_path.joinpath("task_dummy.py").write_text(textwrap.dedent(task_source))
+
+    latex_source = r"""
+    \documentclass{report}
+    \usepackage{graphicx}
+    \begin{document}
+    \includegraphics{image}
+    \end{document}
+    """
+    tmp_path.joinpath("document.tex").write_text(textwrap.dedent(latex_source))
+
+    result = runner.invoke(cli, [tmp_path.as_posix()])
+
+    assert result.exit_code == 0

tests/test_execute.py

@@ -84,11 +84,11 @@ def test_parallel_parametrization_over_source_file(runner, tmp_path):
         [
             (
                 "document.pdf",
-                (["--pdf", "--interaction=nonstopmode", "--synctex=1", "--cd"],)
+                ("--pdf", "--interaction=nonstopmode", "--synctex=1", "--cd")
             ),
             (
                 "document.dvi",
-                (["--dvi", "--interaction=nonstopmode", "--synctex=1", "--cd"],)
+                ("--dvi", "--interaction=nonstopmode", "--synctex=1", "--cd")
             ),
         ],
     )

tests/test_parallel.py

@@ -76,12 +76,12 @@ def test_parametrizing_latex_options(tmp_path):
         (
             "document.tex",
             "document.pdf",
-            (["--interaction=nonstopmode", "--pdf", "--cd"],)
+            ("--interaction=nonstopmode", "--pdf", "--cd")
         ),
         (
             "document.tex",
             "document.dvi",
-            (["--interaction=nonstopmode", "--dvi", "--cd"],)
+            ("--interaction=nonstopmode", "--dvi", "--cd")
         ),
     ])
     def task_compile_latex_document():

tests/test_parametrize.py

@@ -47,6 +47,7 @@ addopts = --doctest-modules
 filterwarnings =
     ignore: the imp module is deprecated in favour of importlib
     ignore: Using or importing the ABCs from 'collections'
+    ignore: The (parser|symbol) module is deprecated and will be removed in future
 junit_family = xunit2
 markers =
     wip: Tests that are work-in-progress.