浅谈Python的函数签名

（本文大部分内容来源于此链接的文章
，我对部分内容做了一些改动，方便自己日后复习，若有侵权，请联系我，我会将此文删除，谢谢）

函数签名对象，表示调用函数的方式。在Python中，可以使用模块inspect中的方法或类，来操作或创建函数签名。

---

1 获取函数签名及参数

使用inspect模块的signature方法，来获取函数签名对象；通过函数签名的parameters属性，获取函数参数。

>>> from inspect import signature
>>> def foo(value):
...     return value
...
>>> foo_sig = signature(foo) # 获取foo函数的签名
>>> foo_params = foo_sig.parameters # 通过函数签名的parameters属性，可获取函数的参数
>>> foo_params
mappingproxy(OrderedDict([('value', <Parameter "value">)]))

---

2 创建函数签名

使用类Parameter的实例创建函数参数列表；使用Signature类，接受函数参数列表，实例化输出函数签名实例。

>>> from inspect import Signature, Parameter # 注意首字母大写
>>>
>>> # 创建一个函数参数列表，列表内的元素由Parameter类的实例组成
>>> # Parameter实例化时，依次接受参数名、参数类型、默认值和参数注解
>>> # 默认值和参数类型默认为空，这里的空值不是None，而是Parameter.empty，代表没有值
>>> params = [Parameter('x', Parameter.POSITIONAL_OR_KEYWORD),
...           Parameter('y', Parameter.POSITIONAL_OR_KEYWORD),
...           Parameter('z', Parameter.KEYWORD_ONLY, default=9)]
>>>
>>> sig = Signature(params) # 使用Signature类，接受函数参数列表，实例化出函数签名实例
>>> sig # 函数签名实例
<Signature (x, y, *, z=9)>

---

3 检查函数参数是否匹配签名

使用函数签名的bind的方法，检查函数参数是否匹配签名。

延续上面的例子，通过函数签名的bind方法，接受函数参数，如果匹配，返回参数BoundArguments实例；如果不匹配，则抛出TypeError异常，并给出详细的异常信息。

通过BoundArguments实例的属性，可以获取函数签名、参数的值等内容。

>>> bound_args_01 = sig.bind(1, 2, z=3)
>>> bound_args_01
<BoundArguments (x=1, y=2, z=3)>
>>> 
>>> bound_args_02 = sig.bind(1, 2)
>>> bound_args_02
<BoundArguments (x=1, y=2)>
>>> 
>>> bound_args_03 = sig.bind(1) # 产生了TypeError异常: missing a required argument: 'y'

（本文大部分内容来源于此链接的文章
，我对部分内容做了一些改动，方便自己日后复习，若有侵权，请联系我，我会将此文删除，谢谢）