glideapps/quicktype

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

Open

#1.239 geöffnet am 23. Mai 2019

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (10.867 Stars) (968 Forks)batch import
Pythonbuggood first issue

Beschreibung

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)

Contributor Guide

Tech Stack
typescriptpython
Domain
backendtooling
Issue Type
bug
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Python syntaxbasic understanding of string escaping
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
The issue is in the Python code generation logic. Look for files related to Python language generation in the quicktype codebase, particularly how documentation comments (from JSON schema descriptions) are emitted into Python code. The fix requires checking if the comment string starts or ends with a double quote and prepending/appending a space or newline to avoid invalid syntax. No linked PRs exist, so examine the current Python emitter code and test with the provided example.