Better utilize named path splitting in pathlib

Author: shreve

nbgrader/coursedir.py

@@ -316,24 +316,25 @@ def format_path(
         When escape=True, the non-passed elements of the path are regex-escaped, so the
         resulting string can be used as a pattern to match path components.
         """
-
         kwargs = dict(
             nbgrader_step=nbgrader_step,
             student_id=student_id,
             assignment_id=assignment_id
         )
-
-        if escape:
-            base = Path(re.escape(self.root))
-        else:
-            base = Path(self.root)
-
-        path = base / self.directory_structure.format(**kwargs)
-
+        base = Path(self.root)
+        structure = Path(self.directory_structure.format(**kwargs))
         if escape:
-            return path.anchor + re.escape(os.path.sep).join(path.parts[1:])
+            if structure.is_absolute():
+                anchor = structure.anchor
+                parts = list(structure.parts)
+            else:
+                anchor = base.anchor
+                parts = [re.escape(part) for part in base._tail] + list(structure.parts)
+            return re.escape(anchor) + re.escape(os.path.sep).join(parts)
         else:
-            return str(path)
+            if structure.is_absolute():
+                return str(structure)
+            return str(base / structure)
 
     def find_assignments(self,
         nbgrader_step: str = "*",

nbgrader/tests/test_coursedir.py

@@ -20,7 +20,11 @@ def test_coursedir_configurable(conf, course_dir):
     assert coursedir.root == course_dir
 
 
-@pytest.mark.parametrize("root", [None, os.path.sep + "[special]~root"])
+@pytest.mark.parametrize("root", [
+    None, # Keep the course_dir fixture
+    os.path.sep + "[special]~root",
+    "C:\\Users\\Student",
+])
 def test_coursedir_format_path(conf, root):
     if root is not None:
         conf.CourseDirectory.root = root

nbgrader/tests/ui-tests/formgrader.spec.ts

@@ -7,10 +7,10 @@ import { test as notebookTest } from './utils/notebook_fixtures';
 
 import { executeCommand, createEnv } from "./utils/test_utils";
 
-const testDir = process.env.NBGRADER_TEST_DIR || '';
-if (!testDir){
-  throw new Error('Test directory not provided');
+if (!process.env.NBGRADER_TEST_DIR){
+  throw new Error('environment variable NBGRADER_TEST_DIR not provided');
 }
+const testDir = fs.realpathSync(process.env.NBGRADER_TEST_DIR);
 if (!fs.existsSync(testDir)){
   throw new Error(`Test directory ${testDir} doesn't exists`);
 }

nbgrader/tests/ui-tests/utils/run_jupyter_app.py

@@ -1,32 +1,34 @@
 import sys
 import os
-from os.path import join
+from pathlib import Path
 import shutil
 import subprocess
 
 env = os.environ.copy()
-root_dir = env.get("NBGRADER_TEST_DIR", '')
+root_dir = Path(env.get("NBGRADER_TEST_DIR", '')).resolve()
+os.environ["NBGRADER_TEST_DIR"] = str(root_dir)
 
-if not env["NBGRADER_TEST_DIR"]:
+if not root_dir:
   raise Exception("Test directory not provided")
-if not os.path.isdir(env["NBGRADER_TEST_DIR"]):
+if not root_dir.is_dir():
   raise Exception(f"Test directory {env['NBGRADER_TEST_DIR']} doesn't exists")
 
 subprocess.check_call([sys.executable, "-m", "jupyter", "server", "extension", "enable", "--user", "--py", "nbgrader"], env=env)
 subprocess.check_call([sys.executable, "-m", "jupyter", "labextension", "develop", "--overwrite", "."])
 
 shutil.copyfile("./nbgrader/tests/ui-tests/files/nbgrader_config.py",
-                join(root_dir, "nbgrader_config.py"))
+                root_dir / "nbgrader_config.py")
 
 if "NBGRADER_TEST_IS_NOTEBOOK" in env.keys():
   shutil.copyfile("./nbgrader/tests/ui-tests/utils/jupyter_server_config_notebook.py",
-                join(root_dir, "jupyter_server_config_notebook.py"))
+                root_dir / "jupyter_server_config_notebook.py")
   command = ["jupyter", "notebook", "--config", "./jupyter_server_config_notebook.py"]
 else:
   shutil.copyfile("./nbgrader/tests/ui-tests/utils/jupyter_server_config.py",
-                join(root_dir, "jupyter_server_config.py"))
+                root_dir / "jupyter_server_config.py")
   command = ["jupyter", "lab", "--config", "./jupyter_server_config.py"]
 
 os.chdir(root_dir)
+os.environ["LOG_LEVEL"] = "DEBUG"
 
 subprocess.run(command)