nteract/papermill

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

Open

#806 aberto em 5 de set. de 2024

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

Métricas do repositório

Stars
 (5.381 stars)
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
Examine a lógica de análise de parâmetros no papermill, provavelmente em `papermill/parameter.py` ou `papermill/iorw.py`. O bug é que `None | str` não é reconhecido como uma dica de tipo válida, enquanto `Optional[str]` funciona. Você precisará modificar a detecção de tipo para lidar com a sintaxe de união do PEP 604. Verifique como `typing.get type hints` ou a análise personalizada é usada e garanta que `None | X` seja tratado como equivalente a `Optional[X]`.
Pilha de tecnologia
python
Domain
cli
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.
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
Basic PythonUnderstanding of type hintsPapermill usage
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85