如何在 C++ 头文件和源文件中使用 NumPy C-API？

Question

我正在使用Boost::Python将Python代码提供给C++库。我有一个模板函数，可以将C ++类型转换为Python类型：

template <typename T> bp::object convert(T v);

这是针对各种原始类型以及一些模板类的专门库。其中一个类是N维数组，我有一个将其转换为NumPy数组的函数。我想在相应的convert特化中使用此函数，例如：

template <typename Y> bp::object convert(NDArray<Y> v);

我的主要问题是这个转换函数需要存在头文件中，因为它是模板的，但它使用NumPy的PyArray_函数，这需要在使用之前调用import_array()。目前import_array()在单例对象的构造函数中被调用，该对象的目的是提供对Python函数的访问。但似乎这样不起作用，因为默认情况下，#include <numpy/arrayobject.h>只会将PyArray_函数提供给当前编译单元。我已经尝试定义一个PY_ARRAY_UNIQUE_SYMBOL并为头文件定义NO_IMPORT_ARRAY，但这并不能防止PyArray_函数崩溃。

这是我的代码的简化表示，在“conversions.h”头文件中使用PyArray_函数时会崩溃：

#include <boost/python.hpp>
#include <numpy/numpyconfig.h>
#include <numpy/arrayobject.h>

namespace bp = boost::python;

template <typename T> bp::object convert(T v);
template <> bp::object convert<int>(int v) { return bp::long_(v); }
...
template <typename Y> bp::object convert(NDArray<Y> v)
{
... use PyArray_ functions to create and return a NumPy array
... segfaults here!
}

"Bridge.h":

#include "conversions.h"

class Bridge {
public:
    static Bridge* instance();

    // c++11 variadic template (parameter pack)
    template <typename... Args> void exec(Args... args)
    {
        ...
        fn(convert(args)...); // fn is a Python function
        ...
    }
    void foo();

private:
    Bridge();
    Bridge(const Bridge&);
    void operator=(const Bridge&);
    static Bridge* instance_;
}

"Bridge.cpp":

#include "Bridge.h"
#include <numpy/numpyconfig.h>
#include <numpy/arrayobject.h>

Bridge* Bridge::instance_ = nullptr;
Bridge* Bridge::instance() {
    if (!instance_) { instance_ = new Bridge(); }
    return instance_;
}
Bridge::Bridge() {
    Py_Initialize();
    _import_array();
    ...
}
void Bridge::foo() {
    ... // other stuff using PyArray functions
}

"main.cpp":

#include "Bridge.h"

int main(void)
{
    NDArray my_array(...);
    Bridge::instance()->exec(42, "hello", my_array); 
    return 0;
}

- joe

Answer 1

我后来了解到一个问题是，调用PyArray函数的调用应该在与NumPy初始化函数（import_array）相同的编译单元中发生。

解决此问题的一种方法是在内部“包装”PyArray_*函数并使用它们而不是直接使用NumPy API。

可能会在这里找到另一种解决方案。

我的解决方案：

创建一个“numpy_wrappers.h”文件：

...
#include "numpy/ndarraytypes.h"

int NumPyArray_NDIM(PyObject* obj);
npy_intp NumPyArray_DIM(PyObject* obj, int i);
void *NumPyArray_DATA(PyObject* obj);
...

然后通过在与您调用import_array（NumPy初始化函数）的相同源文件中包装原始函数来实现这些功能：

...
Bridge::Bridge() {
    Py_Initialize();
    _import_array();
    ...
}
...
/// Wraps PyArray_NDIM
int NumPyArray_NDIM(PyObject* obj)
{
    return PyArray_NDIM((PyArrayObject*)obj);
}

/// Wraps PyArray_DIM
npy_intp NumPyArray_DIM(PyObject* obj, int i)
{
    return PyArray_DIM((PyArrayObject*)obj, i);
}

/// Wraps PyArray_DATA
void* NumPyArray_DATA(PyObject* obj)
{
    return PyArray_DATA((PyArrayObject*)obj);
}
...

然后它们可以在模板头部中使用，如下所示：

...
template <typename Y> bp::object convert(NDArray<Y> v)
{
... use NumPyArray_ functions to create and return a NumPy array
... No more segfaults!
}
...

您可以在此处查看其详细实现，这是一个工具箱，可在C++ STL类型和Python标准类型之间无缝转换。

- joe