How to specify docstring for init in Python C extension

Question

Perhaps a stupid question: how can one specify docstring for special functions like __init__ when writing a C extension? For ordinary methods, method table has provision for docstrings. The following autogenerated documentation is displayed when I try help(myclass):

  __init__(...)
      x.__init__(...) initializes x; see help(type(x)) for signature

But this is what I want to override.

It's been 10 years, and still no (obvious) solution to this! — Thomas Wagenaar
– Thomas Wagenaar, Commented Oct 23, 2022 at 11:22

Nathan Binkert · Accepted Answer · 2012-08-19 04:58:12Z

1

I think that the most common thing to do is to just stick the definitions for the various functions into tp_doc and just leave it at that. You can then do as it says and look at your object's doc. This is what happens all over the standard library.

You don't really have any option of writing __doc__ on the various slots (tp_init, etc.) because they're wrapped by a wrapper_descriptor when you call PyType_Ready, and the docstring on a wrapper_descriptor is read-only.

I think that it is possible to skip using the slots and add your method (e.g. __init__) to your MemberDefs, but I've never tried that.

answered Aug 19, 2012 at 4:58

Nathan Binkert

9,2041 gold badge32 silver badges37 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

subhacom Over a year ago

Looks like that is the case. I had already tried putting __init__ in PyMethoDef array. While it does not do any harm to put it there, the interpreter ignores the doc string I provided.

Collectives™ on Stack Overflow

How to specify docstring for init in Python C extension

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related