python - 使用 SWIG 生成 Python 类型提示

Question

python 3.5+ 支持类型提示这一事实在生成包装器时有很好的用例，例如通过 SWIG。

在使用大型 C++ API 时提供类型提示会大大改善体验，因为您的 IDE/linter 可以执行编译时类型检查。

如何使用 SWIG 生成类型提示？

Answer 1

swig autodoc 功能，至少在简单情况下可以为您提供此功能。

将 %feature("autodoc", "1") 添加到您的 SWIG 接口(interface)代码中，将生成如下内容:

def function_name(*args, **kwargs):
    """function_name(int x, int y, Foo foo=None, Bar bar=None) -> bool"""
    ...

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