Support refs

Author: amh4r

Diff for: bar.py

@@ -22,7 +22,10 @@ def convert_object_schema_to_class_def(
     )
 
     for k, v in schema.properties.items():
-        if v.type == "boolean":
+        if isinstance(v, json_schema.types.Ref):
+            ref_name = v.ref.split("#")[-1]
+            type_value = ast.Name(id=ref_name)
+        elif v.type == "boolean":
             type_value = Name.bool
         elif v.type == "integer":
             type_value = Name.int

Diff for: foo.py

@@ -6,6 +6,7 @@
     BooleanSchema,
     IntegerSchema,
     ObjectSchema,
+    Ref,
     StringSchema,
 )
 from .class_def import convert_object_schema_to_class_def
@@ -20,19 +21,22 @@ def test_all_types(self) -> None:
         schema = ObjectSchema(
             id="#Person",
             properties={
-                "first_name": StringSchema(),
-                "last_name": StringSchema(),
-                "age": IntegerSchema(),
-                "is_active": BooleanSchema(),
+                "first_name": StringSchema(type="string"),
+                "last_name": StringSchema(type="string"),
+                "age": IntegerSchema(type="integer"),
+                "is_active": BooleanSchema(type="boolean"),
+                "car": Ref(ref="Car"),
             },
-            required=["first_name"]
+            required=["first_name"],
+            type="object",
         )
 
         assert self._get_class_str(schema) == textwrap.dedent("""\
             class Person(TypedDict):
                 first_name: str
                 last_name: NotRequired[str]
                 age: NotRequired[int]
-                is_active: NotRequired[bool]"""
+                is_active: NotRequired[bool]
+                car: NotRequired[Car]"""
         )
 

Diff for: json_schema_to_model/ast/class_def.py

@@ -8,6 +8,5 @@ def _load_json_schema(path: str) -> ObjectSchema:
 
 def load_schemas(path: str) -> list[Schema]:
     full_schema = _load_json_schema(path)
-    # breakpoint()
 
     return [schema for schema in full_schema.properties.values()]

Diff for: json_schema_to_model/ast/test_class_def.py

@@ -14,24 +14,31 @@ class _BaseSchema(pydantic.BaseModel):
 
 class BooleanSchema(_BaseSchema):
     id: None = None
-    type: Literal["boolean"] = "boolean"
+    type: Literal["boolean"]
 
 class IntegerSchema(_BaseSchema):
     id: None = None
-    type: Literal["integer"] = "integer"
+    type: Literal["integer"]
 
 
 class ObjectSchema(_BaseSchema):
     properties: dict[str, Schema]
     required: list[str] = []
-    type: Literal["object"] = "object"
+    type: Literal["object"]
 
 
 class StringSchema(_BaseSchema):
     id: None = None
-    type: Literal["string"] = "string"
+    type: Literal["string"]
 
 
-Schema = BooleanSchema | IntegerSchema | ObjectSchema | StringSchema
+class Ref(pydantic.BaseModel):
+    ref: str = pydantic.Field(alias='$ref')
+
+    class Config:
+        allow_population_by_field_name = True
+
+
+Schema = Ref | BooleanSchema | IntegerSchema | ObjectSchema | StringSchema
 
 ObjectSchema.update_forward_refs()

Diff for: json_schema_to_model/json_schema/load.py

@@ -0,0 +1,2 @@
+[mypy]
+plugins = pydantic.mypy

Diff for: json_schema_to_model/json_schema/types.py

@@ -5,6 +5,7 @@ class Person(TypedDict):
     first_name: str
     last_name: NotRequired[str]
     age: NotRequired[int]
+    car: NotRequired[Car]
 
 class Car(TypedDict):
     color: str

Diff for: mypy.ini

@@ -18,6 +18,9 @@
           "description": "Age in years which must be equal to or greater than zero.",
           "type": "integer",
           "minimum": 0
+        },
+        "car": {
+          "$ref": "#Car"
         }
       },
       "required": ["first_name"]