nteract/papermill

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

Open

#806 ouverte le 5 sept. 2024

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

Métriques du dépôt

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

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

Guide contributeur

Direction de recherche
Examinez la logique d'analyse des paramètres dans papermill, probablement dans `papermill/parameter.py` ou `papermill/iorw.py`. Le bug est que `None | str` n'est pas reconnu comme une indication de type valide, tandis que `Optional[str]` fonctionne. Vous devrez modifier la détection de type pour gérer la syntaxe d'union PEP 604. Vérifiez comment `typing.get type hints` ou l'analyse personnalisée est utilisée, et assurez vous que `None | X` soit traité comme équivalent à `Optional[X]`.
Stack technique
python
Domaine
cli
Type d'issue
Bug
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
Basic PythonUnderstanding of type hintsPapermill usage
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85