Add initial simple integration with rich for rendering ValidationError's as a rich Tree

Author: timsavage

docs/ref/contrib/rich/index.rst

@@ -0,0 +1,33 @@
+######################
+Better CLI's with Rich
+######################
+
+Additional resources fields that include a unit.
+
+.. note::
+
+    This contrib module depends on the `Rich <https://rich.readthedocs.io/en/latest/introduction.html>`_ library::
+
+        pip install rich
+
+
+
+Render Validation Errors
+========================
+
+Generate a tree or extend an existing one from a ``ValidationError`` exception.
+
+.. code-block:: python
+
+    from rich import print
+    from odin.contrib.rich.validation_tree import validation_error_tree
+
+    try:
+        ...
+    except ValidationError as ex:
+        tree = validation_error_tree(ex)
+        print(tree)
+
+.. note::
+    A tree instance can be provided as the second argument to allow for customisations
+    to the tree root label and styles.

src/odin/contrib/rich/__init__.py

@@ -1,52 +1,4 @@
-"""Integration with Rich for nicer CLI's!"""
-from typing import Iterable, Union
+"""Integration with Rich.
 
-from rich.tree import Tree
-
-from odin.exceptions import ValidationError, NON_FIELD_ERRORS
-
-
-def _all_str(iterable: Iterable) -> bool:
-    """Does the supplied iterable only contain strings."""
-    return all(isinstance(item, str) for item in iterable)
-
-
-def _validation_error_to_tree(error_messages: Union[list, dict], tree: Tree):
-    """Internal recursive method."""
-
-    if isinstance(error_messages, dict):
-        for key, value in error_messages.items():
-
-            node = tree.add(
-                f"[yellow]:memo:" if key == NON_FIELD_ERRORS else f"[green]{key}"
-            )
-
-            _validation_error_to_tree(value, node)
-
-    elif isinstance(error_messages, list):
-        if _all_str(error_messages):
-            for message in error_messages:
-                tree.add(f"[italic]{message}", guide_style="bold")
-
-        else:
-            for idx, value in enumerate(error_messages):
-                node = tree.add(str(idx))
-                _validation_error_to_tree(value, node)
-
-    else:
-        # Shouldn't technically be possible with a valid error messages structure.
-        tree.add(f":warning: {error_messages}")
-
-
-def validation_error_to_tree(error: ValidationError, *, tree: Tree = None) -> Tree:
-    """Map a validation error into a tree.
-
-    .. codeblock:: python
-
-        error_tree = validation_error_to_tree(error)
-        print(tree)
-
-    """
-    tree = tree or Tree("[red bold]Validation Errors")
-    _validation_error_to_tree(error.error_messages, tree)
-    return tree
+https://rich.readthedocs.io/en/latest/index.html
+"""

src/odin/contrib/rich/validation_tree.py

@@ -0,0 +1,52 @@
+"""Integration with Rich for nicer CLI's!"""
+from typing import Iterable, Union
+
+from rich.tree import Tree
+
+from odin.exceptions import ValidationError, NON_FIELD_ERRORS
+
+
+def _all_str(iterable: Iterable) -> bool:
+    """Does the supplied iterable only contain strings."""
+    return all(isinstance(item, str) for item in iterable)
+
+
+def _validation_error_to_tree(error_messages: Union[list, dict], tree: Tree):
+    """Internal recursive method."""
+
+    if isinstance(error_messages, dict):
+        for key, value in error_messages.items():
+
+            node = tree.add(
+                f"[yellow]:memo:" if key == NON_FIELD_ERRORS else f"[green]{key}"
+            )
+
+            _validation_error_to_tree(value, node)
+
+    elif isinstance(error_messages, list):
+        if _all_str(error_messages):
+            for message in error_messages:
+                tree.add(f"[italic]{message}", guide_style="bold")
+
+        else:
+            for idx, value in enumerate(error_messages):
+                node = tree.add(str(idx))
+                _validation_error_to_tree(value, node)
+
+    else:
+        # Shouldn't technically be possible with a valid error messages structure.
+        tree.add(f":warning: {error_messages}")
+
+
+def validation_error_tree(error: ValidationError, *, tree: Tree = None) -> Tree:
+    """Map a validation error into a tree.
+
+    .. codeblock:: python
+
+        error_tree = validation_error_to_tree(error)
+        print(tree)
+
+    """
+    tree = tree or Tree("[red bold]Validation Errors")
+    _validation_error_to_tree(error.error_messages, tree)
+    return tree