Skip to content
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.

Sign up for GitHub

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

Use nbconvert's preprocessor framework #650

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Use nbconvert's preprocessor framework #650

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f963a2a
Enable nbconvert config as a sphinx option.
jasongrout Jun 22, 2022
369a2c0
Use nbconvert's preprocessor infrastructure to execute the notebook.
jasongrout Jun 22, 2022
9e6eb8c
Fix pep8 warnings
jasongrout Jun 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 36 additions & 12 deletions src/nbsphinx.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,6 +749,13 @@
"""


class Writer(nbconvert.preprocessors.Preprocessor):
def preprocess(self, nb, resources):
if 'nbsphinx_save_notebook' in resources:
# Save *executed* notebook *before* the Exporter can change it:
nbformat.write(nb, resources['nbsphinx_save_notebook'])
return nb, resources

class Exporter(nbconvert.RSTExporter):
"""Convert Jupyter notebooks to reStructuredText.

Expand All @@ -761,7 +768,8 @@ class Exporter(nbconvert.RSTExporter):
"""

def __init__(self, execute='auto', kernel_name='', execute_arguments=[],
allow_errors=False, timeout=None, codecell_lexer='none'):
allow_errors=False, timeout=None, codecell_lexer='none',
nbconvert_config=None):
"""Initialize the Exporter."""

# NB: The following stateful Jinja filters are a hack until
Expand Down Expand Up @@ -795,13 +803,15 @@ def replace_attachments(text):
self._timeout = timeout
self._codecell_lexer = codecell_lexer
loader = jinja2.DictLoader({'nbsphinx-rst.tpl': RST_TEMPLATE})
super(Exporter, self).__init__(
template_file='nbsphinx-rst.tpl', extra_loaders=[loader],
config=traitlets.config.Config({
if nbconvert_config is None:
nbconvert_config = {
'HighlightMagicsPreprocessor': {'enabled': True},
# Work around https://github.com/jupyter/nbconvert/issues/720:
'RegexRemovePreprocessor': {'enabled': False},
}),
}
super(Exporter, self).__init__(
template_file='nbsphinx-rst.tpl', extra_loaders=[loader],
config=traitlets.config.Config(nbconvert_config),
filters={
'convert_pandoc': convert_pandoc,
'markdown2rst': markdown2rst,
Expand Down Expand Up @@ -842,19 +852,31 @@ def from_notebook_node(self, nb, resources=None, **kw):
not any(c.get('outputs') or c.get('execution_count')
for c in nb.cells if c.cell_type == 'code')
)
preprocessors = []
if auto_execute or execute == 'always':
allow_errors = nbsphinx_metadata.get(
'allow_errors', self._allow_errors)
timeout = nbsphinx_metadata.get('timeout', self._timeout)
pp = nbconvert.preprocessors.ExecutePreprocessor(
preprocessors.append(nbconvert.preprocessors.ExecutePreprocessor(
kernel_name=self._kernel_name,
extra_arguments=self._execute_arguments,
allow_errors=allow_errors, timeout=timeout)
nb, resources = pp.preprocess(nb, resources)

if 'nbsphinx_save_notebook' in resources:
# Save *executed* notebook *before* the Exporter can change it:
nbformat.write(nb, resources['nbsphinx_save_notebook'])
allow_errors=allow_errors, timeout=timeout))
# pp = nbconvert.preprocessors.ExecutePreprocessor(
# kernel_name=self._kernel_name,
# extra_arguments=self._execute_arguments,
# allow_errors=allow_errors, timeout=timeout)
# nb, resources = pp.preprocess(nb, resources)

# if 'nbsphinx_save_notebook' in resources:
# # Save *executed* notebook *before* the Exporter can change it:
# nbformat.write(nb, resources['nbsphinx_save_notebook'])

preprocessors.append(Writer())
# Find the existing execute preprocessor and replace it
i = next((i for i, p in enumerate(self._preprocessors)
if isinstance(p, nbconvert.preprocessors.ExecutePreprocessor)),
len(self._preprocessors))
self._preprocessors[i:i+1] = preprocessors

# Call into RSTExporter
rststr, resources = super(Exporter, self).from_notebook_node(
Expand Down Expand Up @@ -1037,6 +1059,7 @@ def parse(self, inputstring, document):
allow_errors=env.config.nbsphinx_allow_errors,
timeout=env.config.nbsphinx_timeout,
codecell_lexer=env.config.nbsphinx_codecell_lexer,
nbconvert_config=env.config.nbsphinx_nbconvert_config
)

try:
Expand Down Expand Up @@ -2316,6 +2339,7 @@ def setup(app):
app.add_config_value('nbsphinx_execute', 'auto', rebuild='env')
app.add_config_value('nbsphinx_kernel_name', '', rebuild='env')
app.add_config_value('nbsphinx_execute_arguments', [], rebuild='env')
app.add_config_value('nbsphinx_nbconvert_config', None, rebuild='env')
app.add_config_value('nbsphinx_allow_errors', False, rebuild='')
app.add_config_value('nbsphinx_timeout', None, rebuild='')
app.add_config_value('nbsphinx_codecell_lexer', 'none', rebuild='env')
Expand Down