nteract/papermill

Add the output notebook object to PapermillExecutionError

Open

#795 opened on May 3, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (402 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,381 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

🚀 Feature

Add the output notebook object to PapermillExecutionError

Motivation

When running the notebook using python, the only current way to access the output notebook on an exception is by writing the notebook to an I/O handler. If all we need to do in the application executing the notebook is to inspect the notebook (for instance for looking for data attached with a library like scrapbook), we have to write the notebook to the I/O handler, then reconstitute it after handling the exception. This is slow(er), and a bit of a challenge when all we want is the notebook object AFTER an exception.

Contributor guide

Research direction
The PapermillExecutionError class is likely defined in the papermill package. Examine the exception handling where execute notebook raises errors. The goal is to store the output notebook object (a nbformat.NotebookNode) as an attribute of the exception. Look for the execute notebook function and related classes to understand where the notebook object is available and how to attach it to the exception before raising.
Tech stack
python
Domain
databackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonPapermillJupyter notebooks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70