kynan/nbstripout

Prevent committing notebooks with errors in cell outputs

Open

#180 建立於 2022年12月24日

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

描述

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

貢獻者指南

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