nteract/papermill

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

Open

#806 aperta il 5 set 2024

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

Metriche repository

Star
 (5381 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

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

Direzione di ricerca
Indaga su come papermill analizza le annotazioni di tipo dai parametri del notebook, in particolare la gestione dei tipi unione come `None | str`. Esamina il codice che converte le stringhe di tipo in tipi effettivi e scopri perché `None | str` non viene riconosciuto.
Tech stack
python
Dominio
backend
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70