CODEWITHSUNDEEP
pythoncpythonpython-c-extension
Tim McNamara
Tim McNamara

Reputation: 18385

Docstrings in C extensions to Python?

When creating a C extension to Python, is it possible to be able to somehow write comments that are exposed as docstrings to users of the extension?

Upvotes: 22

Views: 3371

Answers (1)

Sven Marnach
Sven Marnach

Reputation: 602715

Docstrings for types can be included as the tp_doc member in the PyTypeObject structure, see an example in the docs.

Docstrings for functions can be included in the ml_doc field of the module's method table. If you want your docstrings to be "physically close" to the actual functions, you could include string constants above your function definitions which you reference in the method table.

Docstrings for methods can be assigned to the doc field in the type's member table.

Docstrings for modules can be passed as a parameter to the Py_InitModule3() or Py_InitModule4() functions.

UPDATE: Python3 does not support Py_InitModule3(), and the method has been replaced with PyModule_Create().

Upvotes: 21

Related Questions