Fix validate_from_path.

Author: JoeZiminski

datashuttle/configs/canonical_folders.py

@@ -82,6 +82,11 @@ def get_datashuttle_path() -> Path:
     return Path.home() / ".datashuttle"
 
 
+def get_internal_datashuttle_from_path():
+    """Get a placeholder path for `validate_project_from_path()`."""
+    return get_datashuttle_path() / "_datashuttle_from_path"
+
+
 def get_project_datashuttle_path(project_name: str) -> Tuple[Path, Path]:
     """Return the datashuttle config path for the project.
 

datashuttle/datashuttle_functions.py

@@ -13,9 +13,7 @@
     Optional,
 )
 
-from datashuttle.configs import (
-    canonical_configs,
-)
+from datashuttle.configs import canonical_configs, canonical_folders
 from datashuttle.configs.config_class import Configs
 from datashuttle.utils import (
     validation,
@@ -85,14 +83,16 @@ def validate_project_from_path(
 
     # Create some mock configs for the validation call,
     # then for each top-level folder, run the validation
+    # Note `get_internal_datashuttle_from_path` generates a placeholder
+    # folder path but this is not actually created.
     placeholder_configs = {
         key: None for key in canonical_configs.get_canonical_configs().keys()
     }
     placeholder_configs["local_path"] = Path(project_path)  # type: ignore
 
     cfg = Configs(
         project_name=project_path.name,
-        file_path=None,  # type: ignore
+        file_path=canonical_folders.get_internal_datashuttle_from_path(),  # type: ignore
         input_dict=placeholder_configs,
     )
 

tests/tests_integration/test_validation.py

@@ -5,6 +5,7 @@
 import pytest
 
 from datashuttle import validate_project_from_path
+from datashuttle.configs import canonical_folders
 from datashuttle.utils import formatting, validation
 from datashuttle.utils.custom_exceptions import NeuroBlueprintError
 
@@ -787,7 +788,7 @@ def test_name_templates_validate_project(self, project):
     # Test Quick Validation Function
     # ----------------------------------------------------------------------------------
 
-    def test_quick_validation(self, mocker, project):
+    def test_validate_project_from_path(self, mocker, project):
         project.create_folders("rawdata", "sub-1")
         os.makedirs(project.cfg["local_path"] / "rawdata" / "sub-02")
         project.create_folders("derivatives", "sub-1")
@@ -803,6 +804,12 @@ def test_quick_validation(self, mocker, project):
         assert "VALUE_LENGTH" in str(w[1].message)
         assert len(w) == 2
 
+        # This is used internally to generate a Configs class,
+        # but should not actually be written to.
+        assert (
+            not canonical_folders.get_internal_datashuttle_from_path().exists()
+        )
+
         # For good measure, monkeypatch and change all defaults,
         # ensuring they are propagated to the validate_project
         # function (which is tested above)
@@ -824,7 +831,7 @@ def test_quick_validation(self, mocker, project):
         assert kwargs["top_level_folder_list"] == ["derivatives"]
         assert kwargs["name_templates"] == {"on": False}
 
-    def test_quick_validation_top_level_folder(self, project):
+    def test_validate_from_path_top_level_folder(self, project):
         """Test that errors are raised as expected on
         bad project path input.
         """