使用默认参数将特定参数传递给 Boost Python 函数

Question

我正在尝试通过 Python 创建一个用于在我的游戏引擎中进行 HTTP 调用的漂亮界面，但是我运行遇到了一些问题。

我有一个函数，get_async，它为指定的 URL 发起一个 curl 请求。该函数在 http_manager class 中定义，如下所示：

struct http_manager
{
    typedef function<void(boost::shared_ptr<http_response>)> response_callback_type;
    typedef function<void(size_t)> write_callback_type;

    void get_async(
        const string& url,
        const http_headers_type& headers = http_headers_type(),
        const http_data_type& data = http_data_type(),
        response_callback_type on_response = nullptr,
        write_callback_type on_write = nullptr
        );
};

我能够在 Python 中成功拨打此电话：

http.get_async('http://www.google.ca')

不过，我想这样打电话：

http.get_async('http://www.google.ca', on_response=f)

这里的关键是我想通过名称明确指定参数并让所有其他参数成为默认值，就像在常规 Python.

中一样

不幸的是，当我这样做时，我从 Python 返回以下错误：

ArgumentError: Python argument types in
    HttpManager.get_async(HttpManager, str)
did not match C++ signature:
    get_async(struct naga::http_manager {lvalue}, class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > url)
    get_async(struct naga::http_manager {lvalue}, class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > url, class std::vector<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > >,class std::allocator<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > > > > headers)
    get_async(struct naga::http_manager {lvalue}, class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > url, class std::vector<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > >,class std::allocator<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > > > > headers, class std::map<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,struct std::less<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > >,class std::allocator<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > const ,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > > > > data)
    get_async(struct naga::http_manager {lvalue}, class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > url, class std::vector<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > >,class std::allocator<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > > > > headers, class std::map<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,struct std::less<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > >,class std::allocator<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > const ,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > > > > data, class std::function<void __cdecl(class boost::shared_ptr<struct naga::http_response>)> on_response)
    get_async(struct naga::http_manager {lvalue}, class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > url, class std::vector<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > >,class std::allocator<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > > > > headers, class std::map<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,struct std::less<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > >,class std::allocator<struct std::pair<class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > const ,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > > > > data, class std::function<void __cdecl(class boost::shared_ptr<struct naga::http_response>)> on_response, class std::function<void __cdecl(unsigned int)> on_write)

当我清楚地传递 3 个参数（self、url 和 on_response 时，我很困惑为什么它认为参数签名是 HttpManager.get_async(HttpManager, str) ).

这是我的 BOOST_PYTHON_MODULE 区块中的相关位：

BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(http_manager_get_async_overloads, http_manager::get_async, 1, 5)

class_<http_manager, noncopyable>("HttpManager", no_init)
    .def("get_async", &http_manager::get_async, http_manager_get_async_overloads(args("url", "headers", "data", "on_response", "on_write")))
    ;

感谢您的阅读，我们将不胜感激！

Answer 1

总体问题是 C++ 仅对缺少的尾随参数使用默认参数，而 Boost.Python 没有为非尾随缺少的参数提供值。

错误信息

当Boost.Python 内部派发函数失败时，异常消息仅捕获位置参数。异常消息试图捕捉调用者的意图，但以 C++ 函数调用格式显示。由于 C++ 仅支持位置参数，因此没有明显的格式来显示非位置参数。考虑这个简单的 example:

#include <boost/python.hpp>

void f() {}

BOOST_PYTHON_MODULE(example)
{
  boost::python::def("f", &f);
}

调用 example.f(a=0) 抛出 Boost.Python.ArgumentError 并显示以下消息：

Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
Boost.Python.ArgumentError: Python argument types in
    example.f()
did not match C++ signature:
    f(void)

虽然Boost.Python完全知道调用者提供了一个参数，但异常只捕获了位置参数。在上面的例子中，没有位置参数，所以输出是 example.f()。在原始问题中，调用 http.get_async('http://www.google.ca', on_response=f) 导致显示 HttpManager.get_async(HttpManager, str) 的异常，因为仅提供了两个位置参数：类型为 HttpManager 的隐式 self 参数和一个 str 对象。

发送失败

在 C++ 中，默认参数不是函数类型的一部分。此外，当调用具有默认参数的函数时，默认参数仅在缺少尾随参数的情况下使用。例如，考虑：

void f(int a, int b=1, int c=2);

上述函数的类型为void(int, int, int)，无法调用函数f，只能为参数a和c提供实参。如果希望使用参数 c 的非默认值调用 f，则必须提供所有三个参数。

但是，如果在 Python 中声明了一个类似的函数，则可以调用 f 只为参数 a 和 c 提供参数作为 Python 支持关键字参数：

def f(a, b=1, c=2):
    pass

f(0, c=42) # Invokes f(0, b=1, c=42)

考虑这个 example，其中一个带有默认参数的 C++ 函数已作为重载 Python 函数提供：

#include <boost/python.hpp>

void f(int a, int b=1, int c=2) {}

BOOST_PYTHON_FUNCTION_OVERLOADS(f_overloads, f, 1, 3)

BOOST_PYTHON_MODULE(example)
{
  namespace python = boost::python;    
  python::def("f", &f, f_overloads(
    python::args("a", "b", "c")));
}

Boost.Python 已被告知 C++ 函数 f 的类型为 void(int, int, int)，并且可以使用最少 1 个参数和最多 3 个参数来调用。Boost.Python 也不知道默认参数值是什么。因此，Boost.Python 创建重载以支持调用：

f(int a)
f(int a, int b)
f(int, a, int b, int c)

因此，当有人试图在 Python 中调用 example.f(0, c=42) 时，函数调度将失败，因为 Boost.Python 在提供时需要为 b 提供一个值c 的值和 b 的值尚未指定。

Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
Boost.Python.ArgumentError: Python argument types in
    example.f(int)
did not match C++ signature:
    f(int a)
    f(int a, int b)
    f(int a, int b, int c)

此行为是 http.get_async('http://www.google.ca', on_response=f) 失败的原因，因为 Boost.Python 无法调用：

http_manager.get_async(url, ???, ???, on_response);

为 Python

提供默认参数

继续该示例，如果为 Python 提供了默认参数，则它可以为非尾随参数提供值。公开函数时，可以通过分配给 boost::python::arg object. The following example 公开函数 f 和默认参数来为参数提供默认值：

#include <boost/python.hpp>

void f(int a, int b=1, int c=2) {}

BOOST_PYTHON_FUNCTION_OVERLOADS(f_overloads, f, 1, 3)

BOOST_PYTHON_MODULE(example)
{
  namespace python = boost::python;    
  python::def("f", &f, f_overloads(
    (python::arg("a"), 
     python::arg("b")=1,
     python::arg("c")=2)));
}

在 Boost.Python 知道默认参数的情况下，它可以成功调用 example.f(0, c=42)。

使用默认参数将特定参数传递给 Boost Python 函数

Passing specific arguments to Boost Python function with default arguments

c++

python

boost

boost-python

错误信息

发送失败

为 Python