asciitree 0.4.0__py3-none-any.whl

asciitree/__init__.py

@@ -0,0 +1,76 @@
+#!/usr/bin/env python
+
+from .drawing import BoxStyle, Style
+from .traversal import DictTraversal, Traversal
+from .util import KeyArgsConstructor
+
+
+class LeftAligned(KeyArgsConstructor):
+    """Creates a renderer for a left-aligned tree.
+
+    Any attributes of the resulting class instances can be set using
+    constructor arguments."""
+
+    draw = BoxStyle()
+    "The draw style used. See :class:`~asciitree.drawing.Style`."
+    traverse = DictTraversal()
+    "Traversal method. See :class:`~asciitree.traversal.Traversal`."
+
+    def render(self, node):
+        """Renders a node. This function is used internally, as it returns
+        a list of lines. Use :func:`~asciitree.LeftAligned.__call__` instead.
+        """
+        lines = []
+
+        children = self.traverse.get_children(node)
+        lines.append(self.draw.node_label(self.traverse.get_text(node)))
+
+        for n, child in enumerate(children):
+            child_tree = self.render(child)
+
+            if n == len(children) - 1:
+                # last child does not get the line drawn
+                lines.append(self.draw.last_child_head(child_tree.pop(0)))
+                lines.extend(self.draw.last_child_tail(line) for line in child_tree)
+            else:
+                lines.append(self.draw.child_head(child_tree.pop(0)))
+                lines.extend(self.draw.child_tail(line) for line in child_tree)
+
+        return lines
+
+    def __call__(self, tree):
+        """Render the tree into string suitable for console output.
+
+        :param tree: A tree."""
+        return "\n".join(self.render(self.traverse.get_root(tree)))
+
+
+# legacy support below
+
+
+class LegacyStyle(Style):
+    def node_label(self, text):
+        return text
+
+    def child_head(self, label):
+        return "  +--" + label
+
+    def child_tail(self, line):
+        return "  |" + line
+
+    def last_child_head(self, label):
+        return "  +--" + label
+
+    def last_child_tail(self, line):
+        return "   " + line
+
+
+def draw_tree(node, child_iter=lambda n: n.children, text_str=str):
+    """Support asciitree 0.2 API.
+
+    This function solely exist to not break old code (using asciitree 0.2).
+    Its use is deprecated."""
+    return LeftAligned(
+        traverse=Traversal(get_text=text_str, get_children=child_iter),
+        draw=LegacyStyle(),
+    )(node)

asciitree/drawing.py

@@ -0,0 +1,106 @@
+from .util import KeyArgsConstructor
+
+BOX_LIGHT = {
+    "UP_AND_RIGHT": "\u2514",
+    "HORIZONTAL": "\u2500",
+    "VERTICAL": "\u2502",
+    "VERTICAL_AND_RIGHT": "\u251c",
+}  #: Unicode box-drawing glyphs, light style
+
+
+BOX_HEAVY = {
+    "UP_AND_RIGHT": "\u2517",
+    "HORIZONTAL": "\u2501",
+    "VERTICAL": "\u2503",
+    "VERTICAL_AND_RIGHT": "\u2523",
+}  #: Unicode box-drawing glyphs, heavy style
+
+
+BOX_DOUBLE = {
+    "UP_AND_RIGHT": "\u255a",
+    "HORIZONTAL": "\u2550",
+    "VERTICAL": "\u2551",
+    "VERTICAL_AND_RIGHT": "\u2560",
+}  #: Unicode box-drawing glyphs, double-line style
+
+
+BOX_ASCII = {
+    "UP_AND_RIGHT": "+",
+    "HORIZONTAL": "-",
+    "VERTICAL": "|",
+    "VERTICAL_AND_RIGHT": "+",
+}  #: Unicode box-drawing glyphs, using only ascii ``|+-`` characters.
+
+
+BOX_BLANK = {
+    "UP_AND_RIGHT": " ",
+    "HORIZONTAL": " ",
+    "VERTICAL": " ",
+    "VERTICAL_AND_RIGHT": " ",
+}  #: Unicode box-drawing glyphs, using only spaces.
+
+
+class Style(KeyArgsConstructor):
+    """Rendering style for trees."""
+
+    label_format = "{}"  #: Format for labels.
+
+    def node_label(self, text):
+        """Render a node text into a label."""
+        return self.label_format.format(text)
+
+    def child_head(self, label):
+        """Render a node label into final output."""
+        return label
+
+    def child_tail(self, line):
+        """Render a node line that is not a label into final output."""
+        return line
+
+    def last_child_head(self, label):
+        """Like :func:`~asciitree.drawing.Style.child_head` but only called
+        for the last child."""
+        return label
+
+    def last_child_tail(self, line):
+        """Like :func:`~asciitree.drawing.Style.child_tail` but only called
+        for the last child."""
+        return line
+
+
+class BoxStyle(Style):
+    """A rendering style that uses box draw characters and a common layout."""
+
+    gfx = BOX_ASCII  #: Glyhps to use.
+    label_space = 1  #: Space between glyphs and label.
+    horiz_len = 2  #: Length of horizontal lines
+    indent = 1  #: Indent for subtrees
+
+    def child_head(self, label):
+        return (
+            " " * self.indent
+            + self.gfx["VERTICAL_AND_RIGHT"]
+            + self.gfx["HORIZONTAL"] * self.horiz_len
+            + " " * self.label_space
+            + label
+        )
+
+    def child_tail(self, line):
+        return " " * self.indent + self.gfx["VERTICAL"] + " " * self.horiz_len + line
+
+    def last_child_head(self, label):
+        return (
+            " " * self.indent
+            + self.gfx["UP_AND_RIGHT"]
+            + self.gfx["HORIZONTAL"] * self.horiz_len
+            + " " * self.label_space
+            + label
+        )
+
+    def last_child_tail(self, line):
+        return (
+            " " * self.indent
+            + " " * len(self.gfx["VERTICAL"])
+            + " " * self.horiz_len
+            + line
+        )

