[pre-commit.ci] pre-commit autoupdate (#64)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Tobias Raabe <[email protected]>

Author: pre-commit-ci[bot]

.pre-commit-config.yaml

@@ -30,28 +30,15 @@ repos:
     hooks:
     -   id: reorder-python-imports
         args: [--py38-plus, --add-import, 'from __future__ import annotations']
--   repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v2.5.0
-    hooks:
-    -   id: setup-cfg-fmt
--   repo: https://github.com/psf/black
-    rev: 23.9.1
-    hooks:
-    -   id: black
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.292
+    rev: v0.1.6
     hooks:
       - id: ruff
+      - id: ruff-format
 -   repo: https://github.com/dosisod/refurb
-    rev: v1.21.0
+    rev: v1.24.0
     hooks:
     -   id: refurb
-        args: [--ignore, FURB126]
--   repo: https://github.com/econchick/interrogate
-    rev: 1.5.0
-    hooks:
-    -   id: interrogate
-        args: [-v, --fail-under=40, src, tests]
 -   repo: https://github.com/executablebooks/mdformat
     rev: 0.7.17
     hooks:
@@ -67,7 +54,7 @@ repos:
     - id: codespell
       args: [-L als, -L falsy]
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.5.1'
+    rev: 'v1.7.0'
     hooks:
     -   id: mypy
         additional_dependencies: [
@@ -83,7 +70,7 @@ repos:
     hooks:
     -   id: check-manifest
         args: [--no-build-isolation]
-        additional_dependencies: [setuptools-scm, toml]
+        additional_dependencies: [setuptools-scm, toml, wheel]
 -   repo: meta
     hooks:
     -   id: check-hooks-apply

pyproject.toml

@@ -3,6 +3,50 @@ requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.0"]
 build-backend = "setuptools.build_meta"
 
 
+[project]
+name = "pytask_latex"
+description = "Compile LaTeX documents with pytask."
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only"
+]
+requires-python = ">=3.8"
+dependencies = [ "latex-dependency-scanner>=0.1.1", "pluggy>=1.0.0", "pytask>=0.4.0"]
+dynamic = [ "version" ]
+authors = [ { name = "Tobias Raabe", email = "[email protected]"}]
+readme = { file = "README.md", content-type = "text/markdown"}
+license = { text = "MIT" }
+
+[project.urls]
+Homepage = "https://github.com/pytask-dev/pytask-latex"
+Changelog = "https://github.com/pytask-dev/pytask-latex/blob/main/CHANGES.md"
+Documentation = "https://github.com/pytask-dev/pytask-latex"
+Github = "https://github.com/pytask-dev/pytask-latex"
+Tracker = "https://github.com/pytask-dev/pytask-latex/issues"
+
+[tool.setuptools]
+include-package-data = true
+zip-safe = false
+platforms = [ "any",]
+license-files = [ "LICENSE" ]
+
+[tool.check-manifest]
+ignore = ["src/pytask_latex/_version.py"]
+
+[project.entry-points.pytask]
+pytask_latex = "pytask_latex.plugin"
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.setuptools.packages.find]
+where = [ "src" ]
+namespaces = false
+
+
 [tool.setuptools_scm]
 write_to = "src/pytask_latex/_version.py"
 
@@ -28,9 +72,8 @@ ignore_errors = true
 target-version = "py38"
 select = ["ALL"]
 fix = true
