rename Testing Schema, add Value

CQCL · Apr 24, 2024 · 837acde · 837acde
1 parent a9e0df8
commit 837acde
Show file tree

Hide file tree

Showing 10 changed files with 785 additions and 103 deletions.
diff --git a/hugr-py/src/hugr/serialization/ops.py b/hugr-py/src/hugr/serialization/ops.py
@@ -13,7 +13,7 @@
     PolyFuncType,
     Type,
     TypeRow,
-    SumTypeBase,
+    SumType,
     TypeBound,
 )
 
@@ -128,7 +128,7 @@ class SumValue(BaseModel):
 
     c: Literal["Sum"] = Field("Sum", title="ValueTag")
     tag: int
-    typ: SumTypeBase
+    typ: SumType
     vs: list["Value"]
 
     class Config:

diff --git a/hugr-py/src/hugr/serialization/hugrtype.py → ...py/src/hugr/serialization/testing_hugr.py b/hugr-py/src/hugr/serialization/hugrtype.py → ...py/src/hugr/serialization/testing_hugr.py
@@ -1,21 +1,22 @@
 from typing import Any, Literal
 from pydantic import BaseModel, Field
-from .tys import Type, USize, SumTypeBase
+from .tys import Type, USize, SumType
+from .ops import Value
 
 
-class HugrType(BaseModel):
-    """A serializable representation of a Hugr Type. Intended for testing only."""
+class TestingHugr(BaseModel):
+    """A serializable representation of a Hugr Type, SumType, or Value. Intended for testing only."""
 
-    typ: Type | SumTypeBase
-    version: Literal["v1"] = "v1"
+    typ: Type | SumType | Value
+    version: Literal["v2"] = "v2"
 
     @classmethod
     def get_version(cls) -> str:
         """Return the version of the schema."""
         return cls(typ=Type(USize())).version
 
     class Config:
-        title = "HugrType"
+        title = "HugrTesting"
         json_schema_extra = {
             "required": ["typ"],
         }
diff --git a/hugr-py/src/hugr/serialization/tys.py b/hugr-py/src/hugr/serialization/tys.py
@@ -158,13 +158,13 @@ class GeneralSum(BaseModel):
     rows: list["TypeRow"]
 
 
-class SumTypeBase(RootModel):
+class SumType(RootModel):
     root: Union[UnitSum, GeneralSum] = Field(discriminator="s")
 
 
-class SumType(BaseModel):
+class TaggedSumType(BaseModel):
     t: Literal["Sum"] = "Sum"
-    st: SumTypeBase
+    st: SumType
 
 
 # ----------------------------------------------
@@ -287,7 +287,7 @@ class Type(RootModel):
     """A HUGR type."""
 
     root: Annotated[
-        Qubit | Variable | USize | FunctionType | Array | SumType | Opaque | Alias,
+        Qubit | Variable | USize | FunctionType | Array | TaggedSumType | Opaque | Alias,
         WrapValidator(_json_custom_error_validator),
     ] = Field(discriminator="t")
 

