如何让Cython函数在文档中显示参数并支持Tab补全？

这个问题确实是用Cython写交互场景下的函数时常见的小痛点——默认编译后的扩展函数不会保留完整的Python参数签名和文档元信息，导致IPython的Tab补全和help()功能都没法正常工作。下面给你几个实用的解决办法：

1. 用Python函数包装Cython实现（最推荐） #

这是最稳妥的方案，既不损失Cython的性能，又能完美兼容Python的交互特性。写一个普通的Python函数作为对外接口，内部调用你的Cython核心逻辑：

%load_ext cython
%%cython
# 定义底层的Cython实现，用cdef隐藏起来，只在内部调用
cdef float _f(float x, float y=2):
    return x + y

# 外层的Python接口函数，保留完整的参数签名和文档
def f(x, y=2):
    """f(x, y=2)
    返回x与y的和
    """
    return _f(x, y)

现在你再调用help(f)，参数信息会完整显示，IPython里输入f(按Tab也能正常补全参数名，完全和普通Python函数一样。

2. 利用Cython的类型注解与编译选项 #

从Cython 0.29版本开始，支持PEP 484类型注解，配合特定编译选项可以让Cython函数直接保留签名信息。你可以这么写：

%load_ext cython
%%cython -X binding=True
def f(x: float, y: float = 2) -> float:
    """f(x, y=2)
    计算x与y的和
    """
    return x + y

这里的-X binding=True编译选项会让Cython生成更贴近原生Python对象的函数绑定，保留参数签名这类交互特性。加上类型注解和文档字符串后，help()和Tab补全能正常工作。

3. 手动设置函数签名与文档字符串（临时场景用） #

如果上面的方法都不适用，你还可以手动给编译后的Cython函数补全元信息，不过需要在Python层执行：
先定义Cython函数：

%load_ext cython
%%cython
def f(float x, float y=2):
    return x + y

然后在IPython里运行：

from inspect import signature
# 手动添加文档字符串
f.__doc__ = "f(x, y=2)\n返回x与y的和"
# 手动生成并设置参数签名
f.__signature__ = signature(f)

这种方法比较繁琐，每次重新编译函数都要重复操作，适合临时测试的场景。

内容的提问来源于stack exchange，提问作者Tom Cornebize