Add command line interface with crash function

Author: Wu Jianxiao

pydra/scripts/cli.py

@@ -0,0 +1,57 @@
+from pathlib import Path
+import pdb
+import sys
+
+from IPython.core import ultratb
+import click
+import cloudpickle as cp
+
+CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
+ExistingFilePath = click.Path(exists=True, dir_okay=False, resolve_path=True)
+
+
+@click.group(context_settings=CONTEXT_SETTINGS)
+def cli():
+    pass
+
+
+@cli.command(context_settings=CONTEXT_SETTINGS)
+@click.argument("crashfile", type=ExistingFilePath)
+@click.option(
+    "-r", "--rerun", is_flag=True, flag_value=True, help="Rerun crashed code."
+)
+@click.option(
+    "-d",
+    "--debugger",
+    type=click.Choice([None, "ipython", "pdb"]),
+    help="Debugger to use when rerunning",
+)
+def crash(crashfile, rerun, debugger=None):
+    """Display a crash file and rerun if required."""
+    if crashfile.endswith(("pkl", "pklz")):
+        with open(crashfile, "rb") as f:
+            crash_content = cp.load(f)
+        print("".join(crash_content["error message"]))
+
+        if rerun:
+            jobfile = Path(crashfile).parent / "_job.pklz"
+            if jobfile.exists():
+                with open(jobfile, "rb") as f:
+                    job_obj = cp.load(f)
+
+                if debugger == "ipython":
+                    sys.excepthook = ultratb.FormattedTB(
+                        mode="Verbose", theme_name="Linux", call_pdb=True
+                    )
+
+                try:
+                    job_obj.run(rerun=True)
+                except Exception:  # noqa: E722
+                    if debugger == "pdb":
+                        pdb.post_mortem()
+                    elif debugger == "ipython":
+                        raise
+            else:
+                raise FileNotFoundError(f"Job file {jobfile} not found")
+    else:
+        raise ValueError("Only pickled crashfiles are supported")

pyproject.toml

@@ -14,6 +14,7 @@ dependencies = [
     "filelock >=3.0.0",
     "fileformats >=0.15.0a7",
     "platformdirs >=2",
+    "ipython",
 ]
 license = { file = "LICENSE" }
 authors = [{ name = "Nipype developers", email = "[email protected]" }]
@@ -43,7 +44,6 @@ doc = [
     "fileformats-medimage >= v0.10.0a2",
     "fileformats-medimage-extras >= v0.10.0a2",
     "furo>=2022.2.14.1",
-    "ipython",
     "ipykernel",
     "ipywidgets",
     "matplotlib",
@@ -114,6 +114,9 @@ documentation = "https://nipype.github.io/pydra/"
 homepage = "https://nipype.github.io/pydra/"
 repository = "https://github.com/nipype/pydra.git"
 
+[project.scripts]
+pydracli = "pydra.scripts.cli:cli"
+
 [tool.hatch.build]
 packages = ["pydra"]
 exclude = ["tests"]