ExtensionRegistry

class hugr.ext.ExtensionRegistry(versioned_extensions: dict[ExtensionId, ExtensionVersions] = <factory>)

Bases: object

Registry of extensions.

Methods

extend	Add a registry of extensions to this registry.
from_extensions	Create an extension registry from a list of extensions.
get_extension	Retrieve an extension by name.
ids	Get the set of extension IDs in the registry.
register	Add an extension to the registry.

Attributes

all_extensions	Get all extensions in the registry.
extensions	Get the latest version of each extension in the registry.
versioned_extensions	Set of different versions of each extension in the registry.

exception ExtensionNotFound(extension_id: ExtensionId)

Bases: Exception

Extension not found in registry.

add_note(note, /)

Add a note to the exception

with_traceback(tb, /)

Set self.__traceback__ to tb and return self.

property all_extensions: Iterator[Extension]

Get all extensions in the registry.

This may contain different versions of the same extension. To get only the latest version of each extension, use extensions().

extend(other: ExtensionRegistry) → None

Add a registry of extensions to this registry.

If an extension with the same name already exists, the one with the higher version is kept.

Parameters:

other – The extension registry to add.

property extensions: Iterator[Extension]

Get the latest version of each extension in the registry.

To get all registered versions of all extensions, use all_extensions().

classmethod from_extensions(extensions: Iterable[Extension]) → ExtensionRegistry

Create an extension registry from a list of extensions.

get_extension(name: ExtensionId) → Extension

Retrieve an extension by name.

Parameters:

name – The name of the extension.

Returns:

Extension in the registry.

Raises:

ExtensionNotFound – If the extension is not found in the registry.

ids() → set[ExtensionId]

Get the set of extension IDs in the registry.

Returns:

Set of extension IDs.

register(extension: Extension) → Extension

Add an extension to the registry.

If a different version of the same extension already exists, keeps both.

Parameters:

extension – The extension to add.

Returns:

The added extension.

Raises:

ExtensionExists – If an extension with the same name already exists.

versioned_extensions: dict[ExtensionId, ExtensionVersions]

Set of different versions of each extension in the registry.