-
Notifications
You must be signed in to change notification settings - Fork 1.1k
ci(run-notebook): replace whole-cell bash partition with nbclient #573
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+78
−137
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| #!/usr/bin/env python | ||
| """Execute a notebook end-to-end against a real Jupyter kernel. | ||
|
|
||
| Replaces the cell-partitioning approach in convert-notebook.py with a | ||
| straight nbclient drive. This means: | ||
|
|
||
| - !pip install and other shell magics run via the kernel's normal magic | ||
| handling (the kernel spawns a subshell), exactly as in Colab/Jupyter Lab. | ||
| - A code cell may freely mix `!pip install` and Python imports. | ||
| - Errors surface with cell and traceback context, not as | ||
| `line N: import: command not found`. | ||
|
|
||
| Notebook deps are installed into the same Python environment as the | ||
| runner (the kernel and runner share an interpreter), so `!pip install foo` | ||
| in cell 1 means cell 2 can `import foo`. | ||
|
|
||
| Usage: | ||
| run-notebook.py <notebook-path> | ||
|
|
||
| Exits non-zero on any cell failure. | ||
| """ | ||
|
|
||
| import os | ||
| import sys | ||
|
|
||
| import nbformat | ||
| from nbclient import NotebookClient | ||
| from nbclient.exceptions import CellExecutionError, CellTimeoutError, DeadKernelError | ||
|
|
||
| CELL_TIMEOUT = int(os.environ.get("NOTEBOOK_CELL_TIMEOUT", "600")) | ||
|
|
||
|
|
||
| def main() -> int: | ||
| if len(sys.argv) != 2: | ||
| print("usage: run-notebook.py <notebook-path>", file=sys.stderr) | ||
| return 2 | ||
|
|
||
| notebook_path = sys.argv[1] | ||
| print(f"Executing {notebook_path}") | ||
|
|
||
| nb = nbformat.read(notebook_path, as_version=4) | ||
| client = NotebookClient( | ||
| nb, | ||
| timeout=CELL_TIMEOUT, | ||
| kernel_name="python3", | ||
| resources={"metadata": {"path": os.path.dirname(notebook_path) or "."}}, | ||
| ) | ||
|
|
||
| try: | ||
| client.execute() | ||
| except CellTimeoutError as exc: | ||
| print( | ||
| f"\nCell exceeded timeout of {CELL_TIMEOUT}s " | ||
| f"(override via NOTEBOOK_CELL_TIMEOUT):\n{exc}", | ||
| file=sys.stderr, | ||
| ) | ||
| return 1 | ||
| except DeadKernelError as exc: | ||
| print( | ||
| f"\nKernel died during execution (OOM/segfault?):\n{exc}", file=sys.stderr | ||
| ) | ||
| return 1 | ||
| except CellExecutionError as exc: | ||
| print(f"\nCell execution failed:\n{exc}", file=sys.stderr) | ||
| return 1 | ||
|
|
||
| print(f"PASS — {notebook_path}") | ||
| return 0 | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| sys.exit(main()) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.