You need to enable JavaScript to run this app.
最新活动
大模型
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们

如何在Python中覆盖函数原始签名?自定义help输出示例

如何自定义Python函数的help输出?

你是不是遇到了这种情况:用*args**kwargs定义了一个函数,但调用help()时,默认会先显示person(*args, **kwargs),再显示你写的文档字符串,可你只想让help直接展示你期望的参数签名和说明?

别担心,我们可以通过修改函数的__signature__属性来实现这个需求,具体操作如下:

  • 首先导入inspect模块,它能帮我们解析和设置函数签名
  • 定义你的函数后,解析你想要展示的目标签名格式
  • 将解析后的签名赋值给函数的__signature__属性

直接看代码示例:

import inspect

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

# 解析我们期望显示的签名格式
desired_signature = inspect.signature("person(name, age, children=5)")
# 把这个签名绑定到函数上
person.__signature__ = desired_signature

现在再调用help(person),输出就会变成你想要的样子:

Help on function person in module main:

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

原理很简单:Python的help()函数会优先读取函数的__signature__属性(如果存在),而不是默认根据函数定义生成签名。这样就能完美替换掉*args, **kwargs的默认显示啦!

内容的提问来源于stack exchange,提问作者Tomergt45

火山引擎 最新活动