Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add serialization schema for metadata #1038

Merged
merged 2 commits into from
May 14, 2024
Merged

feat: Add serialization schema for metadata #1038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffdfb80
feat: Add serialization schema for metadata
doug-q May 14, 2024
b103ca0
Update hugr/src/hugr/serialize.rs
doug-q May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions hugr-py/src/hugr/serialization/serial_hugr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
from typing import Any, Literal

from pydantic import BaseModel, Field, ConfigDict
from pydantic import Field, ConfigDict

from .ops import NodeID, OpType, classes as ops_classes
from .tys import model_rebuild
from .tys import model_rebuild, ConfiguredBaseModel
import hugr

Port = tuple[NodeID, int | None] # (node, offset)
Edge = tuple[Port, Port]


class SerialHugr(BaseModel):
class SerialHugr(ConfiguredBaseModel):
Copy link
Collaborator Author

@doug-q doug-q May 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very awkward that his slipped through. The consequence of this is that the "Strict Schema" testing has not been operating on the SerialHugr node(although it has on its children).

Once I fixed this, many tests failed due to an "extra" "metadata" field being serialised!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ouch. Good catch!

"""A serializable representation of a Hugr."""

version: Literal["v1"] = "v1"
nodes: list[OpType]
edges: list[Edge]
metadata: list[dict[str, Any] | None] | None = None
encoder: str | None = Field(
default=None, description="The name of the encoder used to generate the Hugr."
)
Expand Down
27 changes: 12 additions & 15 deletions hugr/src/hugr/serialize.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use portgraph::{Direction, LinkError, PortView};

use serde::{Deserialize, Deserializer, Serialize};

use super::{HugrMut, HugrView};
use super::{HugrMut, HugrView, NodeMetadataMap};

/// A wrapper over the available HUGR serialization formats.
///
Expand Down Expand Up @@ -61,11 +61,8 @@ struct SerHugrV1 {
/// for each edge: (src, src_offset, tgt, tgt_offset)
edges: Vec<[(Node, Option<u16>); 2]>,
/// for each node: (metadata)
//
// TODO: Update to Vec<Option<Map<String,Value>>> to more closely
// match the internal representation.
#[serde(default)]
metadata: Vec<serde_json::Value>,
metadata: Option<Vec<Option<NodeMetadataMap>>>,
/// A metadata field with the package identifier that encoded the HUGR.
#[serde(default)]
encoder: Option<String>,
Expand Down Expand Up @@ -173,7 +170,7 @@ impl TryFrom<&Hugr> for SerHugrV1 {
}

let mut nodes = vec![None; hugr.node_count()];
let mut metadata = vec![serde_json::Value::Null; hugr.node_count()];
let mut metadata = vec![None; hugr.node_count()];
for n in hugr.nodes() {
let parent = node_rekey[&hugr.get_parent(n).unwrap_or(n)];
let opt = hugr.get_nodetype(n);
Expand All @@ -183,11 +180,7 @@ impl TryFrom<&Hugr> for SerHugrV1 {
input_extensions: opt.input_extensions.clone(),
op: opt.op.clone(),
});
let node_metadata = hugr.metadata.get(n.pg_index()).clone();
metadata[new_node] = match node_metadata {
Some(m) => serde_json::Value::Object(m.clone()),
None => serde_json::Value::Null,
};
metadata[new_node].clone_from(hugr.metadata.get(n.pg_index()));
}
let nodes = nodes
.into_iter()
Expand Down Expand Up @@ -222,7 +215,7 @@ impl TryFrom<&Hugr> for SerHugrV1 {
Ok(Self {
nodes,
edges,
metadata,
metadata: Some(metadata),
encoder,
})
}
Expand Down Expand Up @@ -263,9 +256,13 @@ impl TryFrom<SerHugrV1> for Hugr {
);
}

for (node, metadata) in metadata.into_iter().enumerate() {
let node = portgraph::NodeIndex::new(node);
hugr.metadata[node] = metadata.as_object().cloned();
if let Some(metadata) = metadata {
for (node, metadata) in metadata.into_iter().enumerate() {
if let Some(metadata) = metadata {
let node = portgraph::NodeIndex::new(node);
hugr.metadata[node] = Some(metadata);
}
}
}

let unwrap_offset = |node: Node, offset, dir, hugr: &Hugr| -> Result<usize, Self::Error> {
Expand Down
23 changes: 23 additions & 0 deletions specification/schema/hugr_schema_strict_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2259,6 +2259,7 @@
"type": "object"
}
},
"additionalProperties": false,
"description": "A serializable representation of a Hugr.",
"properties": {
"version": {
Expand Down Expand Up @@ -2328,6 +2329,28 @@
"title": "Edges",
"type": "array"
},
"metadata": {
"anyOf": [
{
"items": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"encoder": {
"anyOf": [
{
Expand Down
23 changes: 23 additions & 0 deletions specification/schema/hugr_schema_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2259,6 +2259,7 @@
"type": "object"
}
},
"additionalProperties": true,
"description": "A serializable representation of a Hugr.",
"properties": {
"version": {
Expand Down Expand Up @@ -2328,6 +2329,28 @@
"title": "Edges",
"type": "array"
},
"metadata": {
"anyOf": [
{
"items": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"encoder": {
"anyOf": [
{
Expand Down