scripts: paths from the environment, not one disk

scripts/test_doc_references.py

@@ -0,0 +1,89 @@
+"""Every path a published doc tells you to run must itself be published.
+
+The READMEs' "Reproducing" sections named nine `scripts/*.py`. None was on the
+Hub, and when checked they carried absolute paths to one laptop. A reproduction
+section nobody but the author can run is worse than absent: it reads as a
+promise.
+
+This walks every published .md, extracts the repository paths it mentions, and
+checks each exists on the Hub. It also greps the published scripts for absolute
+paths under a user's home or a specific mount, which is the other half of the
+same failure — published but unrunnable.
+
+    python scripts/test_doc_references.py
+"""
+from __future__ import annotations
+
+import re
+import sys
+import tempfile
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).resolve().parents[1]))
+
+RESULTS: list[tuple[bool, str, str]] = []
+REPO = "yxma/React"
+PATH_RE = re.compile(
+    r"(?<![\w/])((?:scripts|toolbox|examples|data|test_sets|preprocess|docs)"
+    r"/[\w./+-]+\.(?:py|json|md|jpg|jsonl))")
+ABS_RE = re.compile(r"[\"'](/(?:home|media|Users)/[^\"']+)[\"']")
+
+
+def check(ok: bool, name: str, evidence: str) -> None:
+    RESULTS.append((bool(ok), name, evidence))
+
+
+def main() -> int:
+    from huggingface_hub import HfApi, hf_hub_download
+    api = HfApi()
+    files = set(api.list_repo_files(REPO, repo_type="dataset"))
+    d = tempfile.mkdtemp()
+
+    docs = sorted(f for f in files if f.endswith(".md"))
+    missing, seen = [], 0
+    for doc in docs:
+        text = Path(hf_hub_download(REPO, doc, repo_type="dataset",
+                                    local_dir=d)).read_text(errors="ignore")
+        for ref in sorted(set(PATH_RE.findall(text))):
+            seen += 1
+            if ref not in files:
+                missing.append(f"{doc} -> {ref}")
+    check(not missing, "every path a published doc names is published",
+          f"{len(docs)} docs, {seen} path references, all present"
+          + (f"; MISSING {missing[:4]}" if missing else ""))
+
+    # ...and the published scripts must not point at one person's disk
+    scripts = sorted(f for f in files if f.startswith("scripts/") and f.endswith(".py"))
+    hard = []
+    for s in scripts:
+        text = Path(hf_hub_download(REPO, s, repo_type="dataset",
+                                    local_dir=d)).read_text(errors="ignore")
+        for m in ABS_RE.findall(text):
+            hard.append(f"{s}: {m}")
+    check(not hard, "no published script hard-codes an absolute local path",
+          f"{len(scripts)} scripts checked, none point at a specific mount"
+          + (f"; {hard[:3]}" if hard else ""))
+
+    # ...and the path module they share is published, since they import it
+    imports_paths = []
+    for s in scripts:
+        text = Path(hf_hub_download(REPO, s, repo_type="dataset",
+                                    local_dir=d)).read_text(errors="ignore")
+        if "from react_paths import" in text:
+            imports_paths.append(s)
+    check("scripts/react_paths.py" in files and imports_paths,
+          "the shared path module ships with the scripts that import it",
+          f"{len(imports_paths)} scripts import react_paths; "
+          f"published: {'scripts/react_paths.py' in files}")
+
+    w = max(len(x) for _, x, _ in RESULTS)
+    print()
+    for ok, name, ev in RESULTS:
+        print(f"  [{'ok' if ok else 'FAIL'}] {name:<{w}}  {ev}")
+    n = sum(not x for x, _, _ in RESULTS)
+    print(f"\ndoc references: {len(RESULTS)} checks, {n} failing")
+    return 1 if n else 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())