跳转至

visualize_container

symphra_container.visualization.visualize_container(container, format='dot')

生成容器服务依赖关系的可视化图.

参数:

名称 类型 描述 默认
container Container

容器实例

必需
format str

输出格式, 支持 'dot' (Graphviz) 或 'mermaid'

'dot'

返回:

类型 描述
str

可视化图的字符串表示

Example

dot = visualize_container(container, format='dot')

保存为文件供 Graphviz 渲染

with open('container.dot', 'w') as f: ... f.write(dot)

或者使用 Mermaid

mermaid = visualize_container(container, format='mermaid')

源代码位于: src/symphra_container/visualization.py
def visualize_container(container: Container, format: str = "dot") -> str:
    """生成容器服务依赖关系的可视化图.

    Args:
        container: 容器实例
        format: 输出格式, 支持 'dot' (Graphviz) 或 'mermaid'

    Returns:
        可视化图的字符串表示

    Example:
        >>> dot = visualize_container(container, format='dot')
        >>> # 保存为文件供 Graphviz 渲染
        >>> with open('container.dot', 'w') as f:
        ...     f.write(dot)
        >>>
        >>> # 或者使用 Mermaid
        >>> mermaid = visualize_container(container, format='mermaid')
    """
    if format == "dot":
        return _generate_dot(container)
    if format == "mermaid":
        return _generate_mermaid(container)
    msg = f"Unsupported format: {format}"
    raise ValueError(msg)