1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
|
"""
Utilities for displaying the content of an ASDF tree.
Normally these tools only will introspect dicts, lists, and primitive values
(with an exception for arrays). However, if the object that is generated
by the converter mechanism has a __asdf_traverse__() method, then it will
call that method expecting a dict or list to be returned. The method can
return what it thinks is suitable for display.
"""
import sys
from ._node_info import create_tree
from .util import NotSet
__all__ = [
"DEFAULT_MAX_COLS",
"DEFAULT_MAX_ROWS",
"DEFAULT_SHOW_VALUES",
"render_tree",
]
DEFAULT_MAX_ROWS = 24
DEFAULT_MAX_COLS = 120
DEFAULT_SHOW_VALUES = True
def render_tree(
node,
max_rows=DEFAULT_MAX_ROWS,
max_cols=DEFAULT_MAX_COLS,
show_values=DEFAULT_SHOW_VALUES,
filters=None,
identifier="root",
refresh_extension_manager=NotSet,
extension_manager=None,
):
"""
Render a tree as text with indents showing depth.
"""
info = create_tree(
key="title",
node=node,
identifier=identifier,
filters=[] if filters is None else filters,
refresh_extension_manager=refresh_extension_manager,
extension_manager=extension_manager,
)
if info is None:
return []
renderer = _TreeRenderer(
max_rows,
max_cols,
show_values,
)
return renderer.render(info)
class _TreeRenderer:
"""
Render a _NodeInfo tree with indent showing depth.
"""
def __init__(self, max_rows, max_cols, show_values):
self._max_rows = max_rows
self._max_cols = max_cols
self._show_values = show_values
self._isatty = hasattr(sys.stdout, "isatty") and sys.stdout.isatty()
def format_bold(self, value):
"""
Wrap the input value in the ANSI escape sequence for increased intensity.
"""
return self._format_code(value, 1)
def format_faint(self, value):
"""
Wrap the input value in the ANSI escape sequence for decreased intensity.
"""
return self._format_code(value, 2)
def format_italic(self, value):
"""
Wrap the input value in the ANSI escape sequence for italic.
"""
return self._format_code(value, 3)
def _format_code(self, value, code):
if not self._isatty:
return f"{value}"
return f"\x1b[{code}m{value}\x1b[0m"
def render(self, info):
self._mark_visible(info)
lines, elided = self._render(info, set(), True)
if elided:
lines.append(self.format_faint(self.format_italic("Some nodes not shown.")))
return lines
def _mark_visible(self, root_info):
"""
Select nodes to display, respecting max_rows. Nodes at lower
depths will be prioritized.
"""
if isinstance(self._max_rows, tuple):
self._mark_visible_tuple(root_info)
else:
self._mark_visible_int(root_info)
def _mark_visible_int(self, root_info):
"""
Select nodes to display, obeying max_rows as an overall limit on
the number of lines returned.
"""
if self._max_rows is None:
return
if self._max_rows < 2:
root_info.visible = False
return
current_infos = [root_info]
# Reserve one row for the root node, and another for the
# "Some nodes not shown." message.
rows_left = self._max_rows - 2
while True:
next_infos = []
for info in current_infos:
if rows_left >= len(info.children):
rows_left -= len(info.children)
next_infos.extend(info.children)
elif rows_left > 1:
for child in info.children[rows_left - 1 :]:
child.visible = False
next_infos.extend(info.children[0 : rows_left - 1])
rows_left = 0
else:
for child in info.children:
child.visible = False
if len(next_infos) == 0:
break
current_infos = next_infos
def _mark_visible_tuple(self, root_info):
"""
Select nodes to display, obeying the per-node max_rows value for
each tree depth.
"""
max_rows = (None, *self._max_rows)
current_infos = [root_info]
while True:
next_infos = []
for info in current_infos:
if info.depth + 1 < len(max_rows):
rows_left = max_rows[info.depth + 1]
if rows_left is None or rows_left >= len(info.children):
next_infos.extend(info.children)
elif rows_left > 1:
for child in info.children[rows_left - 1 :]:
child.visible = False
next_infos.extend(info.children[0 : rows_left - 1])
else:
for child in info.children:
child.visible = False
else:
for child in info.children:
child.visible = False
if len(next_infos) == 0:
break
current_infos = next_infos
def _render(self, info, active_depths, is_tail):
"""
Render the tree. Called recursively on child nodes.
is_tail indicates if the child is the last of the children,
needed to indicate the proper connecting character in the tree
display. Likewise, active_depths is used to track which preceding
depths are incomplete thus need continuing lines preceding in
the tree display.
"""
lines = []
if info.visible is False:
return lines, True
lines.append(self._render_node(info, active_depths, is_tail))
elided = len(info.visible_children) < len(info.children)
for i, child in enumerate(info.visible_children):
if i == len(info.children) - 1:
child_is_tail = True
child_active_depths = active_depths
else:
child_is_tail = False
child_active_depths = active_depths.union({info.depth})
child_list, child_elided = self._render(child, child_active_depths, child_is_tail)
lines.extend(child_list)
elided = elided or child_elided
num_visible_children = len(info.visible_children)
if num_visible_children > 0 and num_visible_children != len(info.children):
hidden_count = len(info.children) - num_visible_children
prefix = self._make_prefix(info.depth + 1, active_depths, True)
message = self.format_faint(self.format_italic(str(hidden_count) + " not shown"))
lines.append(f"{prefix}{message}")
return lines, elided
def _render_node(self, info, active_depths, is_tail):
prefix = self._make_prefix(info.depth, active_depths, is_tail)
value = self._render_node_value(info)
line = (
f"{prefix}[{self.format_bold(info.identifier)}] {value}"
if isinstance(info.parent_node, (list, tuple))
else f"{prefix}{self.format_bold(info.identifier)} {value}"
)
if info.info is not None:
line = line + self.format_faint(self.format_italic(" # " + info.info))
visible_children = info.visible_children
if len(visible_children) == 0 and len(info.children) > 0:
line = line + self.format_italic(" ...")
if info.recursive:
line = line + " " + self.format_faint(self.format_italic("(recursive reference)"))
if self._max_cols is not None and len(line) > self._max_cols:
message = " (truncated)"
line = line[0 : (self._max_cols - len(message))] + self.format_faint(self.format_italic(message))
return line
def _render_node_value(self, info):
rendered_type = type(info.node).__name__
if not info.children and self._show_values:
try:
s = f"{info.node}"
except Exception:
# if __str__ fails, don't fail info, instead use an empty string
s = ""
# if __str__ returns multiple lines also use an empty string
if len(s.splitlines()) > 1:
s = ""
# if s is empty use the non-_show_values format below
if s:
return f"({rendered_type}): {s}"
return f"({rendered_type})"
def _make_prefix(self, depth, active_depths, is_tail):
"""
Create a prefix for a displayed node, accounting for depth
and including lines that show connections to other nodes.
"""
prefix = ""
if depth < 1:
return prefix
if depth >= 2:
for n in range(0, depth - 1):
prefix = prefix + "│ " if n in active_depths else prefix + " "
prefix = prefix + "└─" if is_tail else prefix + "├─"
return self.format_faint(prefix)
|