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.
Prevent committing notebooks with errors in cell outputs · kynan/nbstripout#180 | Good First Issue