facebookresearch/hydra

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

Open

#1.174 geöffnet am 30. Nov. 2020

Auf GitHub ansehen
 (2 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (608 Forks)batch import
bugconfigenhelp wanted

Repository-Metriken

Stars
 (7.539 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 37T 6h) (25 gemergte PRs in 30 T)

Beschreibung

🐛 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

Contributor Guide

Research-Richtung
Der Fehler liegt in der Codegenerierung von configen, insbesondere bei der Behandlung von Optional[str] Feldern mit Standard Stringwerten. Die Korrektur sollte sicherstellen, dass String Standardwerte in AnfĂŒhrungszeichen gesetzt werden. Schauen Sie sich den Code an, der die Felddefinition generiert, wahrscheinlich im configen Quellcode. Verweisen Sie auf PR #1072, der ein Ă€hnliches Problem fĂŒr nicht Optional str Standardwerte behoben hat. Die Änderung sollte auf die String Formatierungslogik fĂŒr Standardwerte beschrĂ€nkt sein, wenn der Typ Optional[str] ist.
Tech Stack
python
Domain
backendtooling
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.
1-3 Stunden
AktivitĂ€tsstatusWie verfĂŒgbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nĂ€chsten Schritt erklĂ€rt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schĂ€tzt, wie zugĂ€nglich dieses Issue fĂŒr First-Time Contributors ist.
70