pydoit_nb.notebook_run

Notebook running

NotebookExecutionException

class NotebookExecutionException(exc, filename)

Bases: Exception

Raised when a notebook fails to execute for any reason

rewrite_notebook_default

rewrite_notebook_default(raw_notebook, unexecuted_notebook, fmt='ipynb')

Re-write notebooks from raw to unexecuted

This is our default implementation to use in run_notebook().

Parameters:

• raw_notebook (pathlib.Path) – Path from which to read the raw notebook

• unexecuted_notebook (pathlib.Path) – Path in which to write the unexecuted notebook

• fmt (str) – Format in which to write the unexecuted notebook

Return type:

None

run_notebook

run_notebook(raw_notebook, unexecuted_notebook, executed_notebook, notebook_parameters=None, notebook_rewriter=None, notebook_executor=None)

Run a notebook

This loads the notebook raw_notebook using jupytext, then writes it as an .ipynb file to unexecuted_notebook. It then runs this unexecuted notebook with papermill, writing it to executed_notebook.

Parameters:

• raw_notebook (pathlib.Path) – Notebook from which to start

• unexecuted_notebook (pathlib.Path) – Where to write the unexecuted notebook

• executed_notebook (pathlib.Path) – Where to write the executed notebook

• notebook_parameters (typing.Optional[dict[str, str]]) –

  Parameters to pass to the target notebook

  These parameters will replace the contents of a cell tagged “parameters”. See the papermill documentation for more information about parameterizing a notebook.

• notebook_rewriter (typing.Optional[typing.Callable[[pathlib.Path, pathlib.Path], None]]) – Function to use to re-write the raw notebooks as unexecuted notebooks that can be executed by notebook_executor. We use jupytext for this (specifically rewrite_notebook_default()) by default and you shouldn’t need to change this.

• notebook_executor (typing.Optional[typing.Callable[[pathlib.Path, pathlib.Path, dict[str, typing.Any]], typing.Any]]) – Function to use to execute the notebooks. We use papermill.execute_notebook for this by default and you shouldn’t need to change this.

Return type:

None