如何从函数本身内部打印python函数的Docstring？

Question

我想从函数本身内部打印python函数的文档字符串。例如

def my_function(self):
  """Doc string for my function."""
  # print the Docstring here.

目前，my_function在定义之后，我将直接执行此操作。

print my_function.__doc__

但宁愿让函数自己执行此操作。

我已经尝试在my_function内调用它print self.__doc__ print self.my_function.__doc__，print this.__doc__但这没有用。

Answer 1

def my_func():
    """Docstring goes here."""
    print my_func.__doc__

只要您不更改绑定到名称的对象，此方法就可以工作my_func。

new_func_name = my_func
my_func = None

new_func_name()
# doesn't print anything because my_func is None and None has no docstring

您会执行此操作的情况很少见，但确实会发生。

但是，如果您编写这样的装饰器：

def passmein(func):
    def wrapper(*args, **kwargs):
        return func(func, *args, **kwargs)
    return wrapper

现在您可以执行以下操作：

@passmein
def my_func(me):
    print me.__doc__

这将确保您的函数获得对自身的引用（类似于self）作为其第一个参数，因此它始终可以获取正确函数的文档字符串。如果在方法上使用，则通常self成为第二个参数。