DOT Viewer

Plugin to visualize .dot graphs within the HAL GUI.

dot_viewer.load_dot_file(path: os.PathLike, creator_plugin: str = '') → None

Loads a dot file in the graphic viewer provided by dot_viewer plugin.

Parameters

• path (pathlib.Path) – The path to the .dot file.

• creator_plugin (str) – The name of plugin that created the .dot file. Will try to detect from content or query by popup if empty.

class dot_viewer.DotViewerPlugin

This class provides an interface to integrate a .dot viewer as a plugin within the HAL framework.

property dependencies

A set of plugin names that this plugin depends on.

Type

set[str]

property description

The description of the plugin.

Type

str

get_dependencies(self: dot_viewer.DotViewerPlugin) → Set[str]

Get a set of plugin names that this plugin depends on.

Returns

A set of plugin names that this plugin depends on.

Return type

set[str]

get_description(self: dot_viewer.DotViewerPlugin) → str

Get the description of the plugin.

Returns

The description of the plugin.

Return type

str

get_name(self: dot_viewer.DotViewerPlugin) → str

Get the name of the plugin.

Returns

The name of the plugin.

Return type

str

get_version(self: dot_viewer.DotViewerPlugin) → str

Get the version of the plugin.

Returns

The version of the plugin.

Return type

str

property name

The name of the plugin.

Type

str

property version

The version of the plugin.

Type

str