pyserq.draw

pyserq.draw(path=None, *, source=None, sets={}, defs={}, format="tikz") -> str

Render the deployment view. Supply exactly one of path and source. This function accepts source or an IR file; it does not accept a compiled Program.

Parameters

Parameter	Type	Default	Description
path	str or os.PathLike	None	A .sq source file or .json IR file.

Keyword arguments

Parameter	Type	Default	Description
source	str	None	Source text, instead of a file. std/args is built in; relative file imports require path.
sets	dict[str, float or str]	{}	Declared program inputs, as in compile.
defs	dict[str, str]	{}	Expression-definition overrides.
format	str	"tikz"	"tikz" or "svg".

Returns

str — a TikZ tikzpicture or a standalone SVG document. It does not write a file. In a notebook, pass SVG output to IPython.display.SVG.

For source split into a workload and a server, the diagram shows one request's route. JSON IR is drawn whole and rejects sets and defs.

Raises

ValueError for missing or conflicting inputs, an unreadable file, invalid source/IR or overrides, or an unknown format. Wrong argument types raise TypeError.

Examples

from pathlib import Path
import pyserq

svg = pyserq.draw(source="""
fn main() {
  stage svc : fifo;
  workload {
    arrive batch(1);
  }
  server {
    run svc (cost(svc, 2));
  }
}
""", format="svg")
Path("deployment.svg").write_text(svg, encoding="utf-8")

See also

Deployment visualization, compile.