kynan/nbstripout

Prevent committing notebooks with errors in cell outputs

Open

#180 opened on Dec 24, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (90 forks)batch import
help wantedtype:enhancement

Repository metrics

Stars
 (1,047 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Is it possible to detect whether a cell output is an error + stack trace and let users specify one of 3 options ignore, strip or error? The first would be current behavior of doing nothing, second would remove the cell output and third would exit nbstripout non-zero so that using it as a pre-commit hook aborts commits.

My goal is to prevent accidentally releasing notebooks like this:

Screenshot 2022-12-24 at 13 08 29

Contributor guide

Research direction
Implement detection of cell output errors in Jupyter notebooks and allow user to choose ignore, strip, or error options. Modify the command line interface to accept these options, and update the pre commit hook behavior accordingly.
Tech stack
python
Domain
devtools
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70