glideapps/quicktype

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

Open

#1239 aperta il 23 mag 2019

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)TypeScript (968 fork)batch import
Pythonbuggood first issue

Metriche repository

Star
 (10.867 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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)

Guida contributor

Direzione di ricerca
Esamina il template o la logica di generazione del codice Python per individuare dove i campi descrizione vengono inseriti nelle docstring, quindi aggiungi la sanificazione per le virgolette doppie iniziali o finali.
Tech stack
typescriptpython
Dominio
tooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75