(1 comment) (0 reactions) (0 assignees)TypeScript (10,867 stars) (968 forks)batch import

Pythonbuggood first issue

説明

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)

コントリビューターガイド

技術スタック: typescriptpython
領域: backendtooling
Issue 種別: bug
難度: 3
推定時間: 1-3 hours
活動状況: stale
明確さ: clear
前提条件: Python syntaxbasic understanding of string escaping
初心者向け度: 60
調査方針: 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.