Move .pytask.sqlite3 to .pytask/. (#470)

Author: tobiasraabe

.gitignore

@@ -14,7 +14,6 @@ _generated
 *.egg-info
 .eggs
 
-.pytask.sqlite3
 .pytask
 
 build

docs/source/changes.md

@@ -20,6 +20,7 @@ releases are available on [PyPI](https://pypi.org/project/pytask) and
 - {pull}`464` improves pinned dependencies.
 - {pull}`465` adds test to ensure internal tracebacks are removed by reports.
 - {pull}`466` implements hashing for files instead of modification timestamps.
+- {pull}`470` moves `.pytask.sqlite3` to `.pytask`.
 - {pull}`472` adds `is_product` to {meth}`PNode.load`.
 
 ## 0.4.1 - 2023-10-11

docs/source/how_to_guides/bp_scaling_tasks.md

@@ -42,7 +42,8 @@ my_project
 │
 ├───setup.py
 │
-├───.pytask.sqlite3
+├───.pytask
+│   └────...
 │
 └───bld
 ```

docs/source/how_to_guides/functional_interface.ipynb

@@ -46,12 +46,12 @@ are welcome to also support macOS.
 
 pytask uses a database to keep track of tasks, products, and dependencies over runs. By
 default, it will create an SQLite database in the project's root directory called
-`.pytask.sqlite3`. If you want to use a different name or a different dialect
+`.pytask/pytask.sqlite3`. If you want to use a different name or a different dialect
 [supported by sqlalchemy](https://docs.sqlalchemy.org/en/latest/core/engines.html#backend-specific-urls),
 use either {option}`pytask build --database-url` or `database_url` in the config.
 
 ```toml
-database_url = "sqlite:///.pytask.sqlite3"
+database_url = "sqlite:///.pytask/pytask.sqlite3"
 ```
 
 Relative paths for SQLite databases are interpreted as either relative to the

docs/source/reference_guides/configuration.md

@@ -4,7 +4,7 @@ pytask can be configured via the command-line interface or permanently with a
 `pyproject.toml` file.
 
 The file also indicates the root of your project where pytask stores information in a
-`.pytask.sqlite3` database.
+`.pytask` folder.
 
 ## The configuration file
 

docs/source/tutorials/configuration.md

@@ -33,7 +33,8 @@ my_project
 │
 ├───setup.py
 │
-├───.pytask.sqlite3
+├───.pytask
+│   └────...
 │
 └───bld
     ├────data.pkl

docs/source/tutorials/defining_dependencies_products.md

@@ -24,7 +24,8 @@ my_project
 │
 ├───pyproject.toml
 │
-├───.pytask.sqlite3
+├───.pytask
+│   └────...
 │
 └───bld
     └────...
@@ -42,8 +43,8 @@ paths = "src/my_project"
 
 You do not have to add configuration values, but you need the
 `[tool.pytask.ini_options]` header. The header alone will signal pytask that this is the
-project's root. pytask will store the information it needs across executions in a
-`.pytask.sqlite3` database next to the configuration file.
+project's root. pytask will store the information it needs across executions in the
+`.pytask` folder.
 
 `paths` allows you to set the location of tasks when you do not pass them explicitly via
 the CLI.

docs/source/tutorials/set_up_a_project.md

@@ -21,7 +21,6 @@ The project structure is the same as in the previous example with the exception
 
 ```text
 my_project
-├───.pytask
 │
 ├───pyproject.toml
 │
@@ -33,7 +32,8 @@ my_project
 │
 ├───setup.py
 │
-├───.pytask.sqlite3
+├───.pytask
+│   └────...
 │
 └───bld
     └────plot.png
@@ -166,7 +166,6 @@ Let's add `file.csv` to the data catalog.
 
 ```text
 my_project
-├───.pytask
 │
 ├───pyproject.toml
 │
@@ -179,7 +178,8 @@ my_project
 │
 ├───setup.py
 │
-├───.pytask.sqlite3
+├───.pytask
+│   └────...
 │
 └───bld
     ├────file.pkl

docs/source/tutorials/using_a_data_catalog.md

@@ -12,6 +12,7 @@ automatically discovers them.
 
 ```text
 my_project
+│
 ├───pyproject.toml
 │
 ├───src
@@ -21,7 +22,8 @@ my_project
 │
 ├───setup.py
 │
-├───.pytask.sqlite3
+├───.pytask
+│   └────...
 │
 └───bld
     └────data.pkl

docs/source/tutorials/write_a_task.md

@@ -3,6 +3,7 @@
 
 import json
 import sys
+from contextlib import suppress
 from pathlib import Path
 from typing import Any
 from typing import Callable
@@ -45,22 +46,19 @@ def pytask_extend_command_line_interface(cli: click.Group) -> None:
 @hookimpl
 def pytask_post_parse(config: dict[str, Any]) -> None:
     """Fill cache of file hashes with stored hashes."""
-    try:
+    with suppress(Exception):
         path = config["root"] / ".pytask" / "file_hashes.json"
         cache = json.loads(path.read_text())
-    except Exception:  # noqa: BLE001
-        cache = {}
 
-    for key, value in cache.items():
-        HashPathCache.add(key, value)
+        for key, value in cache.items():
+            HashPathCache.add(key, value)
 
 
 @hookimpl
 def pytask_unconfigure(session: Session) -> None:
     """Save calculated file hashes to file."""
-    path = session.config["root"] / ".pytask"
-    path.mkdir(exist_ok=True, parents=True)
-    path.joinpath("file_hashes.json").write_text(json.dumps(HashPathCache._cache))
+    path = session.config["root"] / ".pytask" / "file_hashes.json"
+    path.write_text(json.dumps(HashPathCache._cache))
 
 
 def build(  # noqa: C901, PLR0912, PLR0913

src/_pytask/build.py

@@ -68,7 +68,6 @@ def pytask_configure(
     config["markers"] = parse_markers(config["markers"])
 
     pm.hook.pytask_parse_config(config=config)
-
     pm.hook.pytask_post_parse(config=config)
 
     return config
@@ -77,6 +76,8 @@ def pytask_configure(
 @hookimpl
 def pytask_parse_config(config: dict[str, Any]) -> None:
     """Parse the configuration."""
+    config["root"].joinpath(".pytask").mkdir(exist_ok=True, parents=True)
+
     config["paths"] = parse_paths(config["paths"])
 
     config["markers"] = {

src/_pytask/config.py

@@ -15,7 +15,7 @@ def pytask_parse_config(config: dict[str, Any]) -> None:
     # Set default.
     if not config["database_url"]:
         config["database_url"] = make_url(
-            f"sqlite:///{config['root'].as_posix()}/.pytask.sqlite3"
+            f"sqlite:///{config['root'].joinpath('.pytask').as_posix()}/pytask.sqlite3"
         )
 
     if (

src/_pytask/database.py

@@ -91,7 +91,7 @@ def _database_url_callback(
     type=str,
     help=("Url to the database."),
     default=None,
-    show_default="sqlite:///.../.pytask.sqlite3",
+    show_default="sqlite:///.../.pytask/pytask.sqlite3",
     callback=_database_url_callback,
 )
 

src/_pytask/parameters.py

@@ -94,7 +94,7 @@ def test_clean_database_ignored(project, runner):
     text_without_linebreaks = result.output.replace("\n", "")
     assert "to_be_deleted_file_1.txt" in text_without_linebreaks
     assert "to_be_deleted_file_2.txt" in text_without_linebreaks
-    assert ".pytask.sqlite3" not in text_without_linebreaks
+    assert "pytask.sqlite3" not in text_without_linebreaks
 
 
 @pytest.mark.end_to_end()

tests/test_clean.py

@@ -33,7 +33,9 @@ def task_write(depends_on, produces):
     assert result.exit_code == ExitCode.OK
 
     create_database(
-        make_url("sqlite:///" + tmp_path.joinpath(".pytask.sqlite3").as_posix())
+        make_url(
+            "sqlite:///" + tmp_path.joinpath(".pytask", "pytask.sqlite3").as_posix()
+        )
     )
 
     with DatabaseSession() as session:

tests/test_database.py

@@ -67,7 +67,9 @@ def task_dummy(depends_on, produces):
     assert session.execution_reports[0].outcome == TaskOutcome.PERSISTENCE
     assert isinstance(session.execution_reports[0].exc_info[1], Persisted)
 
-    create_database("sqlite:///" + tmp_path.joinpath(".pytask.sqlite3").as_posix())
+    create_database(
+        "sqlite:///" + tmp_path.joinpath(".pytask", "pytask.sqlite3").as_posix()
+    )
 
     with DatabaseSession() as session:
         task_id = tmp_path.joinpath("task_module.py").as_posix() + "::task_dummy"

tests/test_persist.py

@@ -30,7 +30,9 @@ def task_example(): time.sleep(2)
     duration = task.attributes["duration"]
     assert duration[1] - duration[0] > 2
 
-    create_database("sqlite:///" + tmp_path.joinpath(".pytask.sqlite3").as_posix())
+    create_database(
+        "sqlite:///" + tmp_path.joinpath(".pytask", "pytask.sqlite3").as_posix()
+    )
 
     with DatabaseSession() as session:
         task_name = tmp_path.joinpath("task_example.py").as_posix() + "::task_example"