Use pytest+jupytext for notebook testing - #1838
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
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>
|
@mpharrigan I'd like to review this, but it's a bit behind the main branch at this point. Would you be willing to update it sometime, and indicate when it's ready for review? (Maybe it could be converted back to a draft PR in the meantime.) |
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/.