-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Added a notebook conversion class.
- Loading branch information
Showing
4 changed files
with
556 additions
and
92 deletions.
There are no files selected for viewing
This file contains 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 contains 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,174 @@ | ||
| import os | ||
| import pytest | ||
| import nbformat | ||
| from nbformat.v4 import new_notebook, new_markdown_cell, new_code_cell, new_output | ||
| from xdufacool.converters import NotebookConverter | ||
|
|
||
| # Define metadata as a global variable | ||
| global_metadata = { | ||
| "kernelspec": { | ||
| "display_name": "Python 3", | ||
| "language": "python", | ||
| "name": "python3" | ||
| }, | ||
| "language_info": { | ||
| "codemirror_mode": { | ||
| "name": "ipython", | ||
| "version": 3 | ||
| }, | ||
| "file_extension": ".py", | ||
| "mimetype": "text/x-python", | ||
| "name": "python", | ||
| "nbconvert_exporter": "python", | ||
| "pygments_lexer": "ipython3", | ||
| "version": "3.12.2" | ||
| } | ||
| } | ||
|
|
||
| @pytest.fixture | ||
| def setup_test_environment(tmp_path): | ||
| """ | ||
| Fixture to set up the test environment: | ||
| - Creates a temporary directory for test files. | ||
| - Creates a sample .ipynb notebook for testing. | ||
| - Creates a dummy figure file. | ||
| """ | ||
| test_dir = tmp_path / "test_files" | ||
| notebook_file = test_dir / "test_notebook.ipynb" | ||
| output_dir = test_dir / "output" | ||
| figure_file = test_dir / "figure1.png" | ||
| test_dir.mkdir() | ||
| output_dir.mkdir() | ||
|
|
||
| # Create a sample notebook with various cell types | ||
| nb = new_notebook() | ||
| nb.cells.append(new_markdown_cell("# Test Notebook\nThis is a test notebook.")) | ||
|
|
||
| # Markdown cell referencing the external figure | ||
| nb.cells.append(new_markdown_cell("")) | ||
|
|
||
| nb.cells.append(new_code_cell("print('Hello, world!')", execution_count=1, outputs=[ | ||
| new_output("stream", name="stdout", text="Hello, world!\n") | ||
| ])) | ||
| nb.cells.append(new_code_cell("# This cell should be removed", execution_count=2, metadata={"tags": ["remove_cell"]}, outputs=[])) | ||
| nb.cells.append(new_code_cell("from IPython.display import Image\nImage(filename='figure1.png')", execution_count=3, outputs=[ | ||
| new_output("display_data", data={ | ||
| "image/png": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=" # Placeholder for a 1x1 black pixel | ||
| }, metadata={}) | ||
| ])) | ||
| nb.metadata = global_metadata | ||
|
|
||
| with open(notebook_file, "w", encoding="utf-8") as f: | ||
| nbformat.write(nb, f) | ||
|
|
||
| with open(figure_file, "wb") as f: | ||
| f.write(b"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=") | ||
|
|
||
| return test_dir, notebook_file, output_dir, figure_file | ||
|
|
||
| def test_convert_notebook(setup_test_environment): | ||
| """ | ||
| Test the convert_notebook method: | ||
| - Converts the sample notebook to LaTeX. | ||
| - Checks if the output .tex file and figures directory are created. | ||
| - Checks if the figure is copied to the output directory. | ||
| - Performs basic checks on the content of the .tex file. | ||
| """ | ||
| test_dir, notebook_file, output_dir, figure_file = setup_test_environment | ||
| print(notebook_file, output_dir) | ||
|
|
||
| converter = NotebookConverter() | ||
| tex_file = converter.convert_notebook(str(notebook_file), str(output_dir), ["figure1.png"]) | ||
|
|
||
| # Check if the .tex file is created | ||
| assert os.path.exists(tex_file) | ||
|
|
||
| # Check if the figures directory is created and contains the figure | ||
| figures_dir = output_dir / "figures" | ||
| assert os.path.exists(figures_dir) | ||
| assert os.path.exists(output_dir / "figure1.png") | ||
|
|
||
| # Check the content of the .tex file (basic checks) | ||
| with open(tex_file, "r", encoding="utf-8") as f: | ||
| tex_content = f.read() | ||
| assert "Test Notebook" in tex_content # Check for title | ||
| assert "Hello, world!" in tex_content # Check for code output | ||
| assert "# This cell should be removed" not in tex_content # Check for removed cell | ||
| assert "\\includegraphics{figure1.png}" in tex_content # Check for figure inclusion | ||
|
|
||
| def test_convert_notebook_exclude_input_output(setup_test_environment): | ||
| """ | ||
| Test the convert_notebook method with input and output cells excluded: | ||
| - Converts the notebook with exclude_input=True and exclude_output=True. | ||
| - Checks if the output .tex file excludes input and output cells. | ||
| """ | ||
| test_dir, notebook_file, output_dir, figure_file = setup_test_environment | ||
| converter = NotebookConverter(exclude_input=True, exclude_output=True) | ||
| tex_file = converter.convert_notebook(str(notebook_file), str(output_dir), []) | ||
|
|
||
| # Check if the .tex file is created | ||
| assert os.path.exists(tex_file) | ||
|
|
||
| # Check the content of the .tex file | ||
| with open(tex_file, "r", encoding="utf-8") as f: | ||
| tex_content = f.read() | ||
| assert "print('Hello, world!')" not in tex_content # Check for excluded input cell | ||
| assert "Hello, world!" not in tex_content # Check for excluded output | ||
|
|
||
| def test_ensure_figures_available(tmp_path): | ||
| """ | ||
| Test the ensure_figures_available function: | ||
| - Creates a dummy figure in the assignment directory. | ||
| - Calls ensure_figures_available to copy the figure to the output directory. | ||
| - Checks if the figure is copied successfully. | ||
| """ | ||
| assignment_dir = tmp_path / "assignment" | ||
| output_dir = tmp_path / "output" | ||
| assignment_dir.mkdir() | ||
| output_dir.mkdir() | ||
| figure_file = assignment_dir / "figure2.png" | ||
|
|
||
| with open(figure_file, "wb") as f: | ||
| f.write(b"Dummy figure content") # Create a dummy figure | ||
|
|
||
| converter = NotebookConverter() | ||
| converter._ensure_figures_available(str(assignment_dir), str(output_dir), ["figure2.png"]) | ||
| assert os.path.exists(os.path.join(str(output_dir), "figure2.png")) | ||
|
|
||
| def test_convert_notebook_long_output(setup_test_environment): | ||
| """ | ||
| Test the convert_notebook method with long output: | ||
| - Create a sample notebook with long output. | ||
| - Converts the sample notebook to LaTeX. | ||
| - Checks if the output .tex file are truncated. | ||
| """ | ||
| test_dir, notebook_file, output_dir, figure_file = setup_test_environment | ||
| nb = new_notebook() | ||
|
|
||
| long_output_lines = ['Line {}\n'.format(i) for i in range(100)] | ||
| long_output_text = ''.join(long_output_lines) | ||
|
|
||
| nb.cells.append(new_code_cell("print('Long output:')\nfor i in range(100):\n print('Line {}'.format(i))", | ||
| execution_count=3, | ||
| outputs=[new_output("stream", name="stdout", text=long_output_text)])) | ||
|
|
||
| nb.metadata = global_metadata | ||
|
|
||
| with open(notebook_file, "w", encoding="utf-8") as f: | ||
| nbformat.write(nb, f) | ||
|
|
||
| converter = NotebookConverter(max_output_lines=32) | ||
| tex_file = converter.convert_notebook(str(notebook_file), str(output_dir), []) | ||
| assert os.path.exists(tex_file) | ||
| # Check the content of the .tex file (basic checks) | ||
| with open(tex_file, "r", encoding="utf-8") as f: | ||
| tex_content = f.read() | ||
| # Check that the long output is truncated | ||
| assert "Line 0" in tex_content | ||
| assert "Line 1" in tex_content | ||
| assert "Line 15" in tex_content | ||
| assert "Line 16" not in tex_content | ||
| assert " (output truncated) " in tex_content | ||
| assert "Line 83" not in tex_content | ||
| assert "Line 84" in tex_content | ||
| assert "Line 99" in tex_content |
This file contains 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
Oops, something went wrong.