nteract/papermill

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

Open

#806 geöffnet am 5. Sept. 2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (402 Forks)batch import
bughelp wanted

Repository-Metriken

Stars
 (5.381 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

🐛 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

Contributor Guide

Research-Richtung
Untersuche die Parameterparselogik in papermill, wahrscheinlich in `papermill/parameter.py` oder `papermill/iorw.py`. Der Fehler ist, dass `None | str` nicht als gültiger Typ Hinweis erkannt wird, während `Optional[str]` funktioniert. Sie müssen die Typenerkennung anpassen, um die PEP 604 Union Syntax zu verarbeiten. Überprüfen Sie, wie `typing.get type hints` oder benutzerdefiniertes Parsing verwendet wird, und stellen Sie sicher, dass `None | X` als äquivalent zu `Optional[X]` behandelt wird.
Tech Stack
python
Domain
cli
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic PythonUnderstanding of type hintsPapermill usage
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85