ModelExport

class hugr.model.export.ModelExport(hugr: Hugr)[source]

Bases: object

Helper to export a Hugr.

Methods

export_entrypoint_meta

Export entrypoint metadata if the node is the module entrypoint.

export_json_meta

Export the metadata of the node via the JSON compatibility constructor.

export_node

Export the node with the given node id.

export_region_cfg

Export the children of a node as a control flow region.

export_region_dfg

Export the children of a node as a dataflow region.

export_region_module

Export a module node as a module region.

export_symbol

Export a symbol.

find_const_input

Find and export the constant that a node is connected to, if any.

find_func_input

Find the symbol name of the function that a node is connected to, if any.

link_name

Return the name of the link that a given port is connected to.
export_entrypoint_meta(node: Node) → list[Term][source]

Export entrypoint metadata if the node is the module entrypoint.

export_json_meta(node: Node) → list[Term][source]

Export the metadata of the node via the JSON compatibility constructor.

export_node(node: Node, virtual_input_links: Sequence[str] = []) → Node | None[source]

Export the node with the given node id.

export_region_cfg(node: Node) → Region[source]

Export the children of a node as a control flow region.

export_region_dfg(node: Node, entrypoint_meta=False) → Region[source]

Export the children of a node as a dataflow region.

export_region_module(node: Node) → Region[source]

Export a module node as a module region.

export_symbol(name: str, visibility: Literal['Public', 'Private'], param_types: Sequence[TypeParam], body: Type) → Symbol[source]

Export a symbol.

find_const_input(node: Node) → Term | None[source]

Find and export the constant that a node is connected to, if any.

find_func_input(node: Node) → str | None[source]

Find the symbol name of the function that a node is connected to, if any.

Return the name of the link that a given port is connected to.