SWIG 和 C++ 枚举 class
SWIG and C++ enum class
Edit: 答案解决了问题,但最后我提出了一个更模块化的解决方案。检查一下:)
我从 two discussions 得知,为了类型安全,应该选择 enum class
而不是 enum
。出于这个原因,我在我的项目中使用它,但是当用 SWIG 包装它们时,我得到了一些我不太喜欢的东西。
给出简单枚举
enum class type {
A, B, C, D, E, F, G, H, I
};
在 .hpp
文件中,说 my_types.hpp
,my_types.i
文件:
%module my_types
%{
#include "my_types.hpp"
%}
%include "my_types.hpp"
生成的python文件包含包含
type_A = _my_types.type_A
type_B = _my_types.type_B
type_C = _my_types.type_C
type_D = _my_types.type_D
type_E = _my_types.type_E
type_F = _my_types.type_F
type_G = _my_types.type_G
type_H = _my_types.type_H
type_I = _my_types.type_I
这意味着在Python中使用它时我将不得不做
import my_types as mt
mt.type_A
来使用它们……好吧,在这种情况下还可以,因为单词 type
没有那么长,但是对于更长的单词,它看起来不太好,并且, 另外,对我来说,每个枚举值的开头都有枚举的名称没有多大意义。
有没有办法重命名它们(也许使用 %rename
),以便使用它们可以像这样简单?
import my_types as mt
mt.A
我不知道在这种情况下如何使用%rename
,或者它甚至可以用于此目的。任何帮助,包括关于如何以不同方式做同样的事情(可能没有枚举)的想法,将不胜感激。谢谢大家
编辑:一些评论指出,在每个枚举的名称前面加上枚举的名称确实有意义。我想详细说明为什么我说它不(对我)的原因。如果我们考虑与枚举调用相同的模块的情况,那么代码看起来有点多余。由于 types
已经是 Python 的模块,一个更好的例子是颜色:
enum class colours {
Blue, Red
};
并且将按照建议使用包装代码,如下所示:
import colours
Blue = colours.colours_Blue
Red = colours.colours_Red
在我看来,写colours
来引用Blue
、Red
是不必要的,因为模块colours
只包含一个"enumeration"。换成这个不是更好吗?
import colours
Blue = colours.Blue
Red = colours.Red
一个答案已经解释了如何实现这一点。我会尽快查看。非常感谢!
编辑: 答案解决了问题。我想对它做一些修改,并提出一个稍微更"modular"的解决方案:
%pythoncode %{
__enum_name = "colours" # your enumeration's name
__enum = __import__(__enum_name) # import module
__scope_name = __enum_name + "_" # scope's name (= "colours_")
__scope_length = len(__scope_name) # length
for name in dir(__enum):
if name.find(__scope_name) == 0:
setattr(__enum, name[__scope_length:], getattr(__enum, name))
delattr(__enum, name) # optional
del name, __enum_name, __enum, __scope_name, __scope_length
%}
我认为这可以让您的项目更容易复制和粘贴您有十分之一枚举的项目:)。同样,基于 答案。
我会说我不完全理解你为什么要删除范围(尽管我猜这是因为在 python 中你已经获得了模块范围,这是你没有的在 C++ 中)。现在,我不认为 %rename
可以工作,因为它不是文本转换。但是,我可以想到两种选择,一种在 C++ 中重命名,另一种在 Python.
中重命名
在 C++ 中重命名
将my_types.hpp
更改为:
enum class type {
A, B, C, D, E, F, G, H, I
};
#ifdef SWIG
constexpr type A = type::A;
constexpr type B = type::B;
constexpr type C = type::C;
constexpr type D = type::D;
constexpr type E = type::E;
constexpr type F = type::F;
constexpr type G = type::G;
constexpr type H = type::H;
constexpr type I = type::I;
#endif
并在命令行中添加 -DSWIG
来编译包装器。
在 Python
中重命名
修改my_types.i
为:
%module my_types
%{
#include "my_types.hpp"
%}
%include "my_types.hpp"
%pythoncode %{
import my_types
for name in dir(my_types):
if name.find('type_') == 0:
setattr(my_types, name[5:], getattr(my_types, name))
delattr(my_types, name) # optional
del name
%}
Edit:
我从 two discussions 得知,为了类型安全,应该选择 enum class
而不是 enum
。出于这个原因,我在我的项目中使用它,但是当用 SWIG 包装它们时,我得到了一些我不太喜欢的东西。
给出简单枚举
enum class type {
A, B, C, D, E, F, G, H, I
};
在 .hpp
文件中,说 my_types.hpp
,my_types.i
文件:
%module my_types
%{
#include "my_types.hpp"
%}
%include "my_types.hpp"
生成的python文件包含包含
type_A = _my_types.type_A
type_B = _my_types.type_B
type_C = _my_types.type_C
type_D = _my_types.type_D
type_E = _my_types.type_E
type_F = _my_types.type_F
type_G = _my_types.type_G
type_H = _my_types.type_H
type_I = _my_types.type_I
这意味着在Python中使用它时我将不得不做
import my_types as mt
mt.type_A
来使用它们……好吧,在这种情况下还可以,因为单词 type
没有那么长,但是对于更长的单词,它看起来不太好,并且, 另外,对我来说,每个枚举值的开头都有枚举的名称没有多大意义。
有没有办法重命名它们(也许使用 %rename
),以便使用它们可以像这样简单?
import my_types as mt
mt.A
我不知道在这种情况下如何使用%rename
,或者它甚至可以用于此目的。任何帮助,包括关于如何以不同方式做同样的事情(可能没有枚举)的想法,将不胜感激。谢谢大家
编辑:一些评论指出,在每个枚举的名称前面加上枚举的名称确实有意义。我想详细说明为什么我说它不(对我)的原因。如果我们考虑与枚举调用相同的模块的情况,那么代码看起来有点多余。由于 types
已经是 Python 的模块,一个更好的例子是颜色:
enum class colours {
Blue, Red
};
并且将按照建议使用包装代码,如下所示:
import colours
Blue = colours.colours_Blue
Red = colours.colours_Red
在我看来,写colours
来引用Blue
、Red
是不必要的,因为模块colours
只包含一个"enumeration"。换成这个不是更好吗?
import colours
Blue = colours.Blue
Red = colours.Red
一个答案已经解释了如何实现这一点。我会尽快查看。非常感谢!
编辑:
%pythoncode %{
__enum_name = "colours" # your enumeration's name
__enum = __import__(__enum_name) # import module
__scope_name = __enum_name + "_" # scope's name (= "colours_")
__scope_length = len(__scope_name) # length
for name in dir(__enum):
if name.find(__scope_name) == 0:
setattr(__enum, name[__scope_length:], getattr(__enum, name))
delattr(__enum, name) # optional
del name, __enum_name, __enum, __scope_name, __scope_length
%}
我认为这可以让您的项目更容易复制和粘贴您有十分之一枚举的项目:)。同样,基于
我会说我不完全理解你为什么要删除范围(尽管我猜这是因为在 python 中你已经获得了模块范围,这是你没有的在 C++ 中)。现在,我不认为 %rename
可以工作,因为它不是文本转换。但是,我可以想到两种选择,一种在 C++ 中重命名,另一种在 Python.
在 C++ 中重命名
将my_types.hpp
更改为:
enum class type {
A, B, C, D, E, F, G, H, I
};
#ifdef SWIG
constexpr type A = type::A;
constexpr type B = type::B;
constexpr type C = type::C;
constexpr type D = type::D;
constexpr type E = type::E;
constexpr type F = type::F;
constexpr type G = type::G;
constexpr type H = type::H;
constexpr type I = type::I;
#endif
并在命令行中添加 -DSWIG
来编译包装器。
在 Python
中重命名修改my_types.i
为:
%module my_types
%{
#include "my_types.hpp"
%}
%include "my_types.hpp"
%pythoncode %{
import my_types
for name in dir(my_types):
if name.find('type_') == 0:
setattr(my_types, name[5:], getattr(my_types, name))
delattr(my_types, name) # optional
del name
%}