nteract/papermill

Option to raise exception when unknown parameter passed.

Open

Aperta il 6 mag 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (5381 star) (402 fork)batch import
enhancementhelp wanted

Descrizione

🚀 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

Guida contributor

Tech stack
python
Dominio
backendtooling
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Python basicsUnderstanding of papermill parameters
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
Esamina il file papermill/execute.py, in particolare la riga 97, dove vengono elaborati i parametri. Il codice attuale probabilmente passa tutti i parametri al notebook senza validazione. Per implementare la funzionalità, aggiungi un argomento opzionale (ad esempio, `raise on unknown`) alla funzione di esecuzione. Quindi, dopo aver analizzato i parametri forniti, controlla se qualche chiave non è nell'elenco dei parametri previsti e solleva un'eccezione `PapermillException` se `raise on unknown` è True. Assicura la compatibilità con le versioni precedenti impostando il valore predefinito su `False`.