pylint.graph.DotBackend

class documentation

class DotBackend: (source)

View In Hierarchy

Dot File back-end.

Method __init__ Undocumented
Method emit Adds <line> to final output.
Method emit_edge Emit an edge from <name1> to <name2>.
Method emit_node Emit a node with given properties.
Method generate Generates a graph file.
Method get_source Returns self._source.
Class Variable source Undocumented
Instance Variable graphname Undocumented
Instance Variable lines Undocumented
Instance Variable renderer Undocumented
Instance Variable _source Undocumented
def __init__(self, graphname: str, rankdir: str|None = None, size: Any = None, ratio: Any = None, charset: str = 'utf-8', renderer: str = 'dot', additional_param: dict[str, Any]|None = None): (source)

Undocumented

def emit(self, line: str): (source)

Adds <line> to final output.

def emit_edge(self, name1: str, name2: str, **props: Any): (source)

Emit an edge from <name1> to <name2>. For edge properties: see https://www.graphviz.org/doc/info/attrs.html

def emit_node(self, name: str, **props: Any): (source)

Emit a node with given properties. For node properties: see https://www.graphviz.org/doc/info/attrs.html

def generate(self, outputfile: str|None = None, mapfile: str|None = None) -> str: (source)

Generates a graph file. :param str outputfile: filename and path [defaults to graphname.png] :param str mapfile: filename and path :rtype: str :return: a path to the generated file :raises RuntimeError: if the executable for rendering was not found

def get_source(self) -> str: (source)

Returns self._source.

source = (source)

Undocumented

graphname = (source)

Undocumented

lines: list[str] = (source)

Undocumented

renderer = (source)

Undocumented

_source = (source)

Undocumented