glideapps/quicktype

python: invalid code due to comments starting or ending with double quotes

Open

#1.239 aberto em 23 de mai. de 2019

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (968 forks)batch import
Pythonbuggood first issue

Métricas do repositório

Stars
 (10.867 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

when generating python code, the generated syntax becomes invalid if there are comments (i.e. "description" fields in the JSON schema) that start or end with double quotes

Example

for the JSON schema fragment:

"properties": {
  "type": {
    "description": "type is \"output\"",
    "minLength": 1,
    "oneOf": [
	  {
	    "$ref": "#/definitions/MessageType"
	  }
    ]
  },

the generated (invalid) python 3.7 code fragment is

"""type is "output""""
type: MessageType

Solution

the generator for python should check the first and last character of a documentation-comment (i.e. the "description" field value) -- and if this is the case, the emitted code should "escape" these characters (e.g. prepend/append a newline or space character)

Guia do colaborador

Direção de pesquisa
Examine o template ou a lógica de geração de código Python para identificar onde os campos de descrição são inseridos nas docstrings e, em seguida, adicione uma sanitização para aspas duplas no início ou no final.
Pilha de tecnologia
typescriptpython
Domain
tooling
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
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75