glideapps/quicktype

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

Open

#1239 opened on May 23, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (10,867 stars) (968 forks)batch import
Pythonbuggood first issue

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)

Contributor guide

Tech stack
typescriptpython
Domain
backendtooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python syntaxbasic understanding of string escaping
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.