kynan/nbstripout

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

Open

#167 建立於 2022年8月19日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)Python (1,047 star) (90 fork)batch import
help wantedtype:enhancement

描述

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).

貢獻者指南

技術棧
pythonshell
領域
toolingdeveloper experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Python basicsfamiliarity with command line flags
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.