GH-83901: Improve Signature.bind error message for missing keyword-on…

…ly params (#95347) Fixes GH-83901
python · Oct 7, 2022 · f4f8133 · f4f8133
1 parent 5eaf4d6
commit f4f8133
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/Lib/inspect.py b/Lib/inspect.py
@@ -3102,8 +3102,12 @@ def _bind(self, args, kwargs, *, partial=False):
                             parameters_ex = (param,)
                             break
                         else:
-                            msg = 'missing a required argument: {arg!r}'
-                            msg = msg.format(arg=param.name)
+                            if param.kind == _KEYWORD_ONLY:
+                                argtype = ' keyword-only'
+                            else:
+                                argtype = ''
+                            msg = 'missing a required{argtype} argument: {arg!r}'
+                            msg = msg.format(arg=param.name, argtype=argtype)
                             raise TypeError(msg) from None
             else:
                 # We have a positional argument to process

diff --git a/Lib/test/test_inspect.py b/Lib/test/test_inspect.py
@@ -3898,7 +3898,8 @@ def test(foo, *, bar):
             self.call(test, 1, bar=2, spam='ham')
 
         with self.assertRaisesRegex(TypeError,
-                                     "missing a required argument: 'bar'"):
+                                     "missing a required keyword-only "
+                                     "argument: 'bar'"):
             self.call(test, 1)
 
         def test(foo, *, bar, **bin):

diff --git a/Misc/NEWS.d/next/Library/2022-07-27-19-47-51.gh-issue-83901.OSw06c.rst b/Misc/NEWS.d/next/Library/2022-07-27-19-47-51.gh-issue-83901.OSw06c.rst
@@ -0,0 +1 @@
+Improve :meth:`Signature.bind <inspect.Signature.bind>` error message for missing keyword-only arguments.