nteract/papermill

Option to raise exception when unknown parameter passed.

Open

#818 geöffnet am 6. Mai 2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (402 Forks)batch import
enhancementhelp wanted

Repository-Metriken

Stars
 (5.381 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

🚀 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-Richtung
Betrachten Sie die Datei papermill/execute.py, insbesondere Zeile 97, wo Parameter verarbeitet werden. Der aktuelle Code übergibt wahrscheinlich alle Parameter ohne Validierung an das Notebook. Um die Funktion zu implementieren, fügen Sie der Ausführungsfunktion ein optionales Argument (z. B. `raise on unknown`) hinzu. Überprüfen Sie dann nach dem Parsen der bereitgestellten Parameter, ob ein Schlüssel nicht in der erwarteten Parameterliste enthalten ist, und lösen Sie eine `PapermillException` aus, wenn `raise on unknown` True ist. Stellen Sie die Abwärtskompatibilität sicher, indem Sie den Standardwert auf `False` setzen.
Tech Stack
python
Domain
backendtooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Python basicsUnderstanding of papermill parameters
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85