nteract/papermill

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

Ouverte

#806 ouverte le 5 sept. 2024

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Python (402 forks)batch import
bughelp wanted

Métriques du dépôt

Stars
 (5 381 étoiles)
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 comment papermill analyse les annotations de type à partir des paramètres du notebook, en particulier la gestion des types d'union comme `None | str`. Regardez le code qui convertit les chaînes de type en types réels et découvrez pourquoi `None | str` n'est pas reconnu.
Stack technique
python
Domaine
backend
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.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70