如何覆蓋 python 中 function 的原始簽名

Question

假設我有以下 function：

def person(*args, **kwargs):
    '''
       person(name, age, parents=2)
       this is a docstring.
    '''

如果我執行help(person)我會得到

person(*args, **kwargs)
    person(name, age, children=5)
    this is a docstring.

但相反，我想看到：

person(name, age, children=5)
    this is a docstring.

Answer 1

您可以簡單地覆蓋.__doc__屬性：

def a():
    """orig docstring"""
    pass
help(a)
a.__doc__ = """modified docstring"""
help(a)

Answer 2

你總是可以使用文檔字符串，像這樣：

def function(...):
    """
    This function does this and that. The parameters are the following:
    param1 = ...
    param2 = ...
    ...
    """
    # code

然后你可以簡單地調用。 doc方法，它打印出文檔字符串。 它是這樣工作的：

    print.__doc__

或者為了更好的可讀性：

    import pprint
    pprint.pprint(pprint.__doc__, indent=4)

Pprint 是漂亮的打印。