当调用通过 Boost.Python 公开的函数时,Boost.Python 将查询其注册表,以根据所需的 C++ 类型为每个调用者的参数找到合适的 Python 转换器。如果找到知道如何从 Python 对象转换为 C++ 对象的转换器,那么它将使用该转换器来构造 C++ 对象。如果没有找到合适的转换器,那么 Boost.Python 将引发 ArgumentError 异常。
from-Python 转换器已注册:
- 自动用于Boost.Python支持的类型,例如
int和std::string
- 隐式用于
boost::python::class<T> 公开的类型。默认情况下,生成的 Python 类将包含 T C++ 对象的嵌入式实例,并为 Python 类注册 to-Python 和 from-Python 转换器,并使用嵌入式实例键入 T。
- 明确通过
boost::python::converter::registry::push_back()
测试可转换性和构造对象的步骤发生在两个不同的步骤中。由于没有为 boost::function<void(int)> 注册 from-Python 转换器,Boost.Python 将引发 ArgumentError 异常。 Boost.Python 不会尝试构造 boost::function<void(int)> 对象,尽管 boost::function<void(int)> 可以从 boost::python::object 构造。
要解决此问题,请考虑使用 shim 函数将 boost::function<void(int)> 的构造推迟到 boost::python::object 通过 Boost.Python 层之后:
void http_manager_get_async_aux(
http_manager& self, std::string url, boost::python::object on_response)
{
return self.get_async(url, on_response);
}
...
BOOST_PYTHON_MODULE(example)
{
namespace python = boost::python;
python::class_<http_manager>("HttpManager", python::no_init)
.def("get_async", &http_manager_get_async_aux);
...
}
这是一个完整的例子demonstrating这种方法:
#include <boost/python.hpp>
#include <boost/function.hpp>
struct http_manager
{
void get_async(std::string url, boost::function<void(int)> on_response)
{
if (on_response)
{
on_response(42);
}
}
} http;
void http_manager_get_async_aux(
http_manager& self, std::string url, boost::python::object on_response)
{
return self.get_async(url, on_response);
}
BOOST_PYTHON_MODULE(example)
{
namespace python = boost::python;
python::class_<http_manager>("HttpManager", python::no_init)
.def("get_async", &http_manager_get_async_aux);
python::scope().attr("http") = boost::ref(http);
}
互动使用:
>>> import example
>>> result = 0
>>> def f(r):
... global result
... result = r
...
>>> assert(result == 0)
>>> example.http.get_async('www.google.com', f)
>>> assert(result == 42)
>>> try:
... example.http.get_async('www.google.com', 42)
... assert(False)
... except TypeError:
... pass
...
另一种方法是为boost::function<void(int)> 显式注册一个来自Python 的转换器。这样做的好处是 所有 通过 Boost.Python 公开的函数都可以使用转换器(例如,不需要为每个函数编写 shim)。但是,需要为每种 C++ 类型注册转换。这是一个示例demonstrating 为boost::function<void(int)> 和boost::function<void(std::string)> 显式注册自定义转换器:
#include <boost/python.hpp>
#include <boost/function.hpp>
struct http_manager
{
void get_async(std::string url, boost::function<void(int)> on_response)
{
if (on_response)
{
on_response(42);
}
}
} http;
/// @brief Type that allows for registration of conversions from
/// python iterable types.
struct function_converter
{
/// @note Registers converter from a python callable type to the
/// provided type.
template <typename FunctionSig>
function_converter&
from_python()
{
boost::python::converter::registry::push_back(
&function_converter::convertible,
&function_converter::construct<FunctionSig>,
boost::python::type_id<boost::function<FunctionSig>>());
// Support chaining.
return *this;
}
/// @brief Check if PyObject is callable.
static void* convertible(PyObject* object)
{
return PyCallable_Check(object) ? object : NULL;
}
/// @brief Convert callable PyObject to a C++ boost::function.
template <typename FunctionSig>
static void construct(
PyObject* object,
boost::python::converter::rvalue_from_python_stage1_data* data)
{
namespace python = boost::python;
// Object is a borrowed reference, so create a handle indicting it is
// borrowed for proper reference counting.
python::handle<> handle(python::borrowed(object));
// Obtain a handle to the memory block that the converter has allocated
// for the C++ type.
typedef boost::function<FunctionSig> functor_type;
typedef python::converter::rvalue_from_python_storage<functor_type>
storage_type;
void* storage = reinterpret_cast<storage_type*>(data)->storage.bytes;
// Allocate the C++ type into the converter's memory block, and assign
// its handle to the converter's convertible variable.
new (storage) functor_type(python::object(handle));
data->convertible = storage;
}
};
BOOST_PYTHON_MODULE(example)
{
namespace python = boost::python;
python::class_<http_manager>("HttpManager", python::no_init)
.def("get_async", &http_manager::get_async);
python::scope().attr("http") = boost::ref(http);
// Enable conversions for boost::function.
function_converter()
.from_python<void(int)>()
// Chaining is supported, so the following would enable
// another conversion.
.from_python<void(std::string)>()
;
}