pydot API reference

68 public APIs from pydot (pydot/pydot) — 13 classes, 12 functions, 43 methods. Signatures extracted by static analysis of the actual source.

Repository: pydot/pydot

Kind	Count
Classes	13
Functions	12
Methods	43

API list

classsrc.pydot.classes.FrozenDict

Frozen dictionary, values are immutable after creation.

classsrc.pydot.core.Cluster

Class representing a cluster in Graphviz's dot language.

classsrc.pydot.core.Common

Common information to several classes.

methodsrc.pydot.core.Common.attrs_string(prefix:str='') -> str

Format the current attributes list for output.

methodsrc.pydot.core.Common.formatted_attr_list() -> list[str]

Return a list of the class's attributes as formatted strings.

methodsrc.pydot.core.Common.get(name:str) -> Any

Get an attribute value by name.

methodsrc.pydot.core.Common.get_attributes() -> AttributeDict

Get attributes of the object

methodsrc.pydot.core.Common.get_sequence() -> int | None

Get sequence

methodsrc.pydot.core.Common.get_top_graph_type(default:str='graph') -> str

Find the topmost parent graph type for the current object.

methodsrc.pydot.core.Common.set(name:str, value:Any) -> None

Set an attribute value by name.

methodsrc.pydot.core.Common.set_sequence(seq:int) -> None

Set sequence

classsrc.pydot.core.Dot

A container for handling a dot language file.

method

src.pydot.core.Dot.create(prog:list[str] | tuple[str] | str | None=None, format:str='ps', encoding:str | None=None) -> bytes

Creates and returns a binary image for the graph.

methodsrc.pydot.core.Dot.set_prog(prog:str) -> None

Sets the default program.

methodsrc.pydot.core.Dot.set_shape_files(file_paths:str | Sequence[str]) -> None

Add the paths of the required image files.

methodsrc.pydot.core.Dot.write(path:str | bytes, prog:str | None=None, format:str='raw', encoding:str | None=None) -> bool

Writes a graph to a file.

classsrc.pydot.core.Edge

A graph edge.

methodsrc.pydot.core.Edge.get_destination() -> EdgeEndpoint

Get the edge's destination endpoint.

methodsrc.pydot.core.Edge.get_source() -> EdgeEndpoint

Get the edge's source endpoint.

methodsrc.pydot.core.Edge.to_string(indent:Any='', indent_level:int=1) -> str

Return string representation of edge in DOT language.

classsrc.pydot.core.Graph

Class representing a graph in Graphviz's dot language.

methodsrc.pydot.core.Graph.add_edge(graph_edge:Edge) -> None

Adds an edge object to the graph.

methodsrc.pydot.core.Graph.add_node(graph_node:Node) -> None

Adds a node object to the graph.

methodsrc.pydot.core.Graph.add_subgraph(sgraph:Subgraph) -> None

Adds a subgraph object to the graph.

methodsrc.pydot.core.Graph.del_edge(src_or_list:Any, dst:Any=None, index:int | None=None) -> bool

Delete an edge from the graph.

methodsrc.pydot.core.Graph.del_node(name:str | Node, index:int | None=None) -> bool

Delete a node from the graph.

methodsrc.pydot.core.Graph.get_edge(src_or_list:Any, dst:Any=None) -> list[Edge]

Retrieve an edge from the graph.

methodsrc.pydot.core.Graph.get_edge_list() -> list[Edge]

Get the list of Edge instances.

methodsrc.pydot.core.Graph.get_name() -> str | None

Get the graph's name.

methodsrc.pydot.core.Graph.get_node(name:str) -> list[Node]

Retrieve a node from the graph.

methodsrc.pydot.core.Graph.get_node_list() -> list[Node]

Get the list of Node instances.

methodsrc.pydot.core.Graph.get_nodes() -> list[Node]

Get the list of Node instances.

methodsrc.pydot.core.Graph.get_simplify() -> bool

Get whether to simplify or not.

methodsrc.pydot.core.Graph.get_strict() -> bool

Get graph's 'strict' mode (True, False).

methodsrc.pydot.core.Graph.get_subgraph(name:str) -> list[Subgraph]

