[ARROW-14732] [Python] Improve error message in compute functions when passing wrong positional/keyword arguments

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 7.0.0
• Component/s: Python
• Labels: pull-request-available
• External issue URL: https://github.com/apache/arrow/issues/30270
• Assignee: Joris Van den Bossche
• Reporter: Joris Van den Bossche
• Created: 17/Nov/21 09:07
• Updated: 11/Jan/23 08:41
• Resolved: 17/Nov/21 14:30

Description

From https://stackoverflow.com/questions/69990087/how-to-use-pyarrow-compute-is-in-function

Small example of the current error messages:

array1 = pa.array([1,2,3,4])
array2 = pa.array([1,4])

import pyarrow.compute as pc

# Using positional for value_set as well (the signature indicates with * that this are keyword
# only arguments, but the error message is still confusing compared to plain python
>>> pc.is_in(array1, array2)
...
ArrowInvalid: Function is_in accepts 1 arguments but attempted to look up kernel(s) with 2

# Using keyword for the first argument (which is allowed in pure python functions)
# gives confusing error message because it passes it to the options
>>> pc.is_in(values=array1,value_set=array2)
...
~/scipy/repos/arrow/python/pyarrow/_compute.pyx in pyarrow._compute.SetLookupOptions.__init__()

TypeError: __init__() got an unexpected keyword argument 'values'

I think it should be quite easy to improve the error messaging on this front, since we know how many arguments the kernel takes.

cc amol-

Issue Links

• links to: GitHub Pull Request #11721