facebookresearch/hydra

[Bug][configen] Generates unquoted str defaults when type hints include Optional[ ]

Open

#1174 aperta il 30 nov 2020

Vedi su GitHub
 (2 commenti) (1 reazione) (0 assegnatari)Python (608 fork)batch import
bugconfigenhelp wanted

Metriche repository

Star
 (7539 star)
Metriche merge PR
 (Merge medio 37g 6h) (25 PR mergiate in 30 g)

Descrizione

🐛 Bug

Almost identical issue to: #1071 except on a new edge case. Configen will create fields typed with Optional[str], but if there's a default value which is a str type, it will not include it in quotes. We should also test other supported Type hint permutations.

Ex: Generates the field weights_summary: Optional[str] = top instead of the desired: weights_summary: Optional[str] = "top"

To reproduce

git clone https://github.com/romesco/hydra-lightning
configen --config-dir=configen/conf

Will create PR similar to #1072 for fix.

System information

  • Hydra Version : configen==0.9.0dev4
  • Python version : 3.8.6
  • Virtual environment type and version : pyenv-virtualenv 1.2.20
  • Operating system : Ubuntu 18.04

Guida contributor

Direzione di ricerca
Il bug si trova nella generazione del codice configen, in particolare quando si gestiscono campi Optional[str] con valori stringa predefiniti. La correzione dovrebbe garantire che i valori predefiniti di stringa siano racchiusi tra virgolette. Esamina il codice che genera la definizione del campo, probabilmente nel codice sorgente di configen. Fai riferimento alla PR #1072 che ha risolto un problema simile per i valori predefiniti str non Optional. La modifica dovrebbe essere localizzata alla logica di formattazione delle stringhe per i valori predefiniti quando il tipo è Optional[str].
Tech stack
python
Dominio
backendtooling
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
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70