Retrieve a subgraph from the graph.

methodsrc.pydot.core.Graph.get_subgraph_list() -> list[Subgraph]

Get the list of Subgraph instances.

methodsrc.pydot.core.Graph.get_suppress_disconnected() -> bool

Get if suppress disconnected is set.

methodsrc.pydot.core.Graph.get_type() -> str | None

Get the graph's type, 'graph' or 'digraph'.

methodsrc.pydot.core.Graph.set_name(graph_name:str) -> None

Set the graph's name.

methodsrc.pydot.core.Graph.set_node_defaults(**attrs:Any) -> None

Define default node attributes.

methodsrc.pydot.core.Graph.set_simplify(simplify:bool) -> None

Set whether to simplify or not.

methodsrc.pydot.core.Graph.set_strict(val:bool) -> None

Set graph to 'strict' mode.

methodsrc.pydot.core.Graph.set_suppress_disconnected(val:bool) -> None

Suppress disconnected nodes in the output graph.

methodsrc.pydot.core.Graph.set_type(graph_type:str) -> None

Set the graph's type, 'graph' or 'digraph'.

methodsrc.pydot.core.Graph.to_string(indent:Any='', indent_level:int=0, inline:bool=False) -> str

Return string representation of graph in DOT language.

classsrc.pydot.core.Node

A graph node.

methodsrc.pydot.core.Node.get_name() -> str

Get the node's name.

methodsrc.pydot.core.Node.get_port() -> str | None

Get the node's port.

methodsrc.pydot.core.Node.set_name(node_name:str | None) -> None

Set the node's name.

methodsrc.pydot.core.Node.to_string(indent:Any='', indent_level:int=1) -> str

Return string representation of node in DOT language.

classsrc.pydot.core.Subgraph

Class representing a subgraph in Graphviz's dot language.

funcsrc.pydot.core.any_needs_quotes(s:str) -> bool | None

Determine if a string needs to be quoted.

classsrc.pydot.core.frozendict

Deprecated alias for pydot.classes.FrozenDict.

func

src.pydot.core.graph_from_adjacency_matrix(matrix:Sequence[Sequence[Any]], node_prefix:str='', directed:bool=False) -> Dot

Creates a basic graph out of an adjacency matrix.

funcsrc.pydot.core.graph_from_dot_data(s:str) -> list[Dot] | None

Load graphs from DOT description in string `s`.

funcsrc.pydot.core.graph_from_dot_file(path:str | bytes, encoding:str | None=None) -> list[Dot] | None

Load graphs from DOT file at `path`.

funcsrc.pydot.core.graph_from_edges(edge_list:Sequence[Any], node_prefix:str='', directed:bool=False) -> Dot

Creates a basic graph out of an edge list.

func

src.pydot.core.graph_from_incidence_matrix(matrix:Sequence[Sequence[Any]], node_prefix:str='', directed:bool=False) -> Dot

Creates a basic graph out of an incidence matrix.

funcsrc.pydot.core.id_needs_quotes(s:str) -> bool

Checks whether a string is a dot language ID.

funcsrc.pydot.core.make_quoted(s:str) -> str

Transform a string into a quoted string, escaping specials.

funcsrc.pydot.core.quote_attr_if_necessary(s:str) -> str

Enclose attribute value in quotes, if needed.

funcsrc.pydot.core.quote_id_if_necessary(s:str, unquoted_keywords:Sequence[str] | None=None) -> str

Enclose identifier in quotes, if needed.

classsrc.pydot.dot_parser.GraphParser

Pyparsing grammar for graphviz 'dot' syntax.

classsrc.pydot.dot_parser.HTML

Parsing for HTML-like strings.

funcsrc.pydot.dot_parser.parse_dot_data(s:str) -> list[pydot.core.Dot] | None

Parse DOT description in (unicode) string `s`.

funcsrc.pydot.dot_parser.push_ID(toks:ParseResults) -> str

Join multiple string pieces into a single ID string.

classsrc.pydot.exceptions.Error

General error handling class.

classsrc.pydot.exceptions.PydotException

Base class for exceptions in Pydot.

About this data

These signatures were extracted from the public source of pydot/pydot using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries