nteract/papermill

Option to raise exception when unknown parameter passed.

Open

#818 创建于 2025年5月6日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Python (5,381 star) (402 fork)batch import
enhancementhelp wanted

描述

🚀 Feature

Motivation

I'm using papermill to run multiple notebooks. I have a generic .py script with which I pass in the notebook path and the parameter changes which I wish to make. However, in doing so, sometimes, I inadvertently pass parameters not meant for the notebook. I think it would be nice if there was an option to raise an exception if an unknown parameter was passed. I did not spend too much time looking into the code, but I think one just needs to change https://github.com/nteract/papermill/blob/53847310586b74fdb2763fe333ab99babee367ed/papermill/execute.py#L97

贡献者指南

技术栈
python
领域
backendtooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python basicsUnderstanding of papermill parameters
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
Look at the papermill/execute.py file, specifically line 97, where parameters are processed. The current code likely passes all parameters to the notebook without validation. To implement the feature, add an optional argument (e.g., `raise on unknown`) to the execution function. Then, after parsing the provided parameters, check if any key is not in the expected parameters list and raise a `PapermillException` if `raise on unknown` is True. Ensure backward compatibility by defaulting to `False`.