使用quicktype生成Python类时if-then子句属性未被支持的问题

问题描述 #

我尝试使用quicktype从JSON Schema生成Python类，但我的Schema包含if-then子句，其中then子句内定义了color属性，然而生成的类代码中并未包含该属性及对应的Color枚举类。我期望生成包含Color枚举和color可选属性的fruits类，请问该如何解决？另外quicktype是否支持JSON Schema Draft-7之前的版本？

我的Schema #

{
    "$schema": "https://json-schema.org/draft-07/schema#",
    "title": "ExampleSchema",
    "type": "object",
    "properties": {
        "type": {
            "enum": [
                "apple",
                "banana"
            ],
            "description": "The type of the fruit."
        }
    },
    "if": {
        "properties": {
            "type": {
                "const": "apple"
            }
        }
    },
    "then": {
        "properties": {
            "color": {
                "enum": [
                    "red",
                    "green"
                ]
            }
        }
    }
}

生成结果 #

from enum import Enum
from dataclasses import dataclass
from typing import Optional

class TypeEnum(Enum):
    """The type of the fruit."""

    APPLE = "apple"
    BANANA = "banana"

@dataclass
class fruits:
    type: Optional[TypeEnum] = None
    """The type of the fruit."""

期望结果 #

from enum import Enum
from dataclasses import dataclass
from typing import Optional

class Color(Enum):
    GREEN = "green"
    RED = "red"

class TypeEnum(Enum):
    """The type of the fruit."""

    APPLE = "apple"
    BANANA = "banana"

@dataclass
class fruits:
    color: Optional[Color] = None
    type: Optional[TypeEnum] = None
    """The type of the fruit."""

解决方法 #

quicktype默认对JSON Schema的if-then条件约束支持有限，不会自动将条件分支内的属性合并到主类定义中。可以通过以下两种方式实现需求：

• 修改Schema，显式声明color属性
  将color属性移到根节点的properties中，同时保留if-then子句来约束只有当type为apple时，color属性才生效（可选添加required规则强制apple必须有color）。修改后的Schema如下：

  {
      "$schema": "https://json-schema.org/draft-07/schema#",
      "title": "ExampleSchema",
      "type": "object",
      "properties": {
          "type": {
              "enum": ["apple", "banana"],
              "description": "The type of the fruit."
          },
          "color": {
              "enum": ["red", "green"]
          }
      },
      "if": {
          "properties": {
              "type": {"const": "apple"}
          }
      },
      "then": {
          "required": ["color"] // 可选：若需要强制apple必须包含color属性，添加此规则
      }
  }
  

  这样quicktype会生成包含color属性和Color枚举的类，同时if-then的约束逻辑可以保留用于后续的JSON验证。

• 使用quicktype命令行参数强制解析所有属性
  如果不想修改原始Schema，可以尝试使用--all-properties参数，强制quicktype解析Schema中所有可能出现的属性（包括条件分支内的）。执行命令示例：

  quicktype --lang python --all-properties your-schema.json -o fruits.py
  

关于JSON Schema版本支持 #

quicktype支持JSON Schema Draft-7及更早的版本（包括Draft-6、Draft-4），但部分旧版本的特殊语法可能存在兼容性问题，建议优先使用Draft-7或更新版本以获得更完善的支持。

内容的提问来源于stack exchange，提问作者Kasuni Wijeratne