Add .gitignore to .pytask to avoid committing it. (#646)

Author: tobiasraabe

.python-version

@@ -1 +1 @@
-3.12.2
+3.12.3

docs/source/changes.md

@@ -8,6 +8,8 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
 ## 0.5.2 - 2024-09-15
 
 - {pull}`640` stops the live display when an exception happened during the execution.
+- {pull}`646` adds a `.gitignore` to the `.pytask/` folder to exclude it from version
+  control.
 
 ## 0.5.1 - 2024-07-20
 

src/_pytask/clean.py

@@ -6,7 +6,6 @@
 import itertools
 import shutil
 import sys
-from pathlib import Path
 from typing import TYPE_CHECKING
 from typing import Any
 from typing import Generator
@@ -36,6 +35,7 @@
 from _pytask.tree_util import tree_leaves
 
 if TYPE_CHECKING:
+    from pathlib import Path
     from typing import NoReturn
 
 
@@ -64,7 +64,12 @@ def pytask_extend_command_line_interface(cli: click.Group) -> None:
 @hookimpl
 def pytask_parse_config(config: dict[str, Any]) -> None:
     """Parse the configuration."""
-    config["exclude"] = to_list(config["exclude"]) + _DEFAULT_EXCLUDE
+    config["exclude"] = (
+        to_list(config["exclude"])
+        + _DEFAULT_EXCLUDE
+        # Adding the cache folder to the exclude list.
+        + [config["root"].joinpath(".pytask", "*").as_posix()]
+    )
 
 
 @click.command(cls=ColoredCommand)
@@ -116,10 +121,9 @@ def clean(**raw_config: Any) -> NoReturn:  # noqa: C901, PLR0912
             session.hook.pytask_collect(session=session)
 
             known_paths = _collect_all_paths_known_to_pytask(session)
-            exclude = session.config["exclude"]
             include_directories = session.config["directories"]
             unknown_paths = _find_all_unknown_paths(
-                session, known_paths, exclude, include_directories
+                session, known_paths, session.config["exclude"], include_directories
             )
             common_ancestor = find_common_ancestor(
                 *unknown_paths, *session.config["paths"]
@@ -189,10 +193,6 @@ def _collect_all_paths_known_to_pytask(session: Session) -> set[Path]:
         known_paths.add(session.config["config"])
     known_paths.add(session.config["root"])
 
-    database_url = session.config["database_url"]
-    if database_url.drivername == "sqlite" and database_url.database:
-        known_paths.add(Path(database_url.database))
-
     # Add files tracked by git.
     if is_git_installed():
         git_root = get_root(session.config["root"])

src/_pytask/config.py

@@ -79,6 +79,12 @@ def pytask_parse_config(config: dict[str, Any]) -> None:
     """Parse the configuration."""
     config["root"].joinpath(".pytask").mkdir(exist_ok=True, parents=True)
 
+    # Ensure a .gitignore file exists in the .pytask directory to avoid accidentally
+    # committing the cache.
+    gitignore_path = config["root"].joinpath(".pytask", ".gitignore")
+    if not gitignore_path.exists():
+        gitignore_path.write_text("# Automatically added by pytask.\n*\n")
+
     config["paths"] = parse_paths(config["paths"])
 
     config["markers"] = {

tests/test_config.py

@@ -123,3 +123,11 @@ def test_paths_are_relative_to_configuration_file(tmp_path):
     result = run_in_subprocess(("python", "script.py"), cwd=tmp_path)
     assert result.exit_code == ExitCode.OK
     assert "1  Succeeded" in result.stdout
+
+
+@pytest.mark.end_to_end
+def test_create_gitignore_file_in_pytask_directory(tmp_path):
+    session = build(paths=tmp_path)
+
+    assert session.exit_code == ExitCode.OK
+    assert tmp_path.joinpath(".pytask", ".gitignore").exists()