65 lines
2.5 KiB
Python
65 lines
2.5 KiB
Python
"""Simple Wrapper around nbstripout to strip notebooks in a directory."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
import logging
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
from concurrent.futures import ThreadPoolExecutor
|
|
from pathlib import Path
|
|
|
|
from gitignore_parser import parse_gitignore
|
|
from rich.progress import track
|
|
|
|
|
|
def _strip_notebook(notebook_path: Path, extra_args: list[str]) -> bool:
|
|
"""Strip output from a single Jupyter notebook."""
|
|
logging.debug(["nbstripout", str(notebook_path), *extra_args])
|
|
result = subprocess.run(["nbstripout", str(notebook_path), *extra_args])
|
|
return result.returncode == 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
parser = argparse.ArgumentParser(description="Strip output from Jupyter notebooks.")
|
|
parser.add_argument("--directories", nargs="+", help="Directories to strip notebooks in")
|
|
args, unknown_args = parser.parse_known_args()
|
|
# Strip separator if present
|
|
if "--" in unknown_args:
|
|
unknown_args.remove("--")
|
|
|
|
# Find all Jupyter notebooks in the directories
|
|
notebook_dirs = [Path(d).rglob("*.ipynb") for d in args.directories]
|
|
should_ignore = parse_gitignore(".gitignore") # TODO(#6730): parse all .gitignore files, not just top-level
|
|
|
|
futures = []
|
|
cpu_count = 4
|
|
if (total_cores := os.cpu_count()) is not None:
|
|
cpu_count = total_cores - 2
|
|
print(f"Using {cpu_count} threads to strip notebooks.")
|
|
with ThreadPoolExecutor(max_workers=cpu_count) as executor:
|
|
for notebook_dir in notebook_dirs:
|
|
# print(f"Stripping notebooks in directory: {list(notebook_dir)}")
|
|
for notebook in list(notebook_dir):
|
|
if should_ignore(notebook):
|
|
logging.debug(f"Skipping ignored notebook: {notebook}")
|
|
continue
|
|
futures.append(executor.submit(_strip_notebook, notebook, unknown_args))
|
|
failure_count = 0
|
|
for future in track(futures, description="Stripping notebooks…"):
|
|
if not future.result():
|
|
failure_count += 1
|
|
|
|
strip_or_check = "checked" if any("verify" in arg for arg in unknown_args) else "stripped"
|
|
success_message = f"Notebooks successfully {strip_or_check}."
|
|
footer = ""
|
|
if any("verify" in arg for arg in unknown_args) and failure_count > 0:
|
|
footer = " Please run `pixi run nb-strip` to resolve."
|
|
if failure_count == 0:
|
|
print(success_message)
|
|
sys.exit(0)
|
|
else:
|
|
print(f"Notebooks {strip_or_check} with {failure_count} failures.{footer}")
|
|
sys.exit(1)
|