Colored compact view

Author: mauvilsa

deepdiff/colored_view.py

@@ -17,10 +17,11 @@
 class ColoredView:
     """A view that shows JSON with color-coded differences."""
 
-    def __init__(self, t2, tree_results, verbose_level=1):
+    def __init__(self, t2, tree_results, verbose_level=1, compact=False):
         self.t2 = t2
         self.tree = tree_results
         self.verbose_level = verbose_level
+        self.compact = compact
         self.diff_paths = self._collect_diff_paths()
 
     def _collect_diff_paths(self) -> Dict[str, str]:
@@ -63,11 +64,16 @@ def _get_path_removed(self, path: str) -> dict:
                     removed[literal_eval(key_suffix[1:-1])] = value[1]
         return removed
 
+    def _has_differences(self, path_prefix: str) -> bool:
+        """Check if a path prefix has any differences under it."""
+        return any(diff_path.startswith(path_prefix + "[") for diff_path in self.diff_paths)
+
     def _colorize_json(self, obj: Any, path: str = 'root', indent: int = 0) -> str:
         """Recursively colorize JSON based on differences, with pretty-printing."""
         INDENT = '  '
         current_indent = INDENT * indent
         next_indent = INDENT * (indent + 1)
+
         if path in self.diff_paths and path not in self._colorize_skip_paths:
             diff_type, old, new = self.diff_paths[path]
             if diff_type == 'changed':
@@ -77,6 +83,9 @@ def _colorize_json(self, obj: Any, path: str = 'root', indent: int = 0) -> str:
             elif diff_type == 'removed':
                 return f"{RED}{self._format_value(old)}{RESET}"
 
+        if isinstance(obj, (dict, list)) and self.compact and not self._has_differences(path):
+            return '{...}' if isinstance(obj, dict) else '[...]'
+
         if isinstance(obj, dict):
             if not obj:
                 return '{}'
@@ -99,6 +108,7 @@ def _colorize_json(self, obj: Any, path: str = 'root', indent: int = 0) -> str:
             removed_map = self._get_path_removed(path)
             for index in removed_map:
                 self._colorize_skip_paths.add(f"{path}[{index}]")
+
             items = []
             index = 0
             for value in obj:

deepdiff/commands.py

@@ -54,8 +54,8 @@ def cli():
 @click.option('--significant-digits', required=False, default=None, type=int, show_default=True)
 @click.option('--truncate-datetime', required=False, type=click.Choice(['second', 'minute', 'hour', 'day'], case_sensitive=True), show_default=True, default=None)
 @click.option('--verbose-level', required=False, default=1, type=click.IntRange(0, 2), show_default=True)
+@click.option('--view', required=False, type=click.Choice(['-', 'colored', 'colored_compact'], case_sensitive=True), show_default=True, default="-")
 @click.option('--debug', is_flag=True, show_default=False)
-@click.option('--view', required=False, type=click.Choice(['tree', 'colored'], case_sensitive=True), show_default=True, default="text")
 def diff(
     *args, **kwargs
 ):
@@ -113,7 +113,7 @@ def diff(
         sys.stdout.buffer.write(delta.dumps())
     else:
         try:
-            if kwargs["view"] == 'colored':
+            if kwargs["view"] in {'colored', 'colored_compact'}:
                 print(diff)
             else:
                 print(diff.to_json(indent=2))

deepdiff/diff.py

@@ -25,7 +25,7 @@
                              type_is_subclass_of_type_group, type_in_type_group, get_doc,
                              number_to_string, datetime_normalize, KEY_TO_VAL_STR, booleans,
                              np_ndarray, np_floating, get_numpy_ndarray_rows, RepeatedTimer,
-                             TEXT_VIEW, TREE_VIEW, DELTA_VIEW, COLORED_VIEW, detailed__dict__, add_root_to_paths,
+                             TEXT_VIEW, TREE_VIEW, DELTA_VIEW, COLORED_VIEW, COLORED_COMPACT_VIEW, __dict__, add_root_to_paths,
                              np, get_truncate_datetime, dict_, CannotCompare, ENUM_INCLUDE_KEYS,
                              PydanticBaseModel, Opcode, SetOrdered, ipranges)
 from deepdiff.serialization import SerializationMixin
@@ -81,7 +81,7 @@ def _report_progress(_stats, progress_logger, duration):
 PREVIOUS_DIFF_COUNT = 'PREVIOUS DIFF COUNT'
 PREVIOUS_DISTANCE_CACHE_HIT_COUNT = 'PREVIOUS DISTANCE CACHE HIT COUNT'
 CANT_FIND_NUMPY_MSG = 'Unable to import numpy. This must be a bug in DeepDiff since a numpy array is detected.'
-INVALID_VIEW_MSG = 'The only valid values for the view parameter are text and tree. But {} was passed.'
+INVALID_VIEW_MSG = "view parameter must be one of 'text', 'tree', 'delta', 'colored' or 'colored_compact'. But {} was passed."
 CUTOFF_RANGE_ERROR_MSG = 'cutoff_distance_for_pairs needs to be a positive float max 1.'
 VERBOSE_LEVEL_RANGE_MSG = 'verbose_level should be 0, 1, or 2.'
 PURGE_LEVEL_RANGE_MSG = 'cache_purge_level should be 0, 1, or 2.'
@@ -366,7 +366,7 @@ def _group_by_sort_key(x):
 
             self.tree.remove_empty_keys()
             view_results = self._get_view_results(self.view)
-            if self.view == COLORED_VIEW:
+            if self.view in {COLORED_VIEW, COLORED_COMPACT_VIEW}:
                 self._colored_view = view_results
             else:
                 self.update(view_results)
