swig/python：对象不支持索引

Posted 2023-02-23

【中文标题】swig/python：对象不支持索引

【英文标题】：swig/python: object does not support indexing

【发布时间】：2017-06-01 13:27:10

【问题描述】：

鉴于这组文件：

foo.h:

#pragma once

#include <stdio.h>

template <class T0> class Foo 
  public:
    T0 m[3];

    Foo(const T0 &a, const T0 &b, const T0 &c) 
        m[0] = a;
        m[1] = b;
        m[2] = c;
    
    void info()  printf("%d %d %d\n", m[0], m[1], m[2]); 
    // T0 &operator[](int id)  return ((T0 *)m)[id]; 
;

foo.cpp:

#include "foo.h"

foo.i（尝试1）：

%module foo

%
#include "foo.h"
%

%include "foo.h"

%template(intFoo) Foo<int>;

%extend Foo
    T0& __getitem__(int id)  return ((T0 *)m)[id]; 

setup.py：

import os
import sys
from setuptools import setup, Extension

foo_module = Extension('_foo',
                           sources=[
                               'foo.i',
                               'foo.cpp'
                           ],
                           swig_opts=['-c++', '-py3', '-builtin'],
                           include_dirs=['.']
                           )

setup(name='foo',
      version='0.1',
      platforms=['Windows', 'Linux'],
      ext_modules=[foo_module],
      py_modules=["foo"],
      )

test.py：

from foo import intFoo

a = intFoo(10,20,30)
print(dir(a))
a.info()
print(a[2])

我正在构建扩展程序：

python setup.py build_ext --force -i

但是当我尝试运行 test.py 时，我会得到：

TypeError: 'foo.intFoo' object does not support indexing

foo.i 中的声明 extend 是在任何其他与 SO 相关的线程上建议的答案，这意味着我在这里使用不正确。谁能解释一下如何解决这个问题，这样当我运行test.py 时就可以成功使用[] 运算符？

又一次尝试：

尝试2：

%module foo

%
#include "foo.h"
%

%include "foo.h"

%template(intFoo) Foo<int>;

%extend intFoo
    T0& __getitem__(int id)  return ((T0 *)m)[id]; 

抛出此错误TypeError: 'foo.intFoo' object does not support indexing

尝试3

%module foo

%
#include "foo.h"
%

%include "foo.h"

%extend Foo
    T0& __getitem__(int id)  return ((T0 *)m)[id]; 


%template(intFoo) Foo<int>;

抛出此错误foo_wrap.cpp(3808): error C2065: 'm': undeclared identifier

【问题讨论】：

尝试%extend intFoo 或将%extend Foo 移到%template(intFoo) 之前。

