224 lines
7.8 KiB
Python
224 lines
7.8 KiB
Python
# Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2025)
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
"""Streamlit support for GraphViz charts."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, TypeAlias, Union, cast
|
|
|
|
from streamlit import type_util
|
|
from streamlit.deprecation_util import (
|
|
make_deprecated_name_warning,
|
|
show_deprecation_warning,
|
|
)
|
|
from streamlit.elements.lib.layout_utils import (
|
|
Height,
|
|
LayoutConfig,
|
|
Width,
|
|
validate_height,
|
|
validate_width,
|
|
)
|
|
from streamlit.errors import StreamlitAPIException
|
|
from streamlit.proto.GraphVizChart_pb2 import GraphVizChart as GraphVizChartProto
|
|
from streamlit.runtime.metrics_util import gather_metrics
|
|
from streamlit.util import calc_md5
|
|
|
|
if TYPE_CHECKING:
|
|
import graphviz
|
|
|
|
from streamlit.delta_generator import DeltaGenerator
|
|
|
|
FigureOrDot: TypeAlias = Union[
|
|
"graphviz.Graph", "graphviz.Digraph", "graphviz.Source", str
|
|
]
|
|
|
|
|
|
class GraphvizMixin:
|
|
@gather_metrics("graphviz_chart")
|
|
def graphviz_chart(
|
|
self,
|
|
figure_or_dot: FigureOrDot,
|
|
use_container_width: bool | None = None,
|
|
*, # keyword-only arguments:
|
|
width: Width = "content",
|
|
height: Height = "content",
|
|
) -> DeltaGenerator:
|
|
"""Display a graph using the dagre-d3 library.
|
|
|
|
.. Important::
|
|
You must install ``graphviz>=0.19.0`` to use this command. You can
|
|
install all charting dependencies (except Bokeh) as an extra with
|
|
Streamlit:
|
|
|
|
.. code-block:: shell
|
|
|
|
pip install streamlit[charts]
|
|
|
|
Parameters
|
|
----------
|
|
figure_or_dot : graphviz.dot.Graph, graphviz.dot.Digraph, graphviz.sources.Source, str
|
|
The Graphlib graph object or dot string to display
|
|
|
|
use_container_width : bool
|
|
Whether to override the figure's native width with the width of
|
|
the parent container. If ``use_container_width`` is ``False``
|
|
(default), Streamlit sets the width of the chart to fit its contents
|
|
according to the plotting library, up to the width of the parent
|
|
container. If ``use_container_width`` is ``True``, Streamlit sets
|
|
the width of the figure to match the width of the parent container.
|
|
|
|
.. deprecated::
|
|
``use_container_width`` is deprecated and will be removed in a
|
|
future release. For ``use_container_width=True``, use
|
|
``width="stretch"``. For ``use_container_width=False``, use
|
|
``width="content"``.
|
|
|
|
width : "content", "stretch", or int
|
|
The width of the chart element. This can be one of the following:
|
|
|
|
- ``"content"`` (default): The width of the element matches the
|
|
width of its content, but doesn't exceed the width of the parent
|
|
container.
|
|
- ``"stretch"``: The width of the element matches the width of the
|
|
parent container.
|
|
- An integer specifying the width in pixels: The element has a
|
|
fixed width. If the specified width is greater than the width of
|
|
the parent container, the width of the element matches the width
|
|
of the parent container.
|
|
|
|
height : "content", "stretch", or int
|
|
The height of the chart element. This can be one of the following:
|
|
|
|
- ``"content"`` (default): The height of the element matches the
|
|
height of its content.
|
|
- ``"stretch"``: The height of the element matches the height of
|
|
its content or the height of the parent container, whichever is
|
|
larger. If the element is not in a parent container, the height
|
|
of the element matches the height of its content.
|
|
- An integer specifying the height in pixels: The element has a
|
|
fixed height. If the content is larger than the specified
|
|
height, scrolling is enabled.
|
|
|
|
Example
|
|
-------
|
|
>>> import streamlit as st
|
|
>>> import graphviz
|
|
>>>
|
|
>>> # Create a graphlib graph object
|
|
>>> graph = graphviz.Digraph()
|
|
>>> graph.edge("run", "intr")
|
|
>>> graph.edge("intr", "runbl")
|
|
>>> graph.edge("runbl", "run")
|
|
>>> graph.edge("run", "kernel")
|
|
>>> graph.edge("kernel", "zombie")
|
|
>>> graph.edge("kernel", "sleep")
|
|
>>> graph.edge("kernel", "runmem")
|
|
>>> graph.edge("sleep", "swap")
|
|
>>> graph.edge("swap", "runswap")
|
|
>>> graph.edge("runswap", "new")
|
|
>>> graph.edge("runswap", "runmem")
|
|
>>> graph.edge("new", "runmem")
|
|
>>> graph.edge("sleep", "runmem")
|
|
>>>
|
|
>>> st.graphviz_chart(graph)
|
|
|
|
Or you can render the chart from the graph using GraphViz's Dot
|
|
language:
|
|
|
|
>>> st.graphviz_chart('''
|
|
digraph {
|
|
run -> intr
|
|
intr -> runbl
|
|
runbl -> run
|
|
run -> kernel
|
|
kernel -> zombie
|
|
kernel -> sleep
|
|
kernel -> runmem
|
|
sleep -> swap
|
|
swap -> runswap
|
|
runswap -> new
|
|
runswap -> runmem
|
|
new -> runmem
|
|
sleep -> runmem
|
|
}
|
|
''')
|
|
|
|
.. output::
|
|
https://doc-graphviz-chart.streamlit.app/
|
|
height: 600px
|
|
|
|
"""
|
|
if use_container_width is not None:
|
|
show_deprecation_warning(
|
|
make_deprecated_name_warning(
|
|
"use_container_width",
|
|
"width",
|
|
"2025-12-31",
|
|
"For `use_container_width=True`, use `width='stretch'`. "
|
|
"For `use_container_width=False`, use `width='content'`.",
|
|
include_st_prefix=False,
|
|
),
|
|
show_in_browser=False,
|
|
)
|
|
width = "stretch" if use_container_width else "content"
|
|
|
|
# Generate element ID from delta path
|
|
delta_path = self.dg._get_delta_path_str()
|
|
element_id = calc_md5(delta_path.encode())
|
|
|
|
graphviz_chart_proto = GraphVizChartProto()
|
|
|
|
marshall(graphviz_chart_proto, figure_or_dot, element_id)
|
|
|
|
# Validate and set layout configuration
|
|
validate_width(width, allow_content=True)
|
|
validate_height(height, allow_content=True)
|
|
layout_config = LayoutConfig(width=width, height=height)
|
|
|
|
return self.dg._enqueue(
|
|
"graphviz_chart", graphviz_chart_proto, layout_config=layout_config
|
|
)
|
|
|
|
@property
|
|
def dg(self) -> DeltaGenerator:
|
|
"""Get our DeltaGenerator."""
|
|
return cast("DeltaGenerator", self)
|
|
|
|
|
|
def marshall(
|
|
proto: GraphVizChartProto,
|
|
figure_or_dot: FigureOrDot,
|
|
element_id: str,
|
|
) -> None:
|
|
"""Construct a GraphViz chart object.
|
|
|
|
See DeltaGenerator.graphviz_chart for docs.
|
|
"""
|
|
|
|
if type_util.is_graphviz_chart(figure_or_dot):
|
|
dot = figure_or_dot.source
|
|
engine = figure_or_dot.engine
|
|
elif isinstance(figure_or_dot, str):
|
|
dot = figure_or_dot
|
|
engine = "dot"
|
|
else:
|
|
raise StreamlitAPIException(
|
|
f"Unhandled type for graphviz chart: {type(figure_or_dot)}"
|
|
)
|
|
|
|
proto.spec = dot
|
|
proto.engine = engine
|
|
proto.element_id = element_id
|