feat: v2 - convert computed fields

Author: khalo-sa

.gitignore

@@ -146,4 +146,5 @@ cython_debug/
 .vscode
 
 # test outputs
-output_debug.ts
+output_debug.ts
+schema_debug.json

pydantic2ts/cli/script.py

@@ -15,18 +15,19 @@
 
 from pydantic import VERSION, BaseModel, Extra, create_model
 
-try:
-    from pydantic.generics import GenericModel
-except ImportError:
-    GenericModel = None
+V2 = True if VERSION.startswith("2") else False
+
+if not V2:
+    try:
+        from pydantic.generics import GenericModel
+    except ImportError:
+        GenericModel = None
 
 logger = logging.getLogger("pydantic2ts")
 
 
 DEBUG = os.environ.get("DEBUG", False)
 
-V2 = True if VERSION.startswith("2") else False
-
 
 def import_module(path: str) -> ModuleType:
     """
@@ -202,16 +203,16 @@ def generate_json_schema_v2(models: List[Type[BaseModel]]) -> str:
 
     try:
         for m in models:
-            if m.model_config.get("extra") != Extra.allow:
-                m.model_config["extra"] = Extra.forbid
+            if m.model_config.get("extra") != "allow":
+                m.model_config["extra"] = "forbid"
 
         master_model: BaseModel = create_model(
             "_Master_", **{m.__name__: (m, ...) for m in models}
         )
-        master_model.model_config["extra"] = Extra.forbid
+        master_model.model_config["extra"] = "forbid"
         master_model.model_config["json_schema_extra"] = staticmethod(clean_schema)
 
-        schema: dict = master_model.model_json_schema()
+        schema: dict = master_model.model_json_schema(mode="serialization")
 
         for d in schema.get("$defs", {}).values():
             clean_schema(d)
@@ -260,7 +261,9 @@ def generate_typescript_defs(
         f.write(schema)
 
     if DEBUG:
-        with open(Path(output).parent / "schema.json", "w") as f:
+        debug_schema_file_path = Path(module).parent / "schema_debug.json"
+        # raise ValueError(module)
+        with open(debug_schema_file_path, "w") as f:
             f.write(schema)
 
     logger.info("Converting JSON schema to typescript definitions...")

tests/expected_results/computed_fields/v2/input.py

@@ -0,0 +1,13 @@
+# https://docs.pydantic.dev/latest/usage/computed_fields/
+
+from pydantic import BaseModel, computed_field
+
+
+class Rectangle(BaseModel):
+    width: int
+    length: int
+
+    @computed_field
+    @property
+    def area(self) -> int:
+        return self.width * self.length

tests/expected_results/computed_fields/v2/output.ts

@@ -0,0 +1,12 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+/* This file was automatically generated from pydantic models by running pydantic2ts.
+/* Do not modify it by hand - just update the pydantic models and then re-run the script
+*/
+
+export interface Rectangle {
+  width: number;
+  length: number;
+  area: number;
+}

tests/test_script.py

@@ -41,7 +41,7 @@ def run_test(
         cmd = f"pydantic2ts --module {module_path} --output {output_path}"
         for model_to_exclude in exclude:
             cmd += f" --exclude {model_to_exclude}"
-        subprocess.run(cmd, shell=True)
+        subprocess.run(cmd, shell=True, check=True)
 
     with open(output_path, "r") as f:
         output = f.read()
@@ -82,6 +82,12 @@ def test_excluding_models(tmpdir):
     )
 
 
+def test_computed_fields(tmpdir):
+    if version == "v1":
+        pytest.skip("Computed fields are a pydantic v2 feature")
+    run_test(tmpdir, "computed_fields")
+
+
 def test_relative_filepath(tmpdir):
     test_name = "single_module"
     relative_path = os.path.join(