diff --git a/hugr/src/hugr/serialize.rs b/hugr/src/hugr/serialize.rs
@@ -310,7 +310,7 @@ pub mod test {
         };
         static ref TYPE_SCHEMA: JSONSchema = {
             let schema_val: serde_json::Value = serde_json::from_str(include_str!(
-                "../../../specification/schema/test_hugrtype_schema_v1.json"
+                "../../../specification/schema/testing_hugr_schema_v1.json"
             ))
             .unwrap();
             JSONSchema::options()

diff --git a/hugr/src/hugr/validate.rs b/hugr/src/hugr/validate.rs
@@ -101,7 +101,8 @@ impl<'a, 'b> ValidationContext<'a, 'b> {
         // In tests we take the opportunity to verify that the hugr
         // serialization round-trips. We verify the schema of the serialisation
         // format only when an environment variable is set. This allows
-        // development while the schema is broken.
+        // a developer to modify the definition of serialised types locally
+        // without having to change the schema.
         #[cfg(test)]
         {
             let test_schema = std::env::var("HUGR_TEST_SCHEMA").is_ok_and(|x| !x.is_empty());

diff --git a/justfile b/justfile
@@ -13,8 +13,8 @@ check:
     poetry run pre-commit run --all-files
 
 # Run all the tests.
-test language="[rust|python]": (_run_lang language \
-        "HUGR_TEST_SCHEMA=1 cargo test --all-features" \
+test language="[rust|python]" : (_run_lang language \
+        "HUGR_TEST_SCHEMA=\"1\" cargo test --all-features" \
         "poetry run pytest"
     )
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/scripts/generate_schema.py b/scripts/generate_schema.py
@@ -15,7 +15,7 @@
 from pydantic import TypeAdapter
 
 from hugr.serialization import SerialHugr
-from hugr.serialization.hugrtype import HugrType
+from hugr.serialization.testing_hugr import TestingHugr
 
 
 def write_schema(out_dir: Path, name_prefix: str, schema):
@@ -37,4 +37,4 @@ def write_schema(out_dir: Path, name_prefix: str, schema):
         sys.exit(1)
 
     write_schema(out_dir, "hugr_schema", SerialHugr)
-    write_schema(out_dir, "test_hugrtype_schema", HugrType)
+    write_schema(out_dir, "testing_hugr_schema", TestingHugr)
diff --git a/specification/schema/hugr_schema_v1.json b/specification/schema/hugr_schema_v1.json
@@ -1241,27 +1241,6 @@
             "type": "object"
         },
         "SumType": {
-            "properties": {
-                "t": {
-                    "const": "Sum",
-                    "default": "Sum",
-                    "enum": [
-                        "Sum"
-                    ],
-                    "title": "T",
-                    "type": "string"
-                },
-                "st": {
-                    "$ref": "#/$defs/SumTypeBase"
-                }
-            },
-            "required": [
-                "st"
-            ],
-            "title": "SumType",
-            "type": "object"
-        },
-        "SumTypeBase": {
             "discriminator": {
                 "mapping": {
                     "General": "#/$defs/GeneralSum",
@@ -1277,7 +1256,7 @@
                     "$ref": "#/$defs/GeneralSum"
                 }
             ],
-            "title": "SumTypeBase"
+            "title": "SumType"
         },
         "SumValue": {
             "description": "A Sum variant For any Sum type where this value meets the type of the variant indicated by the tag.",
@@ -1296,7 +1275,7 @@
                     "type": "integer"
                 },
                 "typ": {
-                    "$ref": "#/$defs/SumTypeBase"
+                    "$ref": "#/$defs/SumType"
                 },
                 "vs": {
                     "items": {
@@ -1357,6 +1336,27 @@
             "title": "Tag",
             "type": "object"
         },
+        "TaggedSumType": {
+            "properties": {
+                "t": {
+                    "const": "Sum",
+                    "default": "Sum",
+                    "enum": [
+                        "Sum"
+                    ],
+                    "title": "T",
+                    "type": "string"
+                },
+                "st": {
+                    "$ref": "#/$defs/SumType"
+                }
+            },
+            "required": [
+                "st"
+            ],
+            "title": "TaggedSumType",
+            "type": "object"
+        },
         "TailLoop": {
             "description": "Tail-controlled loop.",
             "properties": {
@@ -1466,7 +1466,7 @@
                     "I": "#/$defs/USize",
                     "Opaque": "#/$defs/Opaque",
                     "Q": "#/$defs/Qubit",
-                    "Sum": "#/$defs/SumType",
+                    "Sum": "#/$defs/TaggedSumType",
                     "V": "#/$defs/Variable"
                 },
                 "propertyName": "t"
@@ -1488,7 +1488,7 @@
                     "$ref": "#/$defs/Array"
                 },
                 {
-                    "$ref": "#/$defs/SumType"
+                    "$ref": "#/$defs/TaggedSumType"
                 },
                 {
                     "$ref": "#/$defs/Opaque"