HugrGenerator

class hugr.metadata.HugrGenerator(*args, **kwargs)

Bases: Metadata[GeneratorDesc]

Metadata describing the generator that defined the HUGR module.

This value is only valid when set at the module root node.

Methods

from_json	Deserialize the metadata value from the stored json value.
to_json	Serialize the metadata value to a json value.

Attributes

ALIASES	Other aliases of the metadata key.
KEY	The unique key associated with the metadata entry.

ALIASES: ClassVar[list[str]] = []

Other aliases of the metadata key.

Typed metadata reads use these, in order, as fallbacks when KEY is not present. This is used for backward compatibility when renaming metadata keys.

Writes ignore this field and only write to KEY.

KEY: ClassVar[str] = 'core.generator'

The unique key associated with the metadata entry.

classmethod from_json(value: JsonType) → GeneratorDesc

Deserialize the metadata value from the stored json value.

classmethod to_json(value: GeneratorDesc) → dict[str, str]

Serialize the metadata value to a json value.