Add strict unknown-parameter validation mode to notebook execution

[huyhoang171106]

Summary

Extend execute_notebook(...) with a new boolean argument (default False) that controls behavior when user-supplied parameters are not declared in the notebook’s parameters cell. Today papermill warns for unknown keys; this change should preserve that default but allow strict failure when requested.

Files changed

• papermill/execute.py (modified)
• papermill/cli.py (modified)
• papermill/tests/test_cli.py (modified)

Testing

• Not run in this environment.

What does this PR do?

Fixes #<issue_number>

Closes #818

[Copilot]

Pull request overview

Adds an opt-in “strict” mode to execute_notebook(...) so callers can fail fast when passing parameters that are not declared in the notebook’s parameters cell (default remains warning-only), addressing #818.

Changes:

• Extend execute_notebook(...) with a raise_on_unknown_parameters flag and raise on unknown keys when enabled.
• Add a corresponding CLI flag --raise-on-unknown-parameters/--no-raise-on-unknown-parameters.
• Add a CLI wiring test to ensure the flag is forwarded to execute_notebook.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
papermill/execute.py	Implements strict unknown-parameter validation (raise vs warn).
papermill/cli.py	Exposes strict mode via a new Click option and forwards it into execution.
papermill/tests/test_cli.py	Adds a CLI test verifying the new option is passed through.

Comments suppressed due to low confidence (1)

papermill/execute.py:22

• raise_on_unknown_parameters was inserted into the middle of the public execute_notebook signature (between parameters and engine_name). This is a backwards-incompatible API change for any callers that previously passed engine_name (or later args) positionally; those values will now be interpreted as raise_on_unknown_parameters and shift the rest of the arguments. To preserve positional-call compatibility, add the new parameter at the end of the signature (or otherwise avoid shifting existing positional parameters) and update call sites accordingly.

def execute_notebook(
    input_path,
    output_path,
    parameters=None,
    raise_on_unknown_parameters=False,
    engine_name=None,
    request_save_on_cell_execute=True,
    prepare_only=False,
    kernel_name=None,

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The new strict-unknown-parameter behavior (raising instead of warning) isn’t covered by unit tests. Since papermill/tests/test_execute.py already exercises execute_notebook, please add tests that (1) verify raise_on_unknown_parameters=True raises for an undeclared key, and (2) verify the default behavior continues to only warn and still parameterizes successfully.