Release v0.0.2, allow multiple dependencies for LaTeX tasks and better parametrization. (#1)

Author: tobiasraabe

.conda/meta.yaml

@@ -20,7 +20,7 @@ requirements:
 
   run:
     - python >=3.6
-    - pytask >=0.0.3
+    - pytask >=0.0.4
 
 test:
   requires:

.github/workflows/continuous-integration-workflow.yml

@@ -22,6 +22,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
+      - uses: r-lib/actions/setup-tinytex@v1
       - uses: goanpeca/setup-miniconda@v1
         with:
           auto-update-conda: true

CHANGES.rst

@@ -3,10 +3,18 @@ Changes
 
 This is a record of all past pytask-latex releases and what went into them in reverse
 chronological order. Releases follow `semantic versioning <https://semver.org/>`_ and
-all releases are available on `Anaconda.org <https://anaconda.org/pytask/pytask-latex>`_.
+all releases are available on `Anaconda.org
+<https://anaconda.org/pytask/pytask-latex>`_.
 
 
-0.0.1 - 2020-xx-xx
+0.0.2 - 2020-07-22
 ------------------
 
-- :gh:`1` combined the whole effort which went into releasing v0.0.1.
+- :gh:`1` allowed LaTeX tasks to have more than one dependency and allows to parametrize
+  over latex options and latex documents. It also prepares release v0.0.2.
+
+
+0.0.1 - 2020-07-20
+------------------
+
+- Releases v0.0.1.

README.rst

@@ -61,6 +61,18 @@ Here is an example where you want to compile ``document.tex`` to a PDF.
         pass
 
 
+Note that, the first dependency is always assumed to be the LaTeX document. With
+multiple dependencies it may look like this
+
+.. code-block:: python
+
+    @pytask.mark.latex
+    @pytask.mark.depends_on("document.tex", "image.png")
+    @pytask.mark.produces("document.pdf")
+    def task_compile_latex_document():
+        pass
+
+
 To customize the compilation, you can pass some command line arguments to ``latexmk``
 via the ``@pytask.mark.latex`` marker. The default is the following.
 
@@ -74,7 +86,7 @@ For example, to compile your document with XeLaTeX, use
 
 .. code-block:: python
 
-    @pytask.mark.latex("--xelatex", "--interaction=nonstopmode", "--synctex=1")
+    @pytask.mark.latex("--xelatex", "--interaction=nonstopmode")
     def task_compile_latex_document():
         pass
 
@@ -83,6 +95,43 @@ compiled are handled by the ``@pytask.mark.depends_on`` and ``@pytask.mark.produ
 markers and cannot be changed.
 
 
+Parametrization
+~~~~~~~~~~~~~~~
+
+You can also parametrize the compilation, meaning compiling multiple .tex documents
+as well as compiling a .tex document with different command line arguments.
+
+The following task compiles two latex documents.
+
+.. code-block:: python
+
+    @pytask.mark.latex
+    @pytask.mark.parametrize(
+        "depends_on, produces",
+        [("document_1.tex", "document_1.pdf"), ("document_2.tex", "document_2.pdf")],
+    )
+    def task_compile_latex_document():
+        pass
+
+
+If you want to compile the same document with different command line options, you have
+to include the latex decorator in the parametrization just like with
+``@pytask.mark.depends_on`` and ``@pytask.mark.produces``.
+
+.. code-block:: python
+
+    @pytask.mark.depends_on("document.tex")
+    @pytask.mark.parametrize(
+        "produces, latex",
+        [
+            ("document.pdf", ["--pdf", "interaction=nonstopmode"]),
+            ("document.dvi", ["--dvi", "interaction=nonstopmode"]),
+        ],
+    )
+    def task_compile_latex_document():
+        pass
+
+
 Changes
 -------
 

environment.yml

@@ -12,7 +12,7 @@ dependencies:
   - conda-verify
 
   # Package dependencies
-  - pytask
+  - pytask >= 0.0.4
 
   # Misc
   - jupyterlab

setup.cfg

@@ -9,4 +9,4 @@ serialize =
 
 [bumpversion:file:docs/conf.py]
 
-[bumpversion:file:src/parallel/__init__.py]
+[bumpversion:file:src/pytask_latex/__init__.py]

src/pytask_latex/collect.py

@@ -7,18 +7,21 @@
 from pytask.mark import has_marker
 from pytask.nodes import PythonFunctionTask
 from pytask.parametrize import _copy_func
+from pytask.shared import to_list
 
 
-def compile_latex_document(depends_on, produces, args):
-    if depends_on.stem != produces.stem:
-        args.append(f"--jobname={produces.stem}")
+def compile_latex_document(depends_on, produces, latex):
+    latex_document = to_list(depends_on)[0]
+
+    if latex_document.stem != produces.stem:
+        latex.append(f"--jobname={produces.stem}")
 
     subprocess.run(
-        ["latexmk"]
-        + args
-        + [
+        [
+            "latexmk",
+            *latex,
             f"--output-directory={produces.parent.as_posix()}",
-            f"{depends_on.as_posix()}",
+            f"{latex_document.as_posix()}",
         ]
     )
 
@@ -40,10 +43,16 @@ def pytask_collect_task(session, path, name, obj):
         latex_function.pytestmark = copy.deepcopy(task.function.pytestmark)
 
         args = _create_command_line_arguments(task)
-        latex_function = functools.partial(latex_function, args=args)
+        latex_function = functools.partial(latex_function, latex=args)
 
         task.function = latex_function
 
+        if task.depends_on[0].value.suffix != ".tex":
+            raise ValueError(
+                "The first dependency of a LaTeX task must be the document which will "
+                "be compiled."
+            )
+
         return task
 
 

src/pytask_latex/execute.py

@@ -1,8 +1,8 @@
 import shutil
-from pathlib import Path
 
 import pytask
 from pytask.mark import get_markers_from_task
+from pytask.nodes import FilePathNode
 
 
 @pytask.hookimpl
@@ -14,8 +14,20 @@ def pytask_execute_task_setup(task):
                 "your PATH."
             )
 
-    if isinstance(task.depends_on, Path):
-        raise ValueError("'depends_on' must be a path to a single .tex document.")
+        if not (
+            isinstance(task.depends_on[0], FilePathNode)
+            and task.depends_on[0].value.suffix == ".tex"
+        ):
+            raise ValueError(
+                "The first or sole dependency must point to the .tex document which "
+                "will be compiled."
+            )
 
-    if isinstance(task.produces, Path):
-        raise ValueError("'produces' must be a path to a single .pdf document.")
+        if not (
+            isinstance(task.produces[0], FilePathNode)
+            and task.produces[0].value.suffix in [".pdf", ".ps", ".dvi"]
+        ):
+            raise ValueError(
+                "The first or sole product must point to a .pdf, .ps or .dvi file "
+                "which is the compilation."
+            )

src/pytask_latex/parametrize.py

@@ -0,0 +1,8 @@
+import pytask
+
+
+@pytask.hookimpl
+def pytask_generate_tasks_add_marker(obj, kwargs):
+    if callable(obj):
+        if "latex" in kwargs:
+            pytask.mark.__getattr__("latex")(*kwargs.pop("latex"))(obj)

src/pytask_latex/plugin.py

@@ -1,9 +1,11 @@
 import pytask
 from pytask_latex import collect
 from pytask_latex import execute
+from pytask_latex import parametrize
 
 
 @pytask.hookimpl
 def pytask_add_hooks(pm):
     pm.register(collect)
     pm.register(execute)
+    pm.register(parametrize)

tests/conftest.py

@@ -0,0 +1,14 @@
+import os
+import shutil
+import sys
+
+import pytest
+
+needs_latexmk = pytest.mark.skipif(
+    shutil.which("latexmk") is None, reason="latexmk needs to be installed."
+)
+
+skip_on_github_actions_with_win = pytest.mark.skipif(
+    os.environ.get("GITHUB_ACTIONS", "false") == "true" and sys.platform == "win32",
+    reason="TinyTeX does not work on Windows.",
+)