@@ -1764,7 +1764,9 @@ def _get_view_results(self, view):
         elif view == DELTA_VIEW:
             result = self._to_delta_dict(report_repetition_required=False)
         elif view == COLORED_VIEW:
-            result = ColoredView(self.t2, tree_results=self.tree, verbose_level=self.verbose_level)
+            result = ColoredView(self.t2, tree_results=result, verbose_level=self.verbose_level)
+        elif view == COLORED_COMPACT_VIEW:
+            result = ColoredView(self.t2, tree_results=result, verbose_level=self.verbose_level, compact=True)
         else:
             raise ValueError(INVALID_VIEW_MSG.format(view))
         return result
@@ -1906,7 +1908,7 @@ def affected_root_keys(self):
         return result
 
     def __str__(self):
-        if hasattr(self, '_colored_view') and self.view == COLORED_VIEW:
+        if hasattr(self, '_colored_view') and self.view in {COLORED_VIEW, COLORED_COMPACT_VIEW}:
             return str(self._colored_view)
         return super().__str__()
 

deepdiff/helper.py

@@ -210,6 +210,7 @@ class IndexedHash(NamedTuple):
 TEXT_VIEW = 'text'
 DELTA_VIEW = '_delta'
 COLORED_VIEW = 'colored'
+COLORED_COMPACT_VIEW = 'colored_compact'
 
 ENUM_INCLUDE_KEYS = ['__objclass__', 'name', 'value']
 

docs/colored_view.rst

@@ -23,8 +23,8 @@ To use the `ColoredView`, simply pass the `COLORED_VIEW` option to the `DeepDiff
     from deepdiff import DeepDiff
     from deepdiff.helper import COLORED_VIEW
 
-    t1 = {"name": "John", "age": 30, "scores": [1, 2, 3]}
-    t2 = {"name": "John", "age": 31, "scores": [1, 2, 4], "new": "value"}
+    t1 = {"name": "John", "age": 30, "scores": [1, 2, 3], "address": {"city": "New York", "zip": "10001"}}
+    t2 = {"name": "John", "age": 31, "scores": [1, 2, 4], "address": {"city": "Boston", "zip": "10001"}, "new": "value"}
 
     diff = DeepDiff(t1, t2, view=COLORED_VIEW)
     print(diff)
@@ -35,9 +35,6 @@ Or from command line:
 
     deep diff --view colored t1.json t2.json
 
-Example Output
---------------
-
 The output will look something like this:
 
 .. raw:: html
@@ -58,3 +55,47 @@ The output will look something like this:
       <span style="color: #00aa00">"new": "value"</span>
     }
     </pre>
+
+Colored Compact View
+--------------------
+
+For a more concise output, especially with deeply nested objects where many parts are unchanged,
+the `ColoredView` with the compact option can be used. This view is similar but collapses
+unchanged nested dictionaries to `{...}` and unchanged lists/tuples to `[...]`. To use the compact
+option do:
+
+.. code-block:: python
+
+    from deepdiff import DeepDiff
+    from deepdiff.helper import COLORED_COMPACT_VIEW
+
+    t1 = {"name": "John", "age": 30, "scores": [1, 2, 3], "address": {"city": "New York", "zip": "10001"}}
+    t2 = {"name": "John", "age": 31, "scores": [1, 2, 4], "address": {"city": "New York", "zip": "10001"}, "new": "value"}
+
+    diff = DeepDiff(t1, t2, view=COLORED_COMPACT_VIEW)
+    print(diff)
+
+Or from command line:
+
+.. code-block:: bash
+
+    deep diff --view colored_compact t1.json t2.json
+
+
+The output will look something like this:
+
+.. raw:: html
+
+    <pre style="background-color: #f8f8f8; padding: 1em; border-radius: 4px;">
+    {
+      "name": "John",
+      "age": <span style="color: #ff0000">30</span> -> <span style="color: #00aa00">31</span>,
+      "scores": [
+        1,
+        2,
+        <span style="color: #ff0000">3</span> -> <span style="color: #00aa00">4</span>
+      ],
+      "address": {...},
+      <span style="color: #00aa00">"new": "value"</span>
+    }
+    </pre>

docs/commandline.rst

@@ -72,6 +72,9 @@ to get the options:
       --significant-digits INTEGER
       --truncate-datetime [second|minute|hour|day]
       --verbose-level INTEGER RANGE   [default: 1]
+      --view [-|colored|colored_compact]
+                                      [default: -]
+                                      Format for displaying differences.
       --help                          Show this message and exit.
 
 
@@ -109,6 +112,12 @@ The path is perhaps more readable now: `root['Molotov']['zip']`. It is more clea
 .. Note::
     The parameters in the deep diff commandline are a subset of those in :ref:`deepdiff_module_label` 's Python API.
 
+To output in a specific format, for example the colored compact view (see :doc:`colored_view` for output details):
+
+.. code-block:: bash
+
+    $ deep diff t1.json t2.json --view colored_compact
+
 
 .. _deep_grep_command:
 

docs/view.rst

@@ -9,6 +9,7 @@ You have the options of text view and tree view.
 The main difference is that the tree view has the capabilities to traverse the objects to see what objects were compared to what other objects.
 
 While the view options decide the format of the output that is mostly machine readable, regardless of the view you choose, you can get a more human readable output by using the pretty() method.
+DeepDiff also offers other specialized views such as the :doc:`colored_view` (which includes a compact variant) and :doc:`delta` view for specific use cases.
 
 .. _text_view_label: