feat: more informative error message

neithere · Oct 23, 2023 · 544b04f · 544b04f
1 parent 54f348b
commit 544b04f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/src/argh/assembling.py b/src/argh/assembling.py
@@ -415,7 +415,10 @@ def _merge_inferred_and_declared_args(
                 kind_declared = kinds[decl_positional]
                 raise AssemblingError(
                     f'argument "{func_arg_name}" declared as {kind_inferred} '
-                    f"(in function signature) and {kind_declared} (via decorator)"
+                    f"(in function signature) and {kind_declared} (via decorator). "
+                    "If you've just migrated from Argh v.0.29, please check "
+                    "the new default NameMappingPolicy. Perhaps you need "
+                    "to replace `func(x=1)` with `func(*, x=1)`?"
                 )
 
             # merge explicit argument declaration into the inferred one

diff --git a/tests/test_regressions.py b/tests/test_regressions.py
@@ -116,7 +116,9 @@ def func(foo_bar):
         parser.set_default_command(func)
     msg = (
         'func: argument "foo_bar" declared as positional (in function '
-        "signature) and optional (via decorator)"
+        "signature) and optional (via decorator). If you've just migrated "
+        "from Argh v.0.29, please check the new default NameMappingPolicy. "
+        "Perhaps you need to replace `func(x=1)` with `func(*, x=1)`?"
     )
     assert excinfo.exconly().endswith(msg)