nteract/papermill

Python parameter with `None | ` union type is logged as unknown

Aberta

#806 aberto em 5 de set. de 2024

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Python (402 forks)batch import
bughelp wanted

Métricas do repositório

Stars
 (5.381 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

🐛 Bug

# template.ipynb parameters block
foo: None|str = None

$ papermill -p foo BAR ...
Passed unknown parameter: foo

Expected: this warning not to show up, foo should be recognized as a valid parameter.

Also note:

  • Despite the warning, the above example still properly injects the parameter value
  • Optional[str] does not suffer from this issue, just type union style
  • str|None (change the type order) produces the same warning log

papermill version == 2.6.0

Guia do colaborador

Direção de pesquisa
Investigue como o papermill analisa as anotações de tipo dos parâmetros do notebook, especialmente o tratamento de tipos de união como `None | str`. Veja o código que converte strings de tipo em tipos reais e descubra por que `None | str` não é reconhecido.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Bug
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.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70