Add warning for supplied and default parameter collision

src/nnbench/runner.py

@@ -22,6 +22,11 @@ def _check(params: dict[str, Any], benchmarks: list[Benchmark]) -> None:
     benchmark_interface: dict[str, inspect.Parameter] = {}
     for bm in benchmarks:
         for name, param in inspect.signature(bm.fn).parameters.items():
+            if not param.default == inspect.Parameter.empty and name in params:
+                logger.warning(
+                    f"received parameter {name!r}={params[name]}, overwrite the default ({name!r}={param.default}) in function '{bm.fn.__name__}'"
+                )
+
             param_type = param.annotation
             if name in benchmark_interface and benchmark_interface[name].annotation != param_type:
                 orig_type = benchmark_interface[name].annotation

tests/test_argcheck.py

@@ -1,3 +1,4 @@
+import logging
 import os
 
 import pytest
@@ -22,3 +23,14 @@ def test_error_on_duplicate_params(typecheckfolder: str) -> None:
     with pytest.raises(TypeError, match="got non-unique types.*"):
         r = runner.AbstractBenchmarkRunner()
         r.run(benchmarks, params={"x": 1, "y": 1})
+
+
+def test_log_warn_on_overwrite_default(
+    typecheckfolder: str, caplog: pytest.LogCaptureFixture
+) -> None:
+    benchmark = os.path.join(typecheckfolder, "default_benchmarks.py")
+    r = runner.AbstractBenchmarkRunner()
+    with caplog.at_level(logging.WARNING):
+        r.run(benchmark, params={"a": 1})
+    print("TEXT", caplog.text)
+    assert "overwrite" in caplog.text

tests/typechecking/default_benchmarks.py

@@ -0,0 +1,6 @@
+import nnbench
+
+
+@nnbench.benchmark
+def add_two(a: int = 0) -> int:
+    return a + 2