facebookresearch/hydra

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

Open

#1.174 aberto em 30 de nov. de 2020

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

Métricas do repositório

Stars
 (7.539 stars)
Métricas de merge de PR
 (Mesclagem média 37d 6h) (25 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
O bug está na geração de código do configen, especificamente ao lidar com campos Optional[str] com valores padrão de string. A correção deve garantir que os padrões de string sejam colocados entre aspas. Examine o código que gera a definição do campo, provavelmente no código fonte do configen. Consulte o PR #1072 que corrigiu um problema semelhante para padrões str não Optional. A alteração deve ser localizada na lógica de formatação de string para valores padrão quando o tipo for Optional[str].
Pilha de tecnologia
python
Domain
backendtooling
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70