python - Python への C 拡張の Docstrings?

Question

Python への C 拡張機能を作成するとき、拡張機能のユーザーにdocstringとして公開されているコメントを何らかの方法で書き込むことができるようにすることはできますか?

Answer 1

型のドキュメント文字列は、構造体のtp_docメンバーとして含めることができます。ドキュメントの例を参照してください。PyTypeObject

関数のドキュメント文字列は、モジュールのメソッド テーブルのml_docフィールドに含めることができます。docstring を実際の関数に「物理的に近い」ものにしたい場合は、メソッド テーブルで参照する関数定義の上に文字列定数を含めることができます。

メソッドのドキュメント文字列は、型のメンバー テーブルのdocフィールドに割り当てることができます。

モジュールのドキュメント文字列は、Py_InitModule3()またはPy_InitModule4()関数にパラメーターとして渡すことができます。

---

更新: Python3 は をサポートしていないためPy_InitModule3()、メソッドは に置き換えられましたPyModule_Create()。