feat: place examples in pack directories for cli

news/ex-path.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* change examples directory structure to insert the name of the ``pack" that the examples exemplify.
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

src/diffpy/cmi/cli.py

@@ -52,27 +52,33 @@ def _installed_examples_dir() -> Path:
     )
 
 
-def list_examples() -> List[str]:
-    """List installed example names.
+def get_examples_by_pack() -> dict[str, List[str]]:
+    """Return a dictionary mapping pack name -> list of example
+    subdirectories.
 
     Returns
     -------
-    list of str
-        Installed example directory names.
+    dict:
+        pack name -> list of example subdirectory names
     """
     root = _installed_examples_dir()
     if not root.exists():
-        return []
-    return sorted([p.name for p in root.iterdir() if p.is_dir()])
+        return {}
+    examples_by_pack = {}
+    for pack_dir in sorted(root.iterdir()):
+        if pack_dir.is_dir():
+            exdirs = sorted(p.name for p in pack_dir.iterdir() if p.is_dir())
+            examples_by_pack[pack_dir.name] = exdirs
+    return examples_by_pack
 
 
-def copy_example(example: str) -> Path:
+def copy_example(pack_example: str) -> Path:
     """Copy an example into the current working directory.
 
     Parameters
     ----------
     example : str
-        Example directory name under the installed examples root.
+        Pack and example name in the form ``<pack>/<exdir>``.
 
     Returns
     -------
@@ -81,15 +87,20 @@ def copy_example(example: str) -> Path:
 
     Raises
     ------
+    ValueError
+        If the format is invalid.
     FileNotFoundError
         If the example directory does not exist.
     FileExistsError
         If the destination directory already exists.
     """
-    src = _installed_examples_dir() / example
+    if "/" not in pack_example:
+        raise ValueError("Example must be specified as <pack>/<exdir>")
+    pack, exdir = pack_example.split("/", 1)
+    src = _installed_examples_dir() / pack / exdir
     if not src.exists() or not src.is_dir():
-        raise FileNotFoundError(f"Example not found: {example}")
-    dest = Path.cwd() / example
+        raise FileNotFoundError(f"Example not found: {pack_example}")
+    dest = Path.cwd() / exdir
     if dest.exists():
         raise FileExistsError(f"Destination {dest} already exists")
     copytree(src, dest)
@@ -163,7 +174,9 @@ def _build_parser() -> argparse.ArgumentParser:
         _parser=p_example
     )
     p_example_copy = sub_ex.add_parser("copy", help="Copy an example to CWD")
-    p_example_copy.add_argument("name", metavar="EXAMPLE", help="Example name")
+    p_example_copy.add_argument(
+        "name", metavar="EXAMPLE", help="Example name <pack>/<exdir>"
+    )
     p_example_copy.set_defaults(_parser=p_example)
     p_example.set_defaults(example_cmd=None)
 
@@ -339,10 +352,11 @@ def _cmd_example(ns: argparse.Namespace) -> int:
         print(f"Example copied to: {out}")
         return 0
     if ns.example_cmd == "list":
-        for g in list_examples():
-            print(g)
+        for pack, examples in get_examples_by_pack().items():
+            print(f"{pack}:")
+            for ex in examples:
+                print(f"  - {ex}")
         return 0
-
     plog.error("Unknown example subcommand.")
     ns._parser.print_help()
     return 2

tests/test_cli.py

@@ -0,0 +1,39 @@
+import pytest
+
+from diffpy.cmi.cli import main
+
+
+def test_cli_help(capsys):
+    """Test that the CLI help message is displayed correctly."""
+    with pytest.raises(SystemExit) as exc:
+        main(["--help", "-h"])
+    assert exc.value.code == 0
+    out, _ = capsys.readouterr()
+    assert "Welcome to diffpy.cmi" in out
+
+
+def test_example_list(capsys):
+    """Test that the example listing works."""
+    rc = main(["example", "list"])
+    assert rc == 0
+    out, _ = capsys.readouterr()
+    # test specific known pack and example
+    assert "ch03NiModelling" in out
+    assert "pdf" in out
+
+
+def test_example_copy(monkeypatch, tmp_path):
+    """Test that an example can be copied to the current directory."""
+    # create a fake example
+    fake_examples = tmp_path / "docs" / "examples"
+    src = fake_examples / "pack1" / "ex1"
+    src.mkdir(parents=True)
+    monkeypatch.setattr(
+        "diffpy.cmi.cli._installed_examples_dir",
+        lambda: fake_examples,
+    )
+    cwd = tmp_path
+    monkeypatch.chdir(cwd)
+    rc = main(["example", "copy", "pack1/ex1"])
+    assert rc == 0
+    assert (cwd / "ex1").exists()