nteract/papermill

Option to raise exception when unknown parameter passed.

Open

#818 opened on May 6, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (402 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,381 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

🚀 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

Contributor guide

Research direction
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`.
Tech stack
python
Domain
backendtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python basicsUnderstanding of papermill parameters
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85