@MarkTolonen 尝试了您的建议并编辑了问题，不幸的是，没有运气:(

据我所知，%extend 功能不能与-builtin 选项一起使用

很高兴看到 setup.py 的问题以及有效重现问题所需的所有文件。

FWIW，这是 ***.com/questions/22736700/… 的副本。由于开放的赏金，这个问题不能作为重复关闭。

【参考方案1】：

（在整个示例中，我使用的是您的第一个版本的 foo.i）

首先需要在 %template 指令之前指定 %extend 才能生效。

一旦我们修复了这个问题，我们现在就会从您的 %extend 代码中得到一个编译器错误：

foo_wrap.cpp: In function 'int& Foo_Sl_int_Sg____getitem__(Foo<int>*, int)':
foo_wrap.cpp:3705:85: error: 'm' was not declared in this scope

发生这种情况是因为您使用%extend 添加的方法并不是您要添加它们的类的真正成员。要在这种情况下访问m，我们需要使用$self->m 来引用它。 SWIG 将为我们提供适当的变量 replace $self。 （值得快速查看生成的代码以了解其工作原理）

调试类型映射或扩展时的一个有用提示是搜索您在 SWIG 生成的输出中编写的代码 - 如果不存在，则说明它没有按照您的想法应用。

因此，一旦我们修复了关于 m 未被声明的错误，我们就会遇到另一个问题，因为您已使用 -builtin 进行编译：

In [1]: import foo

In [2]: f=foo.intFoo(1,2,3)

In [3]: f[0]
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
<ipython-input-3-e71eec16918d> in <module>()
----> 1 f[0]

TypeError: 'intFoo' object does not support indexing

In [4]: f.__getitem__(0)
Out[4]: <Swig Object of type 'int *' at 0xa8807d40>

即使您添加了__getitem__，使用f[n] 进行索引仍然不起作用。发生这种情况是因为 Python 运算符重载中的纯 C-API 类的工作方式不同。您已成功添加 __getitem__ 方法，但 Python 正在 builtin type's slots（特别是 mp_subscript）中寻找执行操作的方法。所以我们也需要解决这个问题。完成后，工作 foo.i 看起来像：

%module foo

%
#include "foo.h"
%

%feature("python:slot", "mp_subscript", functype="binaryfunc") Foo::__getitem__;

%include "foo.h"

%extend Foo
    T0& __getitem__(int id)  return ((T0 *)$self->m)[id]; 


%template(intFoo) Foo<int>;

所以现在我们可以为所欲为：

In [1]: import foo

In [2]: f=foo.intFoo(1,2,3)

In [3]: f[0]
Out[3]: <Swig Object of type 'int *' at 0xb4024100>

（您实际上不必再调用它__getitem__，因为该函数已在插槽中注册，因此应该可以在没有%extend 的情况下调用operator[]）

最后，您可能希望将返回类型更改为const T0&，或者编写一个 Python 类型来代理对象以更好地进行非常量 int 引用。

【讨论】：

效果很好，但是如果没有T0& 前面的const，返回类型就会变成Swig Object of type 'int *'。加上const，它就变成了一个整数。

【参考方案2】：

我已将错误答案（声明 %extent 只能在没有 -builtin 选项的情况下使用）更改为有效的答案，但同样只能在没有“内置”选项的情况下使用

setup.py

import os
import sys
from setuptools import setup, Extension

foo_module = Extension('_foo',
                           sources=[
                               'foo.i', 'foo.cpp'
                           ],
                           swig_opts=['-c++'],
                           include_dirs=['.']
                           )

setup(name='foo',
      version='0.1',
      platforms=['Windows', 'Linux'],
      ext_modules=[foo_module],
      py_modules=["foo"],
      )

foo.i

%module foo

%
#include "foo.h"
%

%include "carrays.i"
%array_functions(int, intArray);

%include "foo.h"

%extend Foo<int> 
%pythoncode %
def __getitem__(self, id):
  return _foo.intArray_getitem(self.m,id)             
%
;

%template(intFoo) Foo<int>;

请注意，扩展程序是如何生成Python 代码的，它允许您做许多复杂的事情。

旧答案：

根据 SWIG 文档，python 层被剥离，因此%extend 功能被忽略（这是不正确的，未创建代理对象）

见http://www.swig.org/Doc3.0/SWIGDocumentation.html

36.4.2 内置类型

当使用-builtin 时，纯python 层被剥离。每个 包装的类变成了一个新的python内置类型，它继承了 来自 SwigPyObject，直接返回 SwigPyObject 实例 从包装的方法。有关 python 内置的更多信息 扩展，请参考python文档：

【讨论】：

%extend 适用于 C++ 层，而不是 Python 层，所以这不是这里的答案。实际答案在 36.4.2.2

@Flexo 我有几个使用%extend 的示例，其中唯一的效果是在 Python 层中注入代码。删除built-in 标志对我来说很好，当然也可以使用$self 引用对象。

你能在 pastebin 上分享一个吗？ %extend 是通用的 SWIG，而不是来自 Python 模块，所以我不明白这是怎么回事。 %pythoncode、%pythonprepend 和 %feature('shadow') 都是特定于 Python 的，不会对 -builtin 做任何事情，但 %extend 就像您在 C 或 C++ 声明/定义中编写的一样

我写，%extend Foo<int> %pythoncode % def __getitem__(int i): ...。这样，扩展只影响 Python 代码。我从来没有在没有%pythoncode 的情况下使用过%extend。我每天都在学习

嘿，我从来没有在%extend 中使用过%pythoncode，并且总是通过模块级%pythoncode 的“猴子补丁”添加更多纯Python 方法