Add link_name to hugr-py FuncDefn, update schema

Author: acl-cqc

hugr-py/src/hugr/_serialization/ops.py

@@ -75,11 +75,16 @@ class FuncDefn(BaseOp):
 
     name: str
     signature: PolyFuncType
+    link_name: str | None
 
     def deserialize(self) -> ops.FuncDefn:
         poly_func = self.signature.deserialize()
         return ops.FuncDefn(
-            self.name, inputs=poly_func.body.input, _outputs=poly_func.body.output
+            self.name,
+            params=poly_func.params,
+            inputs=poly_func.body.input,
+            _outputs=poly_func.body.output,
+            link_name=self.link_name,
         )
 
 

hugr-py/src/hugr/ops.py

@@ -1142,14 +1142,16 @@ class FuncDefn(DfParentOp):
     the function.
     """
 
-    #: function name
+    #: function name - internal only
     f_name: str
     #: input types of the function
     inputs: tys.TypeRow
     # ? type parameters of the function if polymorphic
     params: list[tys.TypeParam] = field(default_factory=list)
     _outputs: tys.TypeRow | None = field(default=None, repr=False)
     num_out: int = field(default=1, repr=False)
+    #: name for linking
+    link_name: str | None = None
 
     @property
     def outputs(self) -> tys.TypeRow:
@@ -1176,6 +1178,7 @@ def _to_serial(self, parent: Node) -> sops.FuncDefn:
             parent=parent.idx,
             name=self.f_name,
             signature=self.signature._to_serial(),
+            link_name=self.link_name,
         )
 
     def inner_signature(self) -> tys.FunctionType:

specification/schema/hugr_schema_live.json

@@ -706,12 +706,24 @@
                 },
                 "signature": {
                     "$ref": "#/$defs/PolyFuncType"
+                },
+                "link_name": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "title": "Link Name"
                 }
             },
             "required": [
                 "parent",
                 "name",
-                "signature"
+                "signature",
+                "link_name"
             ],
             "title": "FuncDefn",
             "type": "object"

specification/schema/hugr_schema_strict_live.json

@@ -706,12 +706,24 @@
                 },
                 "signature": {
                     "$ref": "#/$defs/PolyFuncType"
+                },
+                "link_name": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "title": "Link Name"
                 }
             },
             "required": [
                 "parent",
                 "name",
-                "signature"
+                "signature",
+                "link_name"
             ],
             "title": "FuncDefn",
             "type": "object"

specification/schema/testing_hugr_schema_live.json

@@ -706,12 +706,24 @@
                 },
                 "signature": {
                     "$ref": "#/$defs/PolyFuncType"
+                },
+                "link_name": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "title": "Link Name"
                 }
             },
             "required": [
                 "parent",
                 "name",
-                "signature"
+                "signature",
+                "link_name"
             ],
             "title": "FuncDefn",
             "type": "object"

specification/schema/testing_hugr_schema_strict_live.json

@@ -706,12 +706,24 @@
                 },
                 "signature": {
                     "$ref": "#/$defs/PolyFuncType"
+                },
+                "link_name": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "title": "Link Name"
                 }
             },
             "required": [
                 "parent",
                 "name",
-                "signature"
+                "signature",
+                "link_name"
             ],
             "title": "FuncDefn",
             "type": "object"