Blobs.graph#

Blobs.graph(format: str = 'dot', filename: str | TextIOBase | None = None, direction: str | None = None) → str[source][source]#

Render blob hierarchy graph text.

Parameters:

  • format (str, optional) – graph output format: "dot", "mermaid", "mermaid_fenced", "graphml" or "elk"

  • filename (str | file handle | None, optional) – destination path or open text stream, defaults to None

  • direction (str, optional) – graph direction for DOT output, defaults to None

Returns:

rendered graph text

Return type:

str

Creates graph text representing the blob hierarchy. If filename is provided, the rendered text is also written to it.

Mermaid outputs:

  • "mermaid" returns plain Mermaid text.

  • "mermaid_fenced" returns Markdown fenced text suitable for

    direct display via IPython.display.Markdown.

The blob hierarchy is represented as a directed graph where each node is a blob id and each edge points from parent blob to child blob.

Seealso:

dotfile parent children level