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 (1,047 stars) (90 forks)batch import
help wantedtype:enhancement

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

Tech stack
python
Domain
toolingci cd
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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
PythonJupyter notebooksbasic knowledge of nbstripout
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the main source file (e.g., nbstripout.py) to understand how cell outputs are currently stripped. Look for existing functions that process notebook JSON and identify where error outputs (like stack traces) could be detected. Review the existing pre commit hook configuration to understand how options are passed. Check the issue comments for any suggestions about implementation details or desired behavior.