How do I programmatically set the docstring?

by

An instancemethod gets its docstring from its __func__. Change the docstring of __func__ instead. (The __doc__ attribute of functions are writeable.)

>>> class Foo(object):
...     def bar(self):
...         pass
...
>>> Foo.bar.__func__.__doc__ = "A super docstring"
>>> help(Foo.bar)
Help on method bar in module __main__:

bar(self) unbound __main__.Foo method
    A super docstring

>>> foo = Foo()
>>> help(foo.bar)
Help on method bar in module __main__:

bar(self) method of __main__.Foo instance
    A super docstring

From the 2.7 docs:

User-defined methods

A user-defined method object combines a class, a class instance (or None) and any callable
object (normally a user-defined function).

Special read-only attributes: im_self is the class instance object, im_func is the function
object; im_class is the class of im_self for bound methods or the class that asked for the
method for unbound methods; __doc__ is the method’s documentation (same as
im_func.__doc__); __name__ is the method name (same as im_func.__name__);
__module__ is the name of the module the method was defined in, or None if unavailable.

Changed in version 2.2: im_self used to refer to the class that defined the method.

Changed in version 2.6: For 3.0 forward-compatibility, im_func is also available as
__func__, and im_self as __self__.

More Related Contents:

  1. What are the most common Python docstring formats? [closed]
  2. Python decorator handling docstrings
  3. Using javadoc for Python documentation [closed]
  4. How to comment out a block of code in Python [duplicate]
  5. How to express multiple types for a single parameter or a return value in docstrings that are processed by Sphinx?
  6. Inheriting methods’ docstrings in Python
  7. Python script to ping linux server
  8. Print string without single quotes & brackets
  9. Python String concatenation with in double quotes [closed]
  10. How to extract numbers from a string in Python?
  11. Python name mangling
  12. How to make IPython notebook matplotlib plot inline
  13. Reading an Excel file in python using pandas
  14. Why does checking a variable against multiple values with `OR` only check the first value? [duplicate]
  15. Make 2 functions run at the same time
  16. Concatenating two one-dimensional NumPy arrays
  17. How to write inline if statement for print?
  18. How to replace Django’s primary key with a different integer that is unique for that table
  19. Callback to python function from Tkinter Tcl crashes in windows
  20. What exactly does the T and Z mean in timestamp?
  21. Meaning of end=” in the statement print(“\t”,end=”)? [duplicate]
  22. Is there a way to find an element by attributes in Python Selenium?
  23. How does using the try statement avoid a race condition?
  24. Move column by name to front of table in pandas
  25. How to get autocomplete in jupyter notebook without using tab?
  26. Python modbus library [closed]
  27. python-win32com excel com model started generating errors
  28. Assignment Condition in Python While Loop
  29. Discrete legend in seaborn heatmap plot
  30. Accessing attribute from parent class inside child class

Leave a Comment