Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3.13] gh-87106: Fix inspect.signature.bind() handling of positional-only arguments with **kwargs (GH-103404) #118985

Merged
merged 1 commit into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions Lib/inspect.py
Original file line number Diff line number Diff line change
Expand Up @@ -3106,6 +3106,8 @@ def _bind(self, args, kwargs, *, partial=False):
parameters_ex = ()
arg_vals = iter(args)

pos_only_param_in_kwargs = []

while True:
# Let's iterate through the positional arguments and corresponding
# parameters
Expand All @@ -3126,10 +3128,10 @@ def _bind(self, args, kwargs, *, partial=False):
break
elif param.name in kwargs:
if param.kind == _POSITIONAL_ONLY:
msg = '{arg!r} parameter is positional only, ' \
'but was passed as a keyword'
msg = msg.format(arg=param.name)
raise TypeError(msg) from None
# Raise a TypeError once we are sure there is no
# **kwargs param later.
pos_only_param_in_kwargs.append(param)
continue
parameters_ex = (param,)
break
elif (param.kind == _VAR_KEYWORD or
Expand Down Expand Up @@ -3211,20 +3213,22 @@ def _bind(self, args, kwargs, *, partial=False):
format(arg=param_name)) from None

else:
if param.kind == _POSITIONAL_ONLY:
# This should never happen in case of a properly built
# Signature object (but let's have this check here
# to ensure correct behaviour just in case)
raise TypeError('{arg!r} parameter is positional only, '
'but was passed as a keyword'. \
format(arg=param.name))

arguments[param_name] = arg_val

if kwargs:
if kwargs_param is not None:
# Process our '**kwargs'-like parameter
arguments[kwargs_param.name] = kwargs
elif pos_only_param_in_kwargs:
raise TypeError(
'got some positional-only arguments passed as '
'keyword arguments: {arg!r}'.format(
arg=', '.join(
param.name
for param in pos_only_param_in_kwargs
),
),
)
else:
raise TypeError(
'got an unexpected keyword argument {arg!r}'.format(
Expand Down
25 changes: 20 additions & 5 deletions Lib/test/test_inspect/test_inspect.py
Original file line number Diff line number Diff line change
Expand Up @@ -5089,15 +5089,30 @@ def test(a_po, b_po, c_po=3, /, foo=42, *, bar=50, **kwargs):
self.assertEqual(self.call(test, 1, 2, foo=4, bar=5),
(1, 2, 3, 4, 5, {}))

with self.assertRaisesRegex(TypeError, "but was passed as a keyword"):
self.call(test, 1, 2, foo=4, bar=5, c_po=10)
self.assertEqual(self.call(test, 1, 2, foo=4, bar=5, c_po=10),
(1, 2, 3, 4, 5, {'c_po': 10}))

with self.assertRaisesRegex(TypeError, "parameter is positional only"):
self.call(test, 1, 2, c_po=4)
self.assertEqual(self.call(test, 1, 2, 30, c_po=31, foo=4, bar=5),
(1, 2, 30, 4, 5, {'c_po': 31}))

with self.assertRaisesRegex(TypeError, "parameter is positional only"):
self.assertEqual(self.call(test, 1, 2, 30, foo=4, bar=5, c_po=31),
(1, 2, 30, 4, 5, {'c_po': 31}))

self.assertEqual(self.call(test, 1, 2, c_po=4),
(1, 2, 3, 42, 50, {'c_po': 4}))

with self.assertRaisesRegex(TypeError, "missing 2 required positional arguments"):
self.call(test, a_po=1, b_po=2)

def without_var_kwargs(c_po=3, d_po=4, /):
return c_po, d_po

with self.assertRaisesRegex(
TypeError,
"positional-only arguments passed as keyword arguments: 'c_po, d_po'",
):
self.call(without_var_kwargs, c_po=33, d_po=44)

def test_signature_bind_with_self_arg(self):
# Issue #17071: one of the parameters is named "self
def test(a, self, b):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fixed handling in :meth:`inspect.signature.bind` of keyword arguments having
the same name as positional-only arguments when a variadic keyword argument
(e.g. ``**kwargs``) is present.
Loading