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聽(7,539 stars)聽(608 forks)batch import
bugconfigenhelp wanted

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

Tech stack
python
Domain
tooling
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The bug is in the configen code generation, specifically when handling Optional[str] fields with default string values. The fix should ensure that string defaults are quoted. Look at the code that generates the field definition, likely in the configen source code. Reference PR #1072 which fixed a similar issue for non Optional str defaults. The change should be localized to the string formatting logic for default values when the type is Optional[str].
[Bug][configen] Generates unquoted str defaults when type hints include Optional[ ] 路 facebookresearch/hydra#1174 | Good First Issue