I have a python function with this signature:
def post_message(self, message, *args, **kwargs):
I would like to call the function from c++ and pass to it some kwargs. Calling the function is not the problem. Knowing how to pass the kwargs is. Here is a non-working paraphrased sample:
std::string message("aMessage");
boost::python::list arguments;
arguments.append("1");
boost::python::dict options;
options["source"] = "cpp";
boost::python::object python_func = get_python_func_of_wrapped_object()
python_func(message, arguments, options)
When I exercise this code, in pdb I get (which is not what I would like):
messsage = aMessage
args = (['1'], {'source': 'cpp'})
kwargs = {}
How do you pass the options in my example in the **kwargs dictionary ?
I have seen one post suggesting to use the **options syntax (how cool is this!):
python_func(message, arguments, **options)
Unfortunately, this results in
TypeError: No to_python (by-value) converter found for C++ type: class boost::python::detail::kwds_proxy
Thank you for any help you can give.
Use the Python **kwargs parameter to allow the function to accept a variable number of keyword arguments. Inside the function, the kwargs argument is a dictionary that contains all keyword arguments as its name-value pairs. Precede double stars ( ** ) to a dictionary argument to pass it to **kwargs parameter.
Python 3.5+ allows passing multiple sets of keyword arguments ("kwargs") to a function within a single call, using the `"**"` syntax.
“ kwargs ” stands for keyword arguments. It is used for passing advanced data objects like dictionaries to a function because in such functions one doesn't have a clue about the number of arguments, hence data passed is be dealt properly by adding “**” to the passing type.
**kwargs allows us to pass a variable number of keyword arguments to a Python function. In the function, we use the double-asterisk ( ** ) before the parameter name to denote this type of argument.
After some investigation, it turns out that the object function call operator is overridden for two arguments of type args_proxy
and kwds_proxy
. So you have to use this specific call style of two arguments.
args_proxy
and kwds_proxy
are generated by the * overloads. This is really nice.
Additionally, the first argument must be a tuple type so that the python interpreter correctly handles the *args argument.
The resulting example works:
boost::python::list arguments;
arguments.append("aMessage");
arguments.append("1");
boost::python::dict options;
options["source"] = "cpp";
boost::python::object python_func = get_python_func_of_wrapped_object()
python_func(*boost::python::tuple(arguments), **options)
Hope this helps...
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With