如何覆盖 python 中 function 的原始签名

Question

Let's say I have the following function:

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

If I execute help(person) I would get

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

But instead, I want to see:

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

Answer 1

You can simply overwrite .__doc__ attribute:

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

Answer 2

You could always use docstrings, like this:

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

Then you can simply call the. doc method and it prints out the docstring. It works like this:

    print.__doc__

Or for better readability:

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

Pprint is pretty print.