2011-06-06 13 views
16

Al crear una extensión C para Python, ¿es posible escribir de alguna manera los comentarios que están expuestos como docstrings a los usuarios de la extensión?Docstrings en C extensiones a Python?

+0

Puede que ya esté al tanto, pero de lo contrario: es posible que desee investigar Cython. Escribe un código de estilo Python, agrega algunas declaraciones de tipo, y se traduce a C y compila. –

Respuesta

17

Las cadenas de documentación para tipos pueden ser incluidos como el miembro tp_doc en la estructura PyTypeObject, ver an example in the docs.

Las cadenas de documentación para funciones pueden ser incluidos en el campo de la module's method tableml_doc. Si desea que sus documentos estén "físicamente cerca" de las funciones reales, puede incluir constantes de cadenas por encima de las definiciones de funciones a las que hace referencia en la tabla de métodos.

Las cadenas de documentación para métodos se pueden asignar al campo doc en el type's member table.

Las cadenas de documentación para módulos se pueden pasar como un parámetro a los Py_InitModule3() o Py_InitModule4() funciones.

+0

Excelente respuesta, gracias Sven. Los enlaces directos son muy útiles. –

-3

No lo creo, pero debería poder manipular las cadenas de documentos de esos objetos de python. Vea el python docs para más.

Cuestiones relacionadas