kynan/nbstripout

Option to error on cell outputs exceeding `--max-size`

Open

#167 opened on Aug 19, 2022

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (1,047 stars) (90 forks)batch import
help wantedtype:enhancement

Description

The --max-size flag added in #135 is a great addition! 👍

When using nbstripout as commit hook, it would be nice to have a slightly safer mode that doesn't auto-remove output exceeding the max size but rather raises an error to abort the commit and let the developer handle it on a case by case basis (maybe compress rather than remove the cell output).

Contributor guide

Tech stack
pythonshell
Domain
toolingdeveloper experience
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Python basicsfamiliarity with command line flags
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the implementation of the ` max size` flag in the nbstripout source code (likely in `nbstripout/ init .py` or similar). The current behavior auto removes output exceeding the size. To implement the feature, add a new flag such as ` error on exceed` that changes the action to raising an error instead of stripping. Ensure the error is non zero to abort git commits when used as a hook. Consult existing tests and comments in the issue for desired behavior.