Merge pull request #3378 from jdvanwijk/master

Tree: ASCII_GUIDES and TREE_GUIDES promoted to class attributes

Author: willmcgugan

CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
 ## Unreleased
 
 ### Fixed
@@ -23,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed the empty line printed in jupyter while using `Progress` https://github.com/Textualize/rich/pull/2616
 - Running tests in environment with `FORCE_COLOR` or `NO_COLOR` environment variables
 - ansi decoder will now strip problematic private escape sequences (like `\x1b7`) https://github.com/Textualize/rich/pull/3278/
+- Tree's ASCII_GUIDES and TREE_GUIDES constants promoted to class attributes
 
 ### Added
 

CONTRIBUTORS.md

@@ -71,6 +71,7 @@ The following people have contributed to the development of Rich:
 - [Gabriele N. Tornetta](https://github.com/p403n1x87)
 - [Nils Vu](https://github.com/nilsvu)
 - [Arian Mollik Wasi](https://github.com/wasi-master)
+- [Jan van Wijk](https://github.com/jdvanwijk)
 - [Handhika Yanuar Pratama](https://github.com/theDreamer911)
 - [za](https://github.com/za)
 - [Motahhar Mokfi](https://github.com/motahhar)

rich/tree.py

@@ -8,10 +8,15 @@
 from .style import Style, StyleStack, StyleType
 from .styled import Styled
 
+GuideType = Tuple[str, str, str, str]
 
 class Tree(JupyterMixin):
     """A renderable for a tree structure.
 
+    Attributes:
+        ASCII_GUIDES (GuideType): Guide lines used when Console.ascii_only is True.
+        TREE_GUIDES (List[GuideType, GuideType, GuideType]): Default guide lines.
+    
     Args:
         label (RenderableType): The renderable or str for the tree label.
         style (StyleType, optional): Style of this tree. Defaults to "tree".
@@ -21,6 +26,13 @@ class Tree(JupyterMixin):
         hide_root (bool, optional): Hide the root node. Defaults to False.
     """
 
+    ASCII_GUIDES = ("    ", "|   ", "+-- ", "`-- ")
+    TREE_GUIDES = [
+        ("    ", "│   ", "├── ", "└── "),
+        ("    ", "┃   ", "┣━━ ", "┗━━ "),
+        ("    ", "║   ", "╠══ ", "╚══ "),
+    ]
+
     def __init__(
         self,
         label: RenderableType,
@@ -83,21 +95,15 @@ def __rich_console__(
         guide_style = get_style(self.guide_style, default="") or null_style
         SPACE, CONTINUE, FORK, END = range(4)
 
-        ASCII_GUIDES = ("    ", "|   ", "+-- ", "`-- ")
-        TREE_GUIDES = [
-            ("    ", "│   ", "├── ", "└── "),
-            ("    ", "┃   ", "┣━━ ", "┗━━ "),
-            ("    ", "║   ", "╠══ ", "╚══ "),
-        ]
         _Segment = Segment
 
         def make_guide(index: int, style: Style) -> Segment:
             """Make a Segment for a level of the guide lines."""
             if options.ascii_only:
-                line = ASCII_GUIDES[index]
+                line = self.ASCII_GUIDES[index]
             else:
                 guide = 1 if style.bold else (2 if style.underline2 else 0)
-                line = TREE_GUIDES[0 if options.legacy_windows else guide][index]
+                line = self.TREE_GUIDES[0 if options.legacy_windows else guide][index]
             return _Segment(line, style)
 
         levels: List[Segment] = [make_guide(CONTINUE, guide_style)]