python的函数签名

发表于 | 分类于 | | 阅读次数: |
字数统计: 625 字 | 阅读时长 ≈ 3 分钟

我们在上篇如何根据函数类型注释来实现检测功能中使用到了函数签名signature。那什么是函数签名呢？

函数签名对象，表示调用函数的方式，即定义了函数的输入和输出。

在Python中，可以使用标准库inspect的一些方法或类，来操作或创建函数签名。

获取函数签名及参数

使用标准库的signature方法，获取函数签名对象；通过函数签名的parameters属性，获取函数参数。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 注意是小写的signature
In [38]: from inspect import signature

In [39]: def foobar(a: int, b: str, c: float = 3.2) -> tuple:
    ...:     return a, b, c
    ...:

# 获取函数签名
In [40]: foobar_sig = signature(foobar)

In [41]: foobar_sig
Out[41]: <Signature (a: int, b: str, c: float = 3.2) -> tuple>

# 通过函数签名的parameters属性，可以获取函数参数
In [42]: foobar_sig.parameters
Out[42]:
mappingproxy({'a': <Parameter "a: int">,
              'b': <Parameter "b: str">,
              'c': <Parameter "c: float = 3.2">})

创建函数签名

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

1
2
3
4
5
6
7
8
9
10
11
12
# 注意是首字母大写的Signature
In [43]: from inspect import Signature, Parameter

# 创建一个函数参数列表，列表内的元素由类Parameter的实例组成
# Parameter实例化时，依次接受参数名、参数类型、默认值和参数注解
# 默认值和参数类型默认为空，这里的空值不是None，而是Parameter.empty，代表没有值
In [44]: parms = [Parameter('x', Parameter.POSITIONAL_OR_KEYWORD),
    ...:          Parameter('y', Parameter.POSITIONAL_OR_KEYWORD),
    ...:          Parameter('z', Parameter.KEYWORD_ONLY, default=9)]

# 使用Signature类，接受函数参数列表，实例化出函数签名实例
In [45]: sig = Signature(parms)

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

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
In [46]: bound_args_01 = sig.bind(1, 2, z=3)

In [47]: bound_args_01
Out[47]: <BoundArguments (x=1, y=2, z=3)>

In [48]: bound_args_02 = sig.bind(1, 2)

In [49]: bound_args_02
Out[49]: <BoundArguments (x=1, y=2)>

# 缺少位置参数
In [50]: bound_args_03 = sig.bind(1)
TypeError: missing a required argument: 'y'
知识就是财富