facebookresearch/hydra

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

Open

#1,174 opened on Nov 30, 2020

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Python (608 forks)batch import
bugconfigenhelp wanted

Repository metrics

Stars
 (7,539 stars)
PR merge metrics
 (Avg merge 37d 6h) (25 merged PRs in 30d)

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

Contributor guide

Research direction
Investigate the configen code generation logic to find where default values are emitted for Optional[str] fields. Look for where the type hint is parsed and where the default value string is formatted. Ensure that string defaults are quoted. Also review similar fixes like PR #1072.
Tech stack
python
Domain
backendtooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70