msb-public
/
diagrams
mirror of https://github.com/mingrammer/diagrams
1
0
Code Issues Projects Releases Wiki Activity

Convert the "Cluster" class to a "Node" and extract commons to a base class

Browse Source
pull/407/head^2
Bruno Meneguello 5 years ago
parent fc9ac5bfae
commit bf6a41a512
1 changed files with 113 additions and 209 deletions
Show Stats Download Patch File Download Diff File

316
diagrams/__init__.py
Unescape View File

@ -19,7 +19,7 @@ def getdiagram():
try:
return __diagram.get()
except LookupError:
return None
raise EnvironmentError("Global diagrams context not set up")
def setdiagram(diagram):
@ -41,8 +41,60 @@ def new_init(cls, init):
cls.__init__ = init
return reset_init
class Diagram:
class _Cluster:
__directions = ("TB", "BT", "LR", "RL")
def __init__(self, name=None, **kwargs):
self.dot = Digraph(name, **kwargs)
self.depth = 0
self.nodes = {}
self.subgraphs = []
try:
self._parent = getcluster() or getdiagram()
except EnvironmentError:
self._parent = None
def __enter__(self):
setcluster(self)
return self
def __exit__(self, exc_type, exc_value, traceback):
setcluster(self._parent)
for nodeid, node in self.nodes.items():
self.dot.node(nodeid, label=node['label'], **node['attrs'])
for dot in self.subgraphs:
self.dot.subgraph(dot)
if self._parent:
self._parent.subgraph(self.dot)
def node(self, nodeid: str, label: str, **attrs) -> None:
"""Create a new node."""
self.nodes[nodeid] = {'label': label, 'attrs': attrs}
def remove_node(self, nodeid: str) -> None:
del self.nodes[nodeid]
def subgraph(self, dot: Digraph) -> None:
"""Create a subgraph for clustering"""
self.subgraphs.append(dot)
def _validate_direction(self, direction: str):
direction = direction.upper()
for v in self.__directions:
if v == direction:
return True
return False
def __str__(self) -> str:
return str(self.dot)
class Diagram(_Cluster):
__curvestyles = ("ortho", "curved")
__outformats = ("png", "jpg", "svg", "pdf")
@ -106,6 +158,7 @@ class Diagram:
:param node_attr: Provide node_attr dot config attributes.
:param edge_attr: Provide edge_attr dot config attributes.
"""
self.name = name
if not name and not filename:
filename = "diagrams_image"
@ -113,10 +166,8 @@ class Diagram:
filename = "_".join(self.name.split()).lower()
self.filename = filename
self.dot = Digraph(self.name, filename=self.filename)
self._nodes = {}
self._edges = {}
self._subgraphs = []
super().__init__(self.name, filename=self.filename)
self.edges = {}
# Set attributes.
self.dot.attr(compound="true")
@ -147,46 +198,33 @@ class Diagram:
self.show = show
def __str__(self) -> str:
return str(self.dot)
def __enter__(self):
setdiagram(self)
super().__enter__()
return self
def __exit__(self, exc_type, exc_value, traceback):
for nodeid, node in self._nodes.items():
self.dot.node(nodeid, label=node['label'], **node['attrs'])
for dot in self._subgraphs:
self.dot.subgraph(dot)
super().__exit__(exc_type, exc_value, traceback)
setdiagram(None)
for nodes, edge in self._edges.items():
for nodes, edge in self.edges.items():
node1, node2 = nodes
nodeid1, nodeid2 = node1.nodeid, node2.nodeid
if hasattr(node1, '_nodes') and node1._nodes:
if node1.nodes:
edge._attrs['ltail'] = nodeid1
nodeid1 = next(iter(node1._nodes.keys()))
if hasattr(node2, '_nodes') and node2._nodes:
nodeid1 = next(iter(node1.nodes.keys()))
if node2.nodes:
edge._attrs['lhead'] = nodeid2
nodeid2 = next(iter(node2._nodes.keys()))
nodeid2 = next(iter(node2.nodes.keys()))
self.dot.edge(nodeid1, nodeid2, **edge.attrs)
self.render()
# Remove the graphviz file leaving only the image.
os.remove(self.filename)
setdiagram(None)
def _repr_png_(self):
return self.dot.pipe(format="png")
def _validate_direction(self, direction: str) -> bool:
direction = direction.upper()
for v in self.__directions:
if v == direction:
return True
return False
def _validate_curvestyle(self, curvestyle: str) -> bool:
curvestyle = curvestyle.lower()
for v in self.__curvestyles:
@ -201,142 +239,16 @@ class Diagram:
return True
return False
def node(self, nodeid: str, label: str, **attrs) -> None:
"""Create a new node."""
self._nodes[nodeid] = {'label': label, 'attrs': attrs}
def remove_node(self, nodeid: str) -> None:
del self._nodes[nodeid]
def connect(self, node: "Node", node2: "Node", edge: "Edge") -> None:
"""Connect the two Nodes."""
self._edges[(node, node2)] = edge
def subgraph(self, dot: Digraph) -> None:
"""Create a subgraph for clustering"""
self._subgraphs.append(dot)
self.edges[(node, node2)] = edge
def render(self) -> None:
self.dot.render(format=self.outformat, view=self.show, quiet=True)
class Cluster:
__directions = ("TB", "BT", "LR", "RL")
__bgcolors = ("#E5F5FD", "#EBF3E7", "#ECE8F6", "#FDF7E3")
# fmt: off
_default_graph_attrs = {
"shape": "box",
"style": "rounded",
"labeljust": "l",
"pencolor": "#AEB6BE",
"fontname": "Sans-Serif",
"fontsize": "12",
}
_icon = None
_icon_size = 0
# fmt: on
# FIXME:
# Cluster direction does not work now. Graphviz couldn't render
# correctly for a subgraph that has a different rank direction.
def __init__(
self,
label: str = "cluster",
direction: str = "LR",
graph_attr: dict = {},
icon: object = None,
icon_size: int = 30
):
"""Cluster represents a cluster context.
:param label: Cluster label.
:param direction: Data flow direction. Default is 'left to right'.
:param graph_attr: Provide graph_attr dot config attributes.
"""
self.label = label
self.name = "cluster_" + self.label
if not self._icon:
self._icon = icon
if not self._icon_size:
self._icon_size = icon_size
self.dot = Digraph(self.name)
self._nodes = {}
self._subgraphs = []
# Set attributes.
for k, v in self._default_graph_attrs.items():
self.dot.graph_attr[k] = v
# if an icon is set, try to find and instantiate a Node without calling __init__()
# then find it's icon by calling _load_icon()
if self._icon:
_node = self._icon(_no_init=True)
if isinstance(_node,Node):
self._icon_label = '<<TABLE border="0"><TR><TD fixedsize="true" width="' + str(self._icon_size) +'" height="' + str(self._icon_size) +'"><IMG SRC="' + _node._load_icon() + '"></IMG></TD><TD>' + self.label + '</TD></TR></TABLE>>'
self.dot.graph_attr["label"] = self._icon_label
else:
self.dot.graph_attr["label"] = self.label
if not self._validate_direction(direction):
raise ValueError(f'"{direction}" is not a valid direction')
self.dot.graph_attr["rankdir"] = direction
# Node must be belong to a diagrams.
self._diagram = getdiagram()
if self._diagram is None:
raise EnvironmentError("Global diagrams context not set up")
self._parent = getcluster()
# Set cluster depth for distinguishing the background color
self.depth = self._parent.depth + 1 if self._parent else 0
coloridx = self.depth % len(self.__bgcolors)
self.dot.graph_attr["bgcolor"] = self.__bgcolors[coloridx]
# Merge passed in attributes
self.dot.graph_attr.update(graph_attr)
def __enter__(self):
setcluster(self)
return self
def __exit__(self, exc_type, exc_value, traceback):
for nodeid, node in self._nodes.items():
self.dot.node(nodeid, label=node['label'], **node['attrs'])
for dot in self._subgraphs:
self.dot.subgraph(dot)
if self._parent:
self._parent.subgraph(self.dot)
else:
self._diagram.subgraph(self.dot)
setcluster(self._parent)
def _validate_direction(self, direction: str) -> bool:
direction = direction.upper()
for v in self.__directions:
if v == direction:
return True
return False
def node(self, nodeid: str, label: str, **attrs) -> None:
"""Create a new node in the cluster."""
self._nodes[nodeid] = {'label': label, 'attrs': attrs}
def remove_node(self, nodeid: str) -> None:
del self._nodes[nodeid]
def subgraph(self, dot: Digraph) -> None:
self._subgraphs.append(dot)
class Node:
class Node(_Cluster):
"""Node represents a node for a specific backend service."""
__directions = ("TB", "BT", "LR", "RL")
__bgcolors = ("#E5F5FD", "#EBF3E7", "#ECE8F6", "#FDF7E3")
# fmt: off
@ -381,46 +293,39 @@ class Node:
self._id = self._rand_id()
self.label = label
super().__init__()
# fmt: off
# If a node has an icon, increase the height slightly to avoid
# that label being spanned between icon image and white space.
# Increase the height by the number of new lines included in the label.
padding = 0.4 * (label.count('\n'))
icon = self._load_icon()
self._attrs = {
"shape": "none",
"height": str(self._height + padding),
"image": self._load_icon(),
} if self._icon else {}
"image": icon,
} if icon else {}
# fmt: on
self._attrs.update(attrs)
# Node must be belong to a diagrams.
self._diagram = getdiagram()
if self._diagram is None:
raise EnvironmentError("Global diagrams context not set up")
self._cluster = getcluster()
# If a node is in the cluster context, add it to cluster.
if self._cluster:
self._cluster.node(self._id, self.label, **self._attrs)
else:
self._diagram.node(self._id, self.label, **self._attrs)
self._parent.node(self._id, self.label, **self._attrs)
def __enter__(self):
super().__enter__()
setcluster(self)
self.dot = Digraph()
self._nodes = {}
self._subgraphs = []
# Set attributes.
for k, v in self._default_graph_attrs.items():
self.dot.graph_attr[k] = v
if self._icon:
icon = self._load_icon()
if icon:
self.dot.graph_attr["label"] = '<<TABLE border="0"><TR>'\
'<TD fixedsize="true" width="' + str(self._icon_size) + '" height="' + str(self._icon_size) + '">'\
'<IMG SRC="' + self._load_icon() + '"></IMG></TD>'\
'<IMG SRC="' + icon + '"></IMG></TD>'\
'<TD>' + self.label + '</TD></TR></TABLE>>'
if not self._validate_direction(self._direction):
@ -428,52 +333,23 @@ class Node:
self.dot.graph_attr["rankdir"] = self._direction
# Set cluster depth for distinguishing the background color
self.depth = self._cluster.depth + 1 if self._cluster else 0
self.depth = self._parent.depth + 1
coloridx = self.depth % len(self.__bgcolors)
self.dot.graph_attr["bgcolor"] = self.__bgcolors[coloridx]
return self
def __exit__(self, exc_type, exc_value, traceback):
if not (self._nodes or self._subgraphs):
if not (self.nodes or self.subgraphs):
return
if self._cluster:
self._cluster.remove_node(self._id)
else:
self._diagram.remove_node(self._id)
self._parent.remove_node(self._id)
self._id = "cluster_" + self._id
self.dot.name = self._id
for nodeid, node in self._nodes.items():
self.dot.node(nodeid, label=node['label'], **node['attrs'])
for dot in self._subgraphs:
self.dot.subgraph(dot)
super().__exit__(exc_type, exc_value, traceback)
if self._cluster:
self._cluster.subgraph(self.dot)
else:
self._diagram.subgraph(self.dot)
setcluster(self._cluster)
def _validate_direction(self, direction: str):
direction = direction.upper()
for v in self.__directions:
if v == direction:
return True
return False
def node(self, nodeid: str, label: str, **attrs) -> None:
"""Create a new node in the cluster."""
self._nodes[nodeid] = {'label': label, 'attrs': attrs}
def remove_node(self, nodeid: str) -> None:
del self._nodes[nodeid]
def subgraph(self, dot: Digraph) -> None:
self._subgraphs.append(dot)
def __repr__(self):
_name = self.__class__.__name__
@ -562,7 +438,7 @@ class Node:
if not isinstance(node, Edge):
ValueError(f"{node} is not a valid Edge")
# An edge must be added on the global diagrams, not a cluster.
self._diagram.connect(self, node, edge)
getdiagram().connect(self, node, edge)
return node
@staticmethod
@ -570,8 +446,36 @@ class Node:
return uuid.uuid4().hex
def _load_icon(self):
if self._icon and self._icon_dir:
basedir = Path(os.path.abspath(os.path.dirname(__file__)))
return os.path.join(basedir.parent, self._icon_dir, self._icon)
return None
class Cluster(Node):
def __init__(
self,
label: str = "",
direction: str = "LR",
icon: object = None,
icon_size: int = 30,
**attrs: Dict
):
"""Cluster represents a cluster context.
:param label: Cluster label.
:param direction: Data flow direction. Default is "LR" (left to right).
:param icon: Custom icon for tihs cluster. Must be a node class or reference.
:param icon_size: The icon size. Default is 30.
"""
self._direction = direction
if icon:
_node = icon(_no_init=True)
self._icon = _node._icon
self._icon_dir = _node._icon_dir
if icon_size:
self._icon_size = icon_size
super().__init__(label, **attrs)
class Edge:

Write Preview
Loading…
Cancel
Save