facebookresearch/hydra

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

Open

#1 174 ouverte le 30 nov. 2020

Voir sur GitHub
 (2 commentaires) (1 réaction) (0 assignés)Python (608 forks)batch import
bugconfigenhelp wanted

Métriques du dépôt

Stars
 (7 539 stars)
Métriques de merge PR
 (Merge moyen 37j 6h) (25 PRs mergées en 30 j)

Description

🐛 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

Guide contributeur

Direction de recherche
Le bug se trouve dans la génération de code configen, spécifiquement lors de la gestion des champs Optional[str] avec des valeurs de chaîne par défaut. La correction doit garantir que les valeurs par défaut de chaîne soient entre guillemets. Examinez le code qui génère la définition du champ, probablement dans le code source de configen. Référez vous à la PR #1072 qui a corrigé un problème similaire pour les valeurs par défaut str non Optional. Le changement doit être localisé à la logique de formatage de chaîne pour les valeurs par défaut lorsque le type est Optional[str].
Stack technique
python
Domaine
backendtooling
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70