asciitree/traversal.py

@@ -0,0 +1,46 @@
+from .util import KeyArgsConstructor
+
+
+class Traversal(KeyArgsConstructor):
+    """Traversal method.
+
+    Used by the tree rendering functions like :class:`~asciitree.LeftAligned`.
+    """
+
+    def get_children(self, node):
+        """Return a list of children of a node."""
+        raise NotImplementedError
+
+    def get_root(self, tree):
+        """Return a node representing the tree root from the tree."""
+        return tree
+
+    def get_text(self, node):
+        """Return the text associated with a node."""
+        return str(node)
+
+
+class DictTraversal(Traversal):
+    """Traversal suitable for a dictionary. Keys are tree labels, all values
+    must be dictionaries as well."""
+
+    def get_children(self, node):
+        return list(node[1].items())
+
+    def get_root(self, tree):
+        return list(tree.items())[0]
+
+    def get_text(self, node):
+        return node[0]
+
+
+class AttributeTraversal(Traversal):
+    """Attribute traversal.
+
+    Uses an attribute of a node as its list of children.
+    """
+
+    attribute = "children"  #: Attribute to use.
+
+    def get_children(self, node):
+        return getattr(node, self.attribute)

asciitree/util.py

@@ -0,0 +1,4 @@
+class KeyArgsConstructor:
+    def __init__(self, **kwargs):
+        for k, v in kwargs.items():
+            setattr(self, k, v)

asciitree-0.4.0.dist-info/METADATA

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: asciitree
+Version: 0.4.0
+Summary: Draws ASCII trees.
+Author-email: Marc Brinkmann <git@marcbrinkmann.de>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/mbr/asciitree
+Project-URL: Documentation, https://asciitree.readthedocs.io/en/stable/
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ASCII Trees
+
+```text
+asciitree
+ +-- sometimes
+ |   +-- you
+ +-- just
+ |   +-- want
+ |       +-- to
+ |       +-- draw
+ +-- trees
+ +-- in
+     +-- your
+         +-- terminal
+```
+
+```python
+from asciitree import LeftAligned
+
+tree = {
+    "asciitree": {
+        "sometimes": {"you": {}},
+        "just": {"want": {"to": {}, "draw": {}}},
+        "trees": {},
+        "in": {"your": {"terminal": {}}},
+    }
+}
+
+tr = LeftAligned()
+print(tr(tree))
+```
+
+Since Python 3.7, dictionaries preserve insertion order. On older versions, use
+`collections.OrderedDict` to preserve the tree's display order.
+
+Read the documentation at <https://asciitree.readthedocs.io/en/stable/>.

asciitree-0.4.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+asciitree/__init__.py,sha256=gb_wsi-4YiJKvb2Z8JszUpky7qpxHy521rpNZI_T2mE,2316
+asciitree/drawing.py,sha256=yrjq52Pu8F4R52TkMRaTGCH2DHZaqYxeR57QsELK6_Y,2851
+asciitree/traversal.py,sha256=NEERizljL40by7o96Ce2kwLtGlPjSS4W8kYnH9jVCHI,1145
+asciitree/util.py,sha256=mGTP0CcemVFum7rfqA-Inccy7TS-Ex5ACibysnVwTuQ,128
+asciitree-0.4.0.dist-info/licenses/LICENSE,sha256=8z8F-omd7Yenm3YxLuXk-_JDzam6E2rgze1llf7OBFQ,1063
+asciitree-0.4.0.dist-info/METADATA,sha256=oyc9K69-tUs2phUtsxZx6GR5VrKX1MNOATpfVziJctk,1036
+asciitree-0.4.0.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+asciitree-0.4.0.dist-info/top_level.txt,sha256=_raGTksZX3UafaY0sEceT6XxVcYitoHTsu_Nh9x-tdo,10
+asciitree-0.4.0.dist-info/RECORD,,

asciitree-0.4.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

asciitree-0.4.0.dist-info/licenses/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015-2026 Marc Brinkmann
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

asciitree-0.4.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+asciitree