Skip to content

feat: Add more options to DotRenderer config #2540

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

Merged
merged 2 commits into from
Sep 9, 2025
Merged

feat: Add more options to DotRenderer config #2540

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bedd2f4
Add options
tatiana-s Sep 4, 2025
8108d3c
Merge remote-tracking branch 'origin/main' into ts/render-config
tatiana-s Sep 9, 2025
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
19 changes: 16 additions & 3 deletions hugr-py/src/hugr/hugr/render.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,12 @@ class RenderConfig:
palette: Palette = field(default_factory=lambda: PALETTE["default"])
#: If true prepend extension name to operation name.
qualify_op_name: bool = False
#: If true display node metadata.
display_metadata: bool = True
#: If true display node numbering.
display_node_id: bool = False
#: If true display full type name on the edges.
display_link_label: bool = True


class DotRenderer:
Expand Down Expand Up @@ -234,7 +240,7 @@ def _out_order_name(self, n: Node) -> str:
def _viz_node(self, node: Node, hugr: Hugr, graph: Digraph) -> None:
"""Render a (possibly nested) node to a graphviz graph."""
meta = hugr[node].metadata
if len(meta) > 0:
if len(meta) > 0 and self.config.display_metadata:
data = "<BR/><BR/>" + "<BR/>".join(
html.escape(key) + ": " + html.escape(str(value))
for key, value in meta.items()
Expand All @@ -258,11 +264,15 @@ def _viz_node(self, node: Node, hugr: Hugr, graph: Digraph) -> None:
op_name = op.op_def().name
else:
op_name = op.name()

op_name = html.escape(op_name)
node_label = (
f"{op_name} <BR/>({node.idx}) " if self.config.display_node_id else op_name
)

label_config = {
"node_back_color": self.config.palette.node,
"node_label": op_name,
"node_label": node_label,
"node_data": data,
"inputs_row": inputs_row,
"outputs_row": outputs_row,
Expand Down Expand Up @@ -310,7 +320,10 @@ def _viz_link(
label = ""
match kind:
case ValueKind(ty):
label = html.escape(str(ty))
if self.config.display_link_label:
# TODO: Figure out why some nested types result in all type fields
# being printed instead of just the `__str__` representation.
label = html.escape(str(ty))
color = self.config.palette.edge
case OrderKind():
color = self.config.palette.dark
Expand Down
Loading