在Python的C语言扩展中使用Docstrings?

问题描述 投票:18回答:2

当创建一个Python的C语言扩展时,是否可以以某种方式写出暴露为 docstrings 给扩展的用户?

python cpython python-c-extension
2个回答
18
投票

Docstrings for 类型 可以作为 tp_doc 在内 PyTypeObject 结构,见 文档中的一个例子.

文件字符串 职能 可纳入 ml_doc 的领域 模块方法表. 如果你想让你的 docstrings 与实际函数 "物理上接近",你可以在方法表中引用的函数定义上方加入字符串常量。

docstrings用于 方法 可以分配给 doc 领域中 型成员表.

文件字符串 模块 可以作为参数传递给 Py_InitModule3()Py_InitModule4() 功能。


UPDATE: Python3不支持 Py_InitModule3(),该方法已被替换为 PyModule_Create().


-3
投票

我不这么认为,但你应该能够从python中操作这些对象的docstrings。请看 蟒蛇文档 更多。

© www.soinside.com 2019 - 2024. All rights reserved.