+unsafe-fixes = true
 extend-ignore = [
-    "TCH",
-    "TRY",
     # Numpy docstyle
     "D107",
     "D203",
@@ -42,23 +85,17 @@ extend-ignore = [
     "D416",
     "D417",
     # Others.
-    "D404",  # Do not start module docstring with "This".
-    "RET504",  # unnecessary variable assignment before return.
-    "S101",  # raise errors for asserts.
-    "B905",  # strict parameter for zip that was implemented in py310.
     "I",  # ignore isort
     "ANN101",  # type annotating self
     "ANN102",  # type annotating cls
-    "FBT",  # flake8-boolean-trap
-    "EM",  # flake8-errmsg
-    "ANN401",  # flake8-annotate typing.Any
-    "PD",  # pandas-vet
-    "COM812",  # trailing comma missing, but black takes care of that
+    "ANN401",  # Allow typing.Any.
+    "COM812",  # Comply with ruff-format
+    "ISC001",  # Comply with ruff-format
 ]
 
 
 [tool.ruff.per-file-ignores]
-"tests/*" = ["D", "ANN", "PLR2004"]
+"tests/*" = ["D", "ANN", "PLR2004", "S101"]
 
 
 [tool.ruff.pydocstyle]
@@ -67,7 +104,7 @@ convention = "numpy"
 
 [tool.pytest.ini_options]
 # Do not add src since it messes with the loading of pytask-parallel as a plugin.
-testpaths = ["tests"]
+testpaths = ["src", "tests"]
 markers = [
     "wip: Tests that are work-in-progress.",
     "unit: Flag for unit tests which target mainly a single function.",

setup.cfg

@@ -1,4 +1,4 @@
-"""This module contains the main namespace."""
+"""Contains the main namespace."""
 from __future__ import annotations
 
 try:

src/pytask_latex/__init__.py

@@ -75,7 +75,8 @@ def compile_latex_document(
         for step in _compilation_steps:
             step(path_to_tex=_path_to_tex, path_to_document=_path_to_document)
     except CalledProcessError as e:
-        raise RuntimeError(f"Compilation step {step.__name__} failed.") from e
+        msg = f"Compilation step {step.__name__} failed."
+        raise RuntimeError(msg) from e
 
 
 @hookimpl
@@ -93,10 +94,11 @@ def pytask_collect_task(
         # Parse the @pytask.mark.latex decorator.
         obj, marks = remove_marks(obj, "latex")
         if len(marks) > 1:
-            raise ValueError(
+            msg = (
                 f"Task {name!r} has multiple @pytask.mark.latex marks, but only one is "
                 "allowed."
             )
+            raise ValueError(msg)
         latex_mark = marks[0]
         script, document, compilation_steps = latex(**latex_mark.kwargs)
         parsed_compilation_steps = _parse_compilation_steps(compilation_steps)
@@ -145,19 +147,21 @@ def pytask_collect_task(
         if not (
             isinstance(script_node, PathNode) and script_node.path.suffix == ".tex"
         ):
-            raise ValueError(
+            msg = (
                 "The 'script' keyword of the @pytask.mark.latex decorator must point "
                 f"to LaTeX file with the .tex suffix, but it is {script_node}."
             )
+            raise ValueError(msg)
 
         if not (
             isinstance(document_node, PathNode)
             and document_node.path.suffix in (".pdf", ".ps", ".dvi")
         ):
-            raise ValueError(
+            msg = (
                 "The 'document' keyword of the @pytask.mark.latex decorator must point "
                 "to a .pdf, .ps or .dvi file."
             )
+            raise ValueError(msg)
 
         compilation_steps_node = session.hook.pytask_collect_node(
             session=session,
@@ -283,9 +287,7 @@ def _add_latex_dependencies_retroactively(
         ),
         new_deps,
     )
-    task.depends_on[
-        "_scanned_dependencies"
-    ] = collected_dependencies  # type: ignore[assignment]
+    task.depends_on["_scanned_dependencies"] = collected_dependencies
 
     # Mark the task as being delayed to avoid conflicts with unmatched dependencies.
     task.markers.append(Mark("try_last", (), {}))
@@ -306,10 +308,11 @@ def _collect_node(
         session=session, path=path, node_info=node_info
     )
     if collected_node is None:
-        raise NodeNotCollectedError(
+        msg = (
             f"{node_info.arg_name!r} cannot be parsed as a dependency or product for "
             f"task {node_info.task_name!r} in {node_info.task_path!r}."
         )
+        raise NodeNotCollectedError(msg)
 
     return collected_node
 
@@ -318,7 +321,7 @@ def _parse_compilation_steps(
     compilation_steps: str
     | Callable[..., Any]
     | Sequence[str | Callable[..., Any]]
-    | None
+    | None,
 ) -> list[Callable[..., Any]]:
     """Parse compilation steps."""
     __tracebackhide__ = True
@@ -331,11 +334,13 @@ def _parse_compilation_steps(
             try:
                 parsed_step = getattr(cs, step)
             except AttributeError:
-                raise ValueError(f"Compilation step {step!r} is unknown.") from None
+                msg = f"Compilation step {step!r} is unknown."
+                raise ValueError(msg) from None
             parsed_compilation_steps.append(parsed_step())
         elif callable(step):
             parsed_compilation_steps.append(step)
         else:
-            raise ValueError(f"Compilation step {step!r} is not a valid step.")
+            msg = f"Compilation step {step!r} is not a valid step."
+            raise TypeError(msg)
 
     return parsed_compilation_steps

src/pytask_latex/collect.py

@@ -1,4 +1,4 @@
-"""This module contains compilation steps for compiling a LaTeX document.
+"""Contains compilation steps for compiling a LaTeX document.
 
 Each compilation step must have the following signature:
 
@@ -13,18 +13,24 @@ def compilation_step(path_to_tex: Path, path_to_document: Path):
 from __future__ import annotations
 
 import subprocess
-from pathlib import Path
 from typing import Any
 from typing import Callable
+from typing import TYPE_CHECKING
 
 from pytask_latex.path import relative_to
 from pytask_latex.utils import to_list
 
+if TYPE_CHECKING:
+    from pathlib import Path
+
 
 def latexmk(
-    options: str
-    | list[str]
-    | tuple[str, ...] = ("--pdf", "--interaction=nonstopmode", "--synctex=1", "--cd")
+    options: str | list[str] | tuple[str, ...] = (
+        "--pdf",
+        "--interaction=nonstopmode",
+        "--synctex=1",
+        "--cd",
+    ),
 ) -> Callable[..., Any]:
     """Compilation step that calls latexmk."""
     options = [str(i) for i in to_list(options)]

src/pytask_latex/compilation_steps.py

@@ -12,7 +12,8 @@
 def pytask_execute_task_setup(task: PTask) -> None:
     """Check that latexmk is found on the PATH if a LaTeX task should be executed."""
     if has_mark(task, "latex") and shutil.which("latexmk") is None:
-        raise RuntimeError(
+        msg = (
             "latexmk is needed to compile LaTeX documents, but it is not found on "
             "your PATH."
         )
+        raise RuntimeError(msg)

src/pytask_latex/execute.py

@@ -1,4 +1,4 @@
-"""This module contains functions related to handling paths."""
+"""Contains functions related to handling paths."""
 from __future__ import annotations
 
 import os

src/pytask_latex/path.py

@@ -1,12 +1,16 @@
 """Entry-point for the plugin."""
 from __future__ import annotations
 
-from pluggy import PluginManager
+from typing import TYPE_CHECKING
+
 from pytask import hookimpl
 from pytask_latex import collect
 from pytask_latex import config
 from pytask_latex import execute
 
+if TYPE_CHECKING:
+    from pluggy import PluginManager
+
 
 @hookimpl
 def pytask_add_hooks(pm: PluginManager) -> None:

src/pytask_latex/plugin.py

@@ -1,4 +1,4 @@
-"""This module contains shared functions."""
+"""Contains shared functions."""
 from __future__ import annotations
 
 from typing import Any

src/pytask_latex/utils.py

@@ -21,7 +21,8 @@ def test_pytask_execute_task_setup(monkeypatch):
     """Make sure that the task setup raises errors."""
     # Act like latexmk is installed since we do not test this.
     monkeypatch.setattr(
-        "pytask_latex.execute.shutil.which", lambda x: None  # noqa: ARG005
+        "pytask_latex.execute.shutil.which",
+        lambda x: None,  # noqa: ARG005
     )
     task = Task(
         base_name="example", path=Path(), function=None, markers=[Mark("latex", (), {})]
@@ -180,7 +181,8 @@ def task_compile_document():
 
     # Hide latexmk if available.
     monkeypatch.setattr(
-        "pytask_latex.execute.shutil.which", lambda x: None  # noqa: ARG005
+        "pytask_latex.execute.shutil.which",
+        lambda x: None,  # noqa: ARG005
     )
 
     session = build(paths=tmp_path)