nteract/papermill

Option to raise exception when unknown parameter passed.

Open

#818 aberto em 6 de mai. de 2025

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (402 forks)batch import
enhancementhelp wanted

Métricas do repositório

Stars
 (5.381 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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

Guia do colaborador

Direção de pesquisa
Examine o arquivo papermill/execute.py, especificamente a linha 97, onde os parâmetros são processados. O código atual provavelmente passa todos os parâmetros para o notebook sem validação. Para implementar o recurso, adicione um argumento opcional (por exemplo, `raise on unknown`) à função de execução. Em seguida, após analisar os parâmetros fornecidos, verifique se alguma chave não está na lista de parâmetros esperados e levante uma `PapermillException` se `raise on unknown` for True. Garanta a compatibilidade com versões anteriores definindo o padrão como `False`.
Pilha de tecnologia
python
Domain
backendtooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python basicsUnderstanding of papermill parameters
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85