nteract/papermill

Option to raise exception when unknown parameter passed.

Open

#818 ouverte le 6 mai 2025

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (402 forks)batch import
enhancementhelp wanted

Métriques du dépôt

Stars
 (5 381 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Examinez le fichier papermill/execute.py, en particulier la ligne 97, où les paramètres sont traités. Le code actuel transmet probablement tous les paramètres au notebook sans validation. Pour implémenter la fonctionnalité, ajoutez un argument optionnel (par exemple, `raise on unknown`) à la fonction d'exécution. Ensuite, après avoir analysé les paramètres fournis, vérifiez si une clé n'est pas dans la liste des paramètres attendus et levez une exception `PapermillException` si `raise on unknown` est True. Assurez la compatibilité descendante en définissant la valeur par défaut sur `False`.
Stack technique
python
Domaine
backendtooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python basicsUnderstanding of papermill parameters
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85