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.
Option to error on cell outputs exceeding `--max-size` · kynan/nbstripout#167 | Good First Issue