Use pytest+jupytext for notebook testing#1838
Open
mpharrigan wants to merge 8 commits intoquantumlib:mainfrom
Open
Use pytest+jupytext for notebook testing#1838mpharrigan wants to merge 8 commits intoquantumlib:mainfrom
mpharrigan wants to merge 8 commits intoquantumlib:mainfrom
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Contributor
There was a problem hiding this comment.
Code Review
This pull request replaces the kernel-based Jupyter notebook testing with a faster in-process execution method using jupytext. It adds a verification script to ensure all committed notebooks have corresponding tests and updates numerous test files to include notebook execution checks. Feedback highlights the need for recursive path matching in the notebook discovery script and suggests improvements to the execute_notebook function to handle sys.modules isolation, working directory consistency, and IPython magics.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Collaborator
Author
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Replace the kernel-based notebook execution in
execute_notebook()with jupytext-based in-memory conversion andexec(). This avoids parallel kernel startup overhead and eliminates flaky kernel failuresChanges:
qualtran/testing.py: Rewriteexecute_notebook()to use jupytext to convert notebooks to Python scripts in memory, then execute them in a temporary directory.dev_tools/check-notebook-tests.py: New CI script that verifies every committed.ipynb(inqualtran/andtutorials/, excludingdev_tools/) has a corresponding@pytest.mark.notebooktest callingexecute_notebook(). Prints actionable error messages on failure.check/pytest-notebook: New check script that runs the coverage check thenpytest -m notebookwithMPLBACKEND=aggto prevent interactive matplotlib windows..github/workflows/pr.yaml: ThenotebooksCI job now runscheck/pytest-notebookinstead of the oldexecute-notebooks.pyscript. The docs build workflow (execute-notebooks.py,notebook_execution.py) is unchanged.pyproject.toml: Addjupytextto test dependencies.@pytest.mark.notebooktests for 61 notebooks that were missing them, plus 3 tutorial notebooks intutorials/quantum-programming/.