nteract/papermill

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

Open

Aperta il 5 set 2024

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (5381 star) (402 fork)batch import
bughelp wanted

Descrizione

🐛 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

Guida contributor

Tech stack
python
Dominio
cli
Tipo issue
bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
under 1 hour
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic PythonUnderstanding of type hintsPapermill usage
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
Look at the parameter parsing logic in papermill, likely in `papermill/parameter.py` or `papermill/iorw.py`. The bug is that `None | str` is not recognized as a valid type hint, while `Optional[str]` works. You'll need to modify the type detection to handle PEP 604 union syntax. Check how `typing.get type hints` or custom parsing is used, and ensure that `None | X` is treated as equivalent to `Optional[X]`.