renamed cache_dir -> cache_root

Author: tclose

docs/source/tutorial/1-getting-started.ipynb

@@ -284,7 +284,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "outputs = mrgrid(cache_dir=Path(\"~/pydra-cache\").expanduser())\n",
+    "outputs = mrgrid(cache_root=Path(\"~/pydra-cache\").expanduser())\n",
     "\n",
     "pprint(outputs)"
    ]
@@ -303,12 +303,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pydra.utils.general import default_run_cache_dir\n",
+    "from pydra.utils.general import default_run_cache_root\n",
     "\n",
-    "my_cache_dir = Path(\"~/new-pydra-cache\").expanduser()\n",
-    "my_cache_dir.mkdir(exist_ok=True)\n",
+    "my_cache_root = Path(\"~/new-pydra-cache\").expanduser()\n",
+    "my_cache_root.mkdir(exist_ok=True)\n",
     "\n",
-    "outputs = mrgrid(cache_dir=my_cache_dir, cache_locations=[default_run_cache_dir])\n",
+    "outputs = mrgrid(cache_root=my_cache_root, cache_locations=[default_run_cache_root])\n",
     "\n",
     "print(outputs)"
    ]

docs/source/tutorial/2-advanced-execution.ipynb

@@ -126,7 +126,7 @@
     "    ten_to_the_power = TenToThePower().split(p=[1, 2, 3, 4, 5])\n",
     "\n",
     "    # Run the 5 tasks in parallel split across 3 processes\n",
-    "    outputs = ten_to_the_power(worker=\"cf\", n_procs=3, cache_dir=cache_root)\n",
+    "    outputs = ten_to_the_power(worker=\"cf\", n_procs=3, cache_root=cache_root)\n",
     "\n",
     "    p1, p2, p3, p4, p5 = outputs.out\n",
     "\n",
@@ -220,7 +220,7 @@
     "    voxel=VOX_SIZES,\n",
     ")\n",
     "\n",
-    "submitter = Submitter(cache_dir=test_dir / \"cache\")\n",
+    "submitter = Submitter(cache_root=test_dir / \"cache\")\n",
     "\n",
     "\n",
     "with submitter:\n",
@@ -396,7 +396,7 @@
     "\n",
     "# Run the task to resample all NIfTI files\n",
     "outputs = mrgrid(\n",
-    "    hooks=TaskHooks(post_run=notify_task_completion), cache_dir=tempfile.mkdtemp()\n",
+    "    hooks=TaskHooks(post_run=notify_task_completion), cache_root=tempfile.mkdtemp()\n",
     ")\n",
     "\n",
     "# Print the locations of the output files\n",

docs/source/tutorial/3-troubleshooting.ipynb

@@ -152,13 +152,13 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from pydra.utils.general import default_run_cache_dir\n",
+    "from pydra.utils.general import default_run_cache_root\n",
     "import cloudpickle as cp\n",
     "from pprint import pprint\n",
     "from pydra.tasks.testing import Divide\n",
     "\n",
     "with open(\n",
-    "    default_run_cache_dir / Divide(x=15, y=0)._checksum / \"_error.pklz\", \"rb\"\n",
+    "    default_run_cache_root / Divide(x=15, y=0)._checksum / \"_error.pklz\", \"rb\"\n",
     ") as f:\n",
     "    error = cp.load(f)\n",
     "\n",
@@ -223,18 +223,18 @@
    "outputs": [],
    "source": [
     "import cloudpickle as cp\n",
-    "from pydra.utils.general import user_cache_dir\n",
+    "from pydra.utils.general import user_cache_root\n",
     "\n",
-    "run_cache = user_cache_dir / \"run-cache\"\n",
+    "run_cache = user_cache_root / \"run-cache\"\n",
     "\n",
-    "for task_cache_dir in run_cache.iterdir():\n",
-    "    with open(task_cache_dir / \"_result.pklz\", \"rb\") as f:\n",
+    "for task_cache_root in run_cache.iterdir():\n",
+    "    with open(task_cache_root / \"_result.pklz\", \"rb\") as f:\n",
     "        result = cp.load(f)\n",
     "    if result.outputs is not None:\n",
     "        for field_name in result.outputs:\n",
     "            if result.outputs[field_name] == float(\"nan\"):\n",
     "                print(\n",
-    "                    f\"Job {task_cache_dir.name!r} produced a NaN value for {field_name!r}\"\n",
+    "                    f\"Job {task_cache_root.name!r} produced a NaN value for {field_name!r}\"\n",
     "                )"
    ]
   }

docs/source/tutorial/6-workflow.ipynb

@@ -556,7 +556,7 @@
     "\n",
     "wf = ToyMedianThreshold(in_image=nifti_file)\n",
     "\n",
-    "outputs = wf(cache_dir=test_dir / \"cache\")\n",
+    "outputs = wf(cache_root=test_dir / \"cache\")\n",
     "\n",
     "print(outputs)"
    ]

pydra/compose/base/task.py

@@ -168,7 +168,7 @@ class Task(ty.Generic[OutputsType]):
     def __call__(
         self,
         /,
-        cache_dir: os.PathLike | None = None,
+        cache_root: os.PathLike | None = None,
         worker: "str | ty.Type[Worker] | Worker" = "debug",
         environment: "Environment | None" = None,
         rerun: bool = False,
@@ -183,7 +183,7 @@ def __call__(
 
         Parameters
         ----------
-        cache_dir : os.PathLike, optional
+        cache_root : os.PathLike, optional
             Cache directory where the working directory/results for the job will be
             stored, by default None
         worker : str or Worker, optional
@@ -218,7 +218,7 @@ def __call__(
         try:
             with Submitter(
                 audit_flags=audit_flags,
-                cache_dir=cache_dir,
+                cache_root=cache_root,
                 cache_locations=cache_locations,
                 messenger_args=messenger_args,
                 messengers=messengers,