use add_note for exceptions

Author: mscheltienne

template/utils/_checks.py

@@ -44,9 +44,10 @@ def ensure_int(item: Any, item_name: str | None = None) -> int:
         if isinstance(item, bool):
             raise TypeError
         item = int(operator.index(item))
-    except TypeError:
+    except TypeError as exc:
         item_name = "Item" if item_name is None else f"'{item_name}'"
-        raise TypeError(f"{item_name} must be an integer, got {type(item)} instead.")
+        exc.add_note(f"{item_name} must be an integer, got {type(item)} instead.")
+        raise
 
     return item
 
@@ -240,15 +241,16 @@ def ensure_path(item: Any, must_exist: bool) -> Path:
     """
     try:
         item = Path(item)
-    except TypeError:
+    except TypeError as exc:
         try:
             str_ = f"'{str(item)}' "
         except Exception:
             str_ = ""
-        raise TypeError(
+        exc.add_note(
             f"The provided path {str_}is invalid and can not be converted. Please "
             f"provide a str, an os.PathLike or a pathlib.Path object, not {type(item)}."
         )
+        raise
     if must_exist and not item.exists():
         raise FileNotFoundError(f"The provided path '{str(item)}' does not exist.")
     return item

template/utils/_docs.py

@@ -89,10 +89,11 @@ def fill_doc(f: Callable[..., Any]) -> Callable[..., Any]:
 
     try:
         f.__doc__ = docstring % indented
-    except (TypeError, ValueError, KeyError) as exp:
+    except (TypeError, ValueError, KeyError) as exc:
         funcname = f.__name__
         funcname = docstring.split("\n")[0] if funcname is None else funcname
-        raise RuntimeError(f"Error documenting {funcname}:\n{str(exp)}")
+        exc.add_note(f"Error documenting {funcname}.")
+        raise
 
     return f
 

template/utils/tests/test_docs.py

@@ -30,7 +30,7 @@ def foo():
     assert foo.__doc__ is None
 
     # test filling docstring with invalid key
-    with pytest.raises(RuntimeError, match="Error documenting"):
+    with pytest.raises(KeyError, match="Error documenting"):
 
         @fill_doc
         def foo(verbose):