Question

使用SWIG（版本3.0.6）生成围绕C ++库的Python包装器时遇到一些麻烦。

我的问题与应用OUTPUT类型映射有关，特别是在指针/对类类型的引用的情况下。

为了说明这是我想要的标准类型，它可以工作：

// .h
int add(const long arg1,const long arg2,long& resultLong);

// interface.i
%apply long& OUTPUT { long& resultLong };
int add(const long arg1,const long arg2,long& resultLong);

// projectWrapper.py
def add(arg1, arg2):
    return _projectWrapper.add(arg1, arg2)
addTerm = _projectWrapper.add

// usage
>>> result = projectWrapper.add(2, 4)
>>> print result
[0, 6L]

您不必传入“resultLong”，但它会自动附加到结果中。太好了！

但是，当输出类型是指向类类型的指针时，这似乎并不像我预期的那样：

// .h
int GetClassType(const char* name, exportedClassType*& resultPointer);

class exportedClassType
{...}

// interface.i
%apply exportedClassType*& OUTPUT { exportedClassType*& resultPointer };    
int GetClassType(const char* name, exportedClassType*& resultPointer);

// projectWrapper.py
def GetClassType(name, resultPointer):
    return _projectWrapper.GetClassType(name, resultPointer)
GetClassType = _projectWrapper.GetClassType

问题似乎是SWIG没有像简单类型那样处理它。它仍然显示为包装函数签名中的“输入”参数。

// attempted usage
>>> classType = projectWrapper.GetClassType("name")
TypeError: GetClassType() takes exactly 2 arguments (1 given)

>>> result = 0
>>> projectWrapper.GetClassType("name", result)
Traceback (most recent call last):
File "<input>", line 1, in <module>
TypeError: in method 'GetClassType', argument 2 of type 'exportedClassType *&'

有人可以告诉我我做错了什么或者指出了我正确的方向吗？任何帮助感激不尽！感谢

Answer 1

这不是一个答案，只是对评论的反对意见不够:(

因为你需要在C ++中使用指针而Python没有指针（所以你无论如何都无法对你当前的结果做任何事情）。

你可以添加包装来隐藏指向.h的指针，正如@Jens Munk所建议的那样：

/*
 * This is the one of the only two functions that should be called from outside.
 * It takes a RegexTree and computes the set of chars that can start it.
 */

修改.i文件以调用新方法：

class exportedClassType_ptr {
public:
    exportedClassType* ptr;
    exportedClassType_ptr( exportedClassType& input ) {
        this->ptr = &input;
    }
};

int GetClassType( const char* name, exportedClassType_ptr& resultPointer ) {
    return GetClassType( name, resultPointer.ptr );
}

Python中的

写下这样的东西：

%apply exportedClassType_ptr& OUTPUT { exportedClassType_ptr& resultPointer };    
int GetClassType( const char* name, exportedClassType_ptr& resultPointer );

并使用＆＃39; realResult＆＃39;为了将来的工作。

Answer 2

这个问题在很长一段时间内都没有得到解决，所以我认为我最好提供一个问题的解决方案。 OUTPUT类型映射仅适用于简单类型，因此通过组合in和argout类型映射来提供解决方案。

考虑这种情况，我们有一个实现C ++接口SampleImpl的C ++类SampleBase，它在技术上不是一个接口，因为它涉及虚拟析构函数的实现。假设我们有一个静态函数，它返回一个错误代码和一个接口的实现。后者作为指针的引用，这就是上面的情况。

接口标题：

// Sample.hpp
#pragma once
namespace Module {
  class SampleBase {
  public:
#ifndef SWIG
    // Hint to the programmer to implement this function
    static int SampleCreate(SampleBase *&obj);
#endif
    virtual ~SampleBase() = default;
  };
}

实施标题：

// Sample_impl.hpp
#pragma once
#include "Sample.hpp"

namespace Module {
  class SampleImpl : public SampleBase {
  public:
    static int SampleCreate(Module::SampleBase *&obj);

    SampleImpl();
    virtual ~SampleImpl();
  private:
    float a;
  };
}

实现：

// Sample_impl.cpp
#include "Sample_impl.hpp"
#include <cstdio>

namespace Module {
  int SampleImpl::SampleCreate(Module::SampleBase*& obj) {
    obj = (SampleBase*) new SampleImpl();
    return 0;
  }
  SampleImpl::SampleImpl() {
    printf("SampleImpl::SampleImpl()\n");
  }

  SampleImpl::~SampleImpl() {
    printf("SampleImpl::~SampleImpl()\n");
  }
}

SWIG界面（使用argout typemap）

// example.i
%module example
%{
  #define SWIG_FILE_WITH_INIT
  #include "Sample.hpp"
  #include "Sample_impl.hpp"
%}

%include "typemaps.i"

%typemap(in, numinputs=0) Module::SampleBase *&obj (Module::SampleBase *temp) {
  $1 = &temp;
}

%typemap(argout) Module::SampleBase *& {
  PyObject* temp = NULL;
  if (!PyList_Check($result)) {
    temp = $result;
    $result = PyList_New(1);
    PyList_SetItem($result, 0, temp);

    // Create shadow object (do not use SWIG_POINTER_NEW)
    temp = SWIG_NewPointerObj(SWIG_as_voidptr(*$1),
             $descriptor(Module::SampleBase*),
             SWIG_POINTER_OWN | 0);

    PyList_Append($result, temp);
    Py_DECREF(temp);
  }
}

Python中的用法

import example

// Creating specialization
obj = example.SampleImpl()
del obj

// Creation of object using output typemap
errorCode, obj = example.SampleImpl_SampleCreate()
del obj

Answer 3

我认为你需要使用指针。当混合输出typemaps和return语句时，我也不确定会发生什么。最小示例文件tst.i：

%module tst

%{

  // declaration:
  void add(long *resultLong, const long arg1,const long arg2);
  long mul(const long a, const long b);

  // the code:
  void add(long *resultLong, const long arg1,const long arg2) {
    *resultLong = arg1 + arg2;
  }
  long mul(const long a, const long b) {
    return a*b;
  }

%}

// The wrapper:
%apply (long* OUTPUT) { long* resultLong }; 
void add(long* resultLong, const long arg1,const long arg2);
long mul(const long a, const long b);

翻译后（我总是使用CMake），python中的用法是：

import tst
x = tst.add(3, 4)  # results in 7L    
y = tst.mul(3, 4)  # results in 12L

我认为最好使用return语句而不是标量数据类型的类型映射。在连接数组时，我建议使用预定义的numpy.i类型图。

如何在Python中为类类型应用SWIG OUTPUT类型图？

3 个答案: