我正在尝试使用 swig 为一些 C++ 代码创建 python 绑定。我似乎遇到了一个问题，试图从我拥有的一些访问器函数创建 python 属性，方法如下：
class Player {
public:
void entity(Entity* entity);
Entity* entity() const;
};
我尝试使用 python 属性函数创建一个属性，但似乎 swig 生成的包装类与它不兼容，至少对于 setter 而言。
你如何使用 swig 创建属性？
问问题
8842 次
6 回答
35
有一种简单的方法可以通过 swig 方法创建 python 属性。
假设 C++ 代码 Example.h：
C++ 头文件
class Example{
public:
void SetX(int x);
int GetX() const;
};
让我们将此 setter 和 getter 转换为 python 属性“x”。诀窍在于 .i 文件。我们添加了一些“swiggy”内联 python 代码（使用 %pythoncode），这些代码插入到生成的 python 类的主体中（在自动生成的 python 代码中）。
Swig 包装 Example.i
%module example
%{
#include "example.h"
%}
class Example{
public:
void SetX(int x);
int GetX() const;
%pythoncode %{
__swig_getmethods__["x"] = GetX
__swig_setmethods__["x"] = SetX
if _newclass: x = property(GetX, SetX)
%}
};
检查python代码：
蟒蛇测试代码
import example
test = example.Example()
test.x = 5
print "Ha ha ha! It works! X = ", repr(test.x)
这就对了！
让它更简单！
无需重写类定义。感谢 Joshua 的建议，可以使用 SWIG 指令 %extend ClassName { }。
Swig 包装 Example.i
%module example
%{
#include "example.h"
%}
%extend Example{
%pythoncode %{
__swig_getmethods__["x"] = GetX
__swig_setmethods__["x"] = SetX
if _newclass: x = property(GetX, SetX)
%}
};
隐藏 setter 和 getter 函数
可以看到，test.GetX() 和 test.SetX() 在转换后仍然存在。可以通过以下方式隐藏它们：
a) 使用 %rename 重命名函数，在开头添加“_”，从而使 python 的方法“私有”。在 SWIG 界面 .i Example.i
...
class Example{
%rename(_SetX) SetX(int);
%rename(_GetX) GetX();
...
（%rename 可以放在某个单独的地方，以节省将此类转换为不需要这些'_'的其他语言的可能性）
b) 或者可以玩 %feature("shadow")
为什么会这样？
为什么我们必须使用这些东西通过 SWIG 将方法转换为属性？如前所述，SWIG 自私地覆盖了 _setattr _，因此必须使用 _swig_getmethods_和_swig_setmethods_来注册函数并保持 swig 方式。
为什么人们可能更喜欢这种方式？
上面列出的方法，尤其是使用 PropertyVoodoo 的方法是……就像烧房子煎鸡蛋一样。它还破坏了类布局，因为必须创建继承的类才能从 C++ 方法中创建 python 属性。我的意思是如果类 Cow 返回类 Milk 并且继承的类是 MilkWithProperties(Milk)，如何让 Cow 产生 MilkWithProperties？
这种方法允许：
- 显式控制要转换为 python 属性的 C++ 方法
- 转换规则位于 swig interface(*.i) 文件中，它们应该在的地方
- 一个生成的自动生成的 .py 文件
- 停留在 swig 生成的 .py 文件中插入的 swig 语法
- 如果将库包装为其他语言，则忽略 %pythoncode
更新 在较新的版本中，SWIG 放弃了_swig_property所以只需使用property。它与旧版本的 swig 相同。我已经换了帖子。
于 2011-01-20T16:55:31.113 回答
22
使用属性.i
在 SWIG Lib 文件夹中有一个名为“attributes.i”的文件，该文件未在文档中讨论，但包含内联文档。
您所要做的就是将以下行添加到您的接口文件中。
%include <attributes.i>
然后，您会收到许多用于从现有方法定义属性的宏（例如 %attribute）。
attributes.i 文件中的文档摘录：
以下宏将一对 set/get 方法转换为“本机”属性。当您有一对原始类型的 get/set 方法时使用 %attribute，例如：
%attribute(A, int, a, get_a, set_a);
struct A
{
int get_a() const;
void set_a(int aa);
};
于 2012-07-08T19:40:20.290 回答
4
哦，这很棘手（也很有趣）。SWIG不认为这是一个生成@property 的机会：我想如果不是非常小心的话，很容易出错并识别出很多误报。但是，由于 SWIG 在生成 C++ 时不会这样做，因此在 Python 中使用一个小的元类仍然完全有可能做到这一点。
所以，下面，假设我们有一个 Math 类，它可以让我们设置和获取一个名为“pi”的整数变量。然后我们可以使用这段代码：
例子.h
#ifndef EXAMPLE_H
#define EXAMPLE_H
class Math {
public:
int pi() const {
return this->_pi;
}
void pi(int pi) {
this->_pi = pi;
}
private:
int _pi;
};
#endif
例子.i
%module example
%{
#define SWIG_FILE_WITH_INIT
#include "example.h"
%}
[essentially example.h repeated again]
例子.cpp
#include "example.h"
实用程序.py
class PropertyVoodoo(type):
"""A metaclass. Initializes when the *class* is initialized, not
the object. Therefore, we are free to muck around the class
methods and, specifically, descriptors."""
def __init__(cls, *a):
# OK, so the list of C++ properties using the style described
# in the OP is stored in a __properties__ magic variable on
# the class.
for prop in cls.__properties__:
# Get accessor.
def fget(self):
# Get the SWIG class using super. We have to use super
# because the only information we're working off of is
# the class object itself (cls). This is not the most
# robust way of doing things but works when the SWIG
# class is the only superclass.
s = super(cls, self)
# Now get the C++ method and call its operator().
return getattr(s, prop)()
# Set accessor.
def fset(self, value):
# Same as above.
s = super(cls, self)
# Call its overloaded operator(int value) to set it.
return getattr(s, prop)(value)
# Properties in Python are descriptors, which are in turn
# static variables on the class. So, here we create the
# static variable and set it to the property.
setattr(cls, prop, property(fget=fget, fset=fset))
# type() needs the additional arguments we didn't use to do
# inheritance. (Parent classes are passed in as arguments as
# part of the metaclass protocol.) Usually a = [<some swig
# class>] right now.
super(PropertyVoodoo, cls).__init__(*a)
# One more piece of work: SWIG selfishly overrides
# __setattr__. Normal Python classes use object.__setattr__,
# so that's what we use here. It's not really important whose
# __setattr__ we use as long as we skip the SWIG class in the
# inheritance chain because SWIG's __setattr__ will skip the
# property we just created.
def __setattr__(self, name, value):
# Only do this for the properties listed.
if name in cls.__properties__:
object.__setattr__(self, name, value)
else:
# Same as above.
s = super(cls, self)
s.__setattr__(name, value)
# Note that __setattr__ is supposed to be an instance method,
# hence the self. Simply assigning it to the class attribute
# will ensure it's an instance method; that is, it will *not*
# turn into a static/classmethod magically.
cls.__setattr__ = __setattr__
一些文件.py
import example
from util import PropertyVoodoo
class Math(example.Math):
__properties__ = ['pi']
__metaclass__ = PropertyVoodoo
m = Math()
print m.pi
m.pi = 1024
print m.pi
m.pi = 10000
print m.pi
因此，最终结果就是您必须为每个 SWIG Python 类创建一个包装器类，然后键入两行：一行用于标记应在属性中转换哪些方法，另一行用于引入元类。
于 2009-07-27T03:53:22.757 回答
4
Hao 的 ProperyVoodoo 元类的问题在于，当属性列表中有多个属性时，所有属性的行为都与列表中的最后一个相同。例如，如果我有一个列表或属性名称 ["x"、"y"、"z"]，那么为所有三个生成的属性将使用与 "z" 相同的访问器。
经过一些实验，我相信我已经确定这个问题是由 Python 处理闭包的方式引起的（即嵌套函数中的名称引用包含范围内的变量）。要解决此问题，您需要将属性名称变量的本地副本获取到 fget 和 fset 方法中。使用默认参数很容易将它们潜入：
# (NOTE: Hao's comments removed for brevity)
class PropertyVoodoo(type):
def __init__(cls, *a):
for prop in cls.__properties__:
def fget(self, _prop = str(prop)):
s = super(cls, self)
return getattr(s, _prop)()
def fset(self, value, _prop = str(prop)):
s = super(cls, self)
return getattr(s, _prop)(value)
setattr(cls, prop, property(fget=fget, fset=fset))
super(PropertyVoodoo, cls).__init__(*a)
def __setattr__(self, name, value):
if name in cls.__properties__:
object.__setattr__(self, name, value)
else:
s = super(cls, self)
s.__setattr__(name, value)
cls.__setattr__ = __setattr__
请注意，事实上，给 fget 和 fset 额外的 _prop 参数是完全安全的，因为 property() 类永远不会显式地将值传递给它们，这意味着它们将始终是默认值（即作为字符串的副本在创建每个 fget 和 fset 方法时由 prop 引用）。
于 2010-08-20T10:51:34.717 回答
1
我遇到了同样的问题，使用 %pythoncode 的建议对我有用。这是我所做的：
class Foo {
// ...
std::string get_name();
bool set_name(const std::string & name);
};
在包装器中：
%include "foo.h"
%pythoncode %{
def RaiseExceptionOnFailure(mutator):
def mutator(self, v):
if not mutator(self, v):
raise ValueError("cannot set property")
return wrapper
Foo.name = property(Foo.get_name, RaiseExceptionOnFailure(Foo.set_name))
%}
于 2010-04-27T21:57:11.783 回答
1
来自http://www.swig.org/Doc2.0/SWIGDocumentation.html#SWIG_adding_member_functions：
%extend 指令的一个鲜为人知的特性是它还可用于添加合成属性或修改现有数据属性的行为。例如，假设您想让幅度成为 Vector 的只读属性，而不是方法。
因此，在您的示例中，以下内容应该有效：
%extend Player {
Entity entity;
}
%{
Entity* Player_entity_get(Player* p) {
return p->get_entity();
}
void Player_entityProp_set(Player* p, Entity* e) {
p->set_entity(e);
}
%}
于 2012-06-28T17:38:11.677 回答