Feat: Add exception type before arguments (#36)

Author: adrien-berchet

dir_content_diff/__init__.py

@@ -136,10 +136,11 @@ def compare_files(ref_file, comp_file, comparator, *args, return_raw_diffs=False
             exception_args = "\n".join(str(i) for i in exception.args)
         except Exception:  # pylint: disable=broad-exception-caught
             exception_args = "UNKNOWN ERROR: Could not get information from the exception"
+        exc_type = type(exception).__name__
         return diff_msg_formatter(
             ref_file,
             comp_file,
-            reason="Exception raised: " + exception_args,
+            reason=f"Exception raised: ({exc_type}) {exception_args}",
             diff_args=args,
             diff_kwargs=kwargs,
             load_kwargs=load_kwargs,

tests/test_base.py

@@ -773,7 +773,7 @@ def bad_comparator(ref_path, test_path, *args, **kwargs):
         assert len(res) == 1
         match = re.match(
             r"The files '\S*/ref/file\.yaml' and '\S*/res/file\.yaml' are different:\n"
-            r"Exception raised: Bad\ncomparator",
+            r"Exception raised: \(RuntimeError\) Bad\ncomparator",
             res["file.yaml"],
         )
         assert match is not None
@@ -787,10 +787,9 @@ def bad_comparator_no_str(ref_path, test_path, *args, **kwargs):
         res = compare_trees(ref_tree, res_tree_equal)
 
         assert len(res) == 1
-        print(res["file.yaml"])
         match = re.match(
             r"The files '\S*/ref/file\.yaml' and '\S*/res/file\.yaml' are different:\n"
-            r"Exception raised: \(1, \('Bad\\ncomparator', 2\)\)",
+            r"Exception raised: \(RuntimeError\) \(1, \('Bad\\ncomparator', 2\)\)",
             res["file.yaml"],
         )
         assert match is not None
@@ -810,10 +809,10 @@ def bad_comparator_exception_failing(ref_path, test_path, *args, **kwargs):
         res = compare_trees(ref_tree, res_tree_equal)
 
         assert len(res) == 1
-        print(res["file.yaml"])
         match = re.match(
             r"The files '\S*/ref/file\.yaml' and '\S*/res/file\.yaml' are different:\n"
-            r"Exception raised: UNKNOWN ERROR: Could not get information from the exception",
+            r"Exception raised: \(RuntimeError\) UNKNOWN ERROR: Could not get information from "
+            r"the exception",
             res["file.yaml"],
         )
         assert match is not None