graphviz API reference

61 public APIs from graphviz (xflr6/graphviz) — 24 classes, 23 functions, 14 methods. Signatures extracted by static analysis of the actual source.

Repository: xflr6/graphviz

Kind	Count
Classes	24
Functions	23
Methods	14

API list

funcgraphviz._compat.get_startupinfo() -> None

Return None for startupinfo argument of ``subprocess.Popen``.

funcgraphviz._defaults.set_default_engine(engine:str) -> str

Change the default ``engine`` and return the old default value.

funcgraphviz._defaults.set_default_format(format:str) -> str

Change the default ``format`` and return the old default value.

funcgraphviz._tools.attach(object:Any, name:str) -> Callable

Return a decorator doing ``setattr(object, name)`` with its argument.

funcgraphviz._tools.nulldecorator(func)

Return the undecorated function.

funcgraphviz._tools.promote_pathlike(filepath:os.PathLike[str] | str) -> pathlib.Path

Return path object for path-like-object.

classgraphviz.backend.mixins.Pipe

Parameters for calling and calling ``graphviz.pipe()``.

classgraphviz.backend.mixins.Render

Parameters for calling and calling ``graphviz.render()``.

funcgraphviz.backend.rendering.get_filepath(outfile:os.PathLike[str] | str) -> pathlib.Path

Return ``outfile.with_suffix('.gv')``.

funcgraphviz.backend.rendering.infer_format(outfile:pathlib.Path) -> str

Return format inferred from outfile suffix.

funcgraphviz.backend.viewing.view_darwin(filepath:os.PathLike[str] | str, *quiet:bool) -> None

Open filepath with its default application (mac).

funcgraphviz.backend.viewing.view_windows(filepath:os.PathLike[str] | str, *quiet:bool) -> None

Start filepath with its associated application (windows).

classgraphviz.base.Base

LineIterator with ``.source`` attribute, that it returns for ``str()``.

classgraphviz.copying.CopyBase

Create new instance copies with cooperative ``super()`` calls.

methodgraphviz.copying.CopyBase.copy()

Return a copied instance of the object.

classgraphviz.dot.DigraphSyntax

DOT digraph head and edge syntax.

classgraphviz.dot.Dot

Assemble DOT source code.

methodgraphviz.dot.Dot.attr(kw:str | None=None, _attributes=None, **attrs:str) -> None

Add a general or graph/node/edge attribute statement.

methodgraphviz.dot.Dot.clear(keep_attrs:bool=False) -> None

Reset content to an empty body, clear graph/node/egde_attr mappings.

methodgraphviz.dot.Dot.edge(tail_name:str, head_name:str, label:str | None=None, _attributes=None, **attrs:str) -> None

Create an edge between two nodes.

methodgraphviz.dot.Dot.edges(tail_head_iter:Iterable[tuple[str, str]]) -> None

Create a bunch of edges.

methodgraphviz.dot.Dot.node(name:str, label:str | None=None, _attributes=None, **attrs:str) -> None

Create a node.

classgraphviz.dot.GraphSyntax

DOT graph head and edge syntax.

funcgraphviz.dot.comment(line:str) -> str

Return comment header line.

funcgraphviz.dot.digraph_edge(*tail:str, *head:str, *attr:str) -> str

Return DOT digraph edge statement line.

funcgraphviz.dot.digraph_head(name:str) -> str

Return DOT digraph head line.

funcgraphviz.dot.graph_edge(*tail:str, *head:str, *attr:str) -> str

Return DOT graph edge statement line.

funcgraphviz.dot.graph_head(name:str) -> str

Return DOT graph head line.

funcgraphviz.dot.node(left:str, right:str) -> str

Return DOT node statement line.

funcgraphviz.dot.subgraph(name:str) -> str

Return DOT subgraph head line.

funcgraphviz.dot.subgraph_plain(name:str) -> str

Return plain DOT subgraph head line.

classgraphviz.encoding.Encoding

Encoding used for input and output with ``'utf-8'`` default.

methodgraphviz.encoding.Encoding.encoding() -> str

The encoding for the saved source file.

classgraphviz.exceptions.FileExistsError

:exc:`FileExistsError` raised with ``raise_if_exists=True``.

classgraphviz.exceptions.RequiredArgumentError

:exc:`TypeError` raised if a required argument is missing.

classgraphviz.graphs.BaseGraph

Dot language creation and source code rendering.

methodgraphviz.graphs.BaseGraph.source() -> str

The generated DOT source code as string.

classgraphviz.graphs.Digraph

Directed graph source code in the DOT language.

methodgraphviz.graphs.Digraph.directed() -> bool

``True``

classgraphviz.graphs.Graph

Graph source code in the DOT language.

methodgraphviz.graphs.Graph.directed() -> bool

``False``

classgraphviz.parameters.base.ParameterBase

Rendering parameter.

classgraphviz.parameters.engines.Engine

Rendering engine parameter with ``'dot''`` default.

classgraphviz.parameters.formats.Format

Rendering format parameter with ``'pdf'`` default.

classgraphviz.parameters.formatters.Formatter

Rendering engine parameter (no default).

classgraphviz.parameters.renderers.Renderer

Rendering renderer parameter (no default).

classgraphviz.piping.Pipe

Pipe source lines through the Graphviz layout command.

classgraphviz.quoting.NoHtml

String subclass that does not treat ``'<...>'`` as DOT HTML string.

func

graphviz.quoting.a_list(label:str | None=None, kwargs:Mapping[str, str] | None=None, attributes:Mapping[str, str] | Sequence[tuple[str, str]] | None=None) -> str

Return assembled DOT a_list string.

func

graphviz.quoting.attr_list(label:str | None=None, kwargs:Mapping[str, str] | None=None, attributes:Mapping[str, str] | Sequence[tuple[str, str]] | None=None) -> str

Return assembled DOT attribute list string.

funcgraphviz.quoting.escape(s:str) -> str

Return string disabling special meaning of backslashes and ``'<...>'``.

funcgraphviz.quoting.nohtml(s:str) -> str

Return string not treating ``'<...>'`` as DOT HTML string in quoting.

funcgraphviz.quoting.quote_edge(identifier:str) -> str

Return DOT edge statement node_id from string, quote if needed.

classgraphviz.rendering.Render

Write source lines to file and render with Graphviz.

classgraphviz.saving.Save

Save DOT source lines to file.

methodgraphviz.saving.Save.filepath() -> str

The target path for saving the DOT source file.

method

graphviz.saving.Save.save(filename:os.PathLike[str] | str | None=None, directory:os.PathLike[str] | str | None=None, *skip_existing:bool | None=False) -> str

Save the DOT source to file.

classgraphviz.sources.Source

Verbatim DOT source code string to be rendered by Graphviz.

method

graphviz.sources.Source.save(filename:os.PathLike[str] | str | None=None, directory:os.PathLike[str] | str | None=None, *skip_existing:bool | None=None) -> str

Save the DOT source to file.

methodgraphviz.sources.Source.source() -> str

The DOT source code as string.

classgraphviz.unflattening.Unflatten

Pipe source through the Graphviz *unflatten* preprocessor.

About this data

These signatures were extracted from the public source of xflr6/graphviz 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