使用 swig，如何将二进制数据从 python 传递到 C/C++？

如何解决使用 swig，如何将二进制数据从 python 传递到 C/C++？

如果我的 my_module.h 中有这样的 C 或 C++ 函数：

void my_function(const char* data,int len);

还有 my_module.c：

#include "my_module.h"

#include <unistd.h>

void my_function(const char* data,int len)
{
    // do fancy things with data
    write(1,data,len);
}

我会像这样为 swig 创建一个 my_module.i：

%inline %{
#include "my_module.h"
%}
%include "my_module.h"

我是这样构建的：

swig -python -module my_module my_module.i

gcc -shared -fPIC my_module_wrap.c my_module.c -I/usr/include/python3.8 -lpython3.8 -o _my_module.so

现在从 python 我想这样做：

import my_module

in_file = open("my_binary_file","rb")
bytes = in_file.read()
in_file.close()

my_module.my_function(bytes,len(bytes))

但我明白了：

TypeError: in method 'find_mistakes',argument 1 of type 'char const *'

我检查了变量 bytes 的类型

>>> type(bytes)
<class 'bytes'>

我不知道那是什么意思。如何将原始数据传递给 C？

我不想将字节转换为字符串，因为它不是文本。当我尝试转换它时，C 端收到了对二进制而不是原始二进制进行编码的文本。看起来像这样的东西：

b'\x\x00\n'

编辑：

阅读 manual 我发现：

char * 数据类型被处理为以 NULL 结尾的 ASCII 字符串。 SWIG 将其映射到目标脚本语言中的 8 位字符串。 SWIG 将目标语言中的字符串转换为以 NULL 结尾的字符串，然后再将它们传递给 C/C++。这些字符串的默认处理不允许它们嵌入 NULL 字节。因此，char * 数据类型一般不适合传递二进制数据。但是，可以通过定义 SWIG 类型映射来更改此行为。有关这方面的详细信息，请参阅类型映射一章。

所以 swig 说 char* 适合文本，但不适用于二进制数据。那么 char* 的替代方法是什么？

它建议使用类型映射更改 swig 的默认行为。这是唯一的方法吗？如果是这样，它是如何完成的？对于每种语言，它会是不同的 hack 吗？

解决方法

经过几个小时的挫折，我终于做到了。希望这个答案可以为其他人节省一些时间和挫败感。

请注意，此答案适用于 python 3。我不知道 python 2 会如何工作。

来自docs：

在某些情况下，用户可能希望将所有字节字符串作为 Python 3 中的字节对象。这可以通过添加来完成 SWIG_PYTHON_STRICT_BYTE_CHAR 到生成的代码：

这意味着你只需要在你的接口文件中使用它：

%begin %{
#define SWIG_PYTHON_STRICT_BYTE_CHAR
%}

这将修改行为，以便只有 Python 3 字节对象将 被接受并转换为 C/C++ 字符串，并返回任何字符串 来自 C/C++ 将被转换为 Python 中的字节对象。

奖励：

如果您不想同时传递二进制文件和来自 python 的长度，您可以在接口文件中执行此操作：

%include "typemaps.i"

// change "(const char* data,int len)" to match your functions declaration
%apply (char *STRING,size_t LENGTH) { (const char* data,int len) }

%include "my_module.h"

现在从python你可以做到这一点：

my_module.my_function(bytes) 而不是 my_module.my_function(bytes,len(bytes))

所以我的最终界面文件如下所示：

%module my_module

%begin %{
#define SWIG_PYTHON_STRICT_BYTE_CHAR
%}

%inline %{
#include "my_module.h"
%}

%include "typemaps.i"

%apply (char *STRING,int len) }

%include "my_module.h"