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

Question

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

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'

编辑：

阅读手册我发现了这一点：

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

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

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

Answer 1

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

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

从 文档：

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

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

%begin %{
#define SWIG_PYTHON_STRICT_BYTE_CHAR
%}

这将修改行为，以便仅接受 Python 3 字节对象并将其转换为 C/C++ 字符串，并且从 C/C++ 返回的任何字符串都将转换为 ZA7F5F35426B967411FC9231 中的字节 object

奖金：

如果您不想同时传递二进制文件和 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, size_t LENGTH) { (const char* data, int len) }

%include "my_module.h"