Python Intellisense Documentation for C/C++ Extension

Asked Jul 06 '22 at 05:10

Active Jul 06 '22 at 05:19

Viewed 171 times

I have a simple example c extension for Python (CPython 3.9), based on this Stack Overflow answer. I can access this from python via the function help(_myexample), but the question is: Is there a way to display the docstring (foo_doc) on hover, such as provided by Microsoft's Python extension for vscode for standard Python docstrings?

static PyObject* foo(PyObject *self, PyObject *args) {

    /* blabla [...] */

}

PyDoc_STRVAR(
    foo_doc,
    "foo(timeout, flags=None, /)\n"
    "--\n"
    "\n"
    "Great example function\n"
    "Arguments: (timeout, flags=None)\n"
    "Doc blahblah doc doc doc.");

static PyMethodDef methods[] = {
    {"foo", foo, METH_VARARGS, foo_doc},
    {NULL},
};

PyMODINIT_FUNC init_myexample(void) {
    (void) Py_InitModule3("_myexample", methods, "a simple example module");
}

Hover feature referred to above:

edited Jul 06 '22 at 05:19

asked Jul 06 '22 at 05:10

Brad

3

if you can read that image you have very good eyesight – rioV8 Jul 06 '22 at 09:02
do you use a Python wrapper to interface to the C functions, if you put the doc strings there – rioV8 Jul 06 '22 at 09:15

Python Intellisense Documentation for C/C++ Extension

0 Answers0