feat: add support for deprecated type syntax

Signed-off-by: Louis Mandel <[email protected]>

Author: mandel

src/pdl/pdl_ast.py

@@ -154,7 +154,20 @@ class AnyPattern(Pattern):
 
 
 BasePdlType: TypeAlias = Literal[
-    "null", "boolean", "string", "number", "integer", "array", "object"
+    "null",
+    "boolean",
+    "string",
+    "number",
+    "integer",
+    "array",
+    "object",
+    # deprecated syntax below
+    "bool",
+    "str",
+    "float",
+    "int",
+    "list",
+    "obj",
 ]
 """Base types."""
 

src/pdl/pdl_dumper.py

@@ -58,6 +58,7 @@
     TextBlock,
 )
 from .pdl_lazy import PdlLazy
+from .pdl_schema_utils import OLD_PDLTYPE_TO_JSONSCHEMA_NAME
 
 yaml.SafeDumper.org_represent_str = yaml.SafeDumper.represent_str  # type: ignore
 
@@ -327,6 +328,20 @@ def type_to_dict(t: PdlTypeType):
             d = None
         case "null" | "boolean" | "string" | "number" | "integer" | "array" | "object":
             d = t
+        case "bool" | "str" | "float" | "int" | "list" | "obj":
+            d = OLD_PDLTYPE_TO_JSONSCHEMA_NAME[t]
+        case "bool":
+            d = "boolean"
+        case "str":
+            d = "string"
+        case "float":
+            d = "number"
+        case "int":
+            d = "integer"
+        case "list":
+            d = "array"
+        case "obj":
+            d = "object"
         case EnumPdlType():
             d = t.model_dump()
         case [elem]:

src/pdl/pdl_schema_error_analyzer.py

@@ -6,7 +6,19 @@
 def is_base_type(schema):
     if "type" in schema:
         the_type = schema["type"]
-        if the_type in set(["string", "boolean", "integer", "number"]):
+        if the_type in set(
+            [
+                "null",
+                "string",
+                "boolean",
+                "integer",
+                "number",
+                "str",
+                "bool",
+                "int",
+                "float",
+            ]
+        ):
             return True
     if "enum" in schema:
         return True
@@ -61,7 +73,11 @@ def analyze_errors(defs, schema, data, loc: PdlLocationType) -> list[str]:  # no
     if is_base_type(schema):
         if "type" in schema:
             the_type = json_types_convert[schema["type"]]
-            if not isinstance(data, the_type):  # pyright: ignore
+            if (
+                the_type is None
+                and data is not None
+                or not isinstance(data, the_type)  # type: ignore
+            ):
                 ret.append(
                     get_loc_string(loc)
                     + str(data)

src/pdl/pdl_schema_utils.py

@@ -1,3 +1,4 @@
+import sys
 import warnings
 from typing import Any, Optional
 
@@ -10,12 +11,19 @@
 )
 
 json_types_convert = {
+    "null": None,
     "string": str,
     "boolean": bool,
     "integer": int,
     "number": float,
     "array": list,
     "object": dict,
+    "str": str,
+    "bool": bool,
+    "int": int,
+    "float": float,
+    "list": list,
+    "obj": dict,
 }
 
 
@@ -26,6 +34,16 @@ def convert_to_json_type(a_type):
     return None
 
 
+OLD_PDLTYPE_TO_JSONSCHEMA_NAME = {
+    "bool": "boolean",
+    "str": "string",
+    "float": "number",
+    "int": "integer",
+    "list": "array",
+    "obj": "object",
+}
+
+
 def pdltype_to_jsonschema(
     pdl_type: PdlTypeType, additional_properties: bool
 ) -> dict[str, Any]:
@@ -35,6 +53,12 @@ def pdltype_to_jsonschema(
             schema = {}  # Any type
         case "null" | "boolean" | "string" | "number" | "integer" | "array" | "object":
             schema = {"type": pdl_type}
+        case "bool" | "str" | "float" | "int" | "list" | "obj":
+            print(
+                f"Deprecated type syntax: use {OLD_PDLTYPE_TO_JSONSCHEMA_NAME[pdl_type]} instead of {pdl_type}.",
+                file=sys.stderr,
+            )
+            schema = {"type": OLD_PDLTYPE_TO_JSONSCHEMA_NAME[pdl_type]}
         case EnumPdlType(enum=choices):
             if pdl_type.__pydantic_extra__ is None:
                 extra = {}

tests/test_type_checking.py

@@ -1,7 +1,7 @@
 import pytest
 import yaml
 
-from pdl.pdl import exec_dict
+from pdl.pdl import exec_dict, exec_str
 from pdl.pdl_ast import pdl_type_adapter
 from pdl.pdl_interpreter import PDLRuntimeError
 from pdl.pdl_parser import PDLParseError
@@ -587,3 +587,21 @@ def test_hello1():
 def test_hello2():
     with pytest.raises(PDLRuntimeError):
         exec_dict(hello2)
+
+
+def do_test_stderr(capsys, prog, err):
+    exec_str(prog)
+    captured = capsys.readouterr()
+    output = captured.err.split("\n")
+    print(output)
+    assert set(output) == set(err)
+
+
+def test_deprecated(capsys: pytest.CaptureFixture[str]):
+    prog = """
+        data: 1
+        spec: int
+    """
+    do_test_stderr(
+        capsys, prog, ["Deprecated type syntax: use integer instead of int.", ""]
+    )