在python中函数(function)或方法(method)的参数类型有哪些,每种参数类型要怎么传参才能调用,默认参数要怎么设置才算合理。在python有一个标准模块inspect
, 主要提供了四种用处:
很明显第3点就是我们想要的功能,inspect
模块有对python函数的参数类型有详细的定义。
有哪几种参数类型?
如果没有任何*
的声明,那么就是POSITIONAL_OR_KEYWORD
类型的,如同语义一样,POSITIONAL_OR_KEYWORD
类型的参数可以通过位置POSITIONAL
传参调用,也可以过关键字KEYWORD
传参。以下是一个最简单的例子:
def foo(a):
pass
# 位置传参调用
foo(1)
# 关键字传参调用
foo(a=1)
第二种是可变的位置参数,通过一个*
前缀来声明,如果看到一个*xxx
的函数参数声明,那一定是属于VAR_POSITIONAL
类型的,如同语义,这种类型的参数只能通过位置POSITIONAL
传参调用,不支持关键字KEYWORD
传参,在函数内部,VAR_POSITIONAL
类型的参数以一个元祖(tuple)显示,有一点需要注意的,VAR_POSITIONAL
类型可以不传任何参数调用也不会报错,而且只允许存在一个。以下是一个简单的例子:
def foo(*b):
print(b)
# 不传参数不会报错,参数值是一个空元祖
foo() # 结果是 ()
# 可以传入任意个位置参数调用
foo(1, 2.0, '3', True) #结果是 (1, 2.0, '3', True)
第三种是关键字参数,这种参数只会在VAR_POSITIONAL
类型参数的后面而且不带**
前缀。这类参数只能用关键字KEYWORD
来传参,不可以用位置传参,因为位置传的参数全让前面的VAR_POSITIONAL
类型参数接收完了,所以KEYWORD_ONLY
只能通过关键字才能接收到参数值。以下是一个简单的例子:
# VAR_POSITIONAL不需要使用时,可以匿名化
def foo(*, c):
pass
# 只能关键字传参调用
foo(c=1)
第四种是可变的关键字参数,VAR_KEYWORD
类型的参数通过**
前缀来声明。这种类型的参数只能通过关键字KEYWORD
调用,但可以接收任意个关键字参数,甚至是0个参数,在函数内部以一个字典(dict)显示。VAR_KEYWORD
类型的参数只允许有一个,只允许在函数的最后声名。以下是简单的例子:
def foo(**d):
print(d)
# 不传参数不会报错,参数值是一个空字典
foo() # 结果是 {}
# 可以传入任意个关键字参数调用
foo(a=1, b=2.0, c='3', d=True) # 结果是 {'d': True, 'c': '3', 'b': 2.0, 'a': 1}
第五种是位置参数,属于python的历史产物,你无法在高版本的python中创建一个POSITIONAL_ONLY
类型的参数,在某种底层的内置函数也许会使用这类型的参数,试用inspect
模块也没法正确识别它的命名,但在Ipython的??
帮助下,还是能看到Init signature: dict(self, /, *args, **kwargs)
这里的self
就是位置参数POSITIONAL_ONLY
了。现在python推荐用VAR_POSITIONAL
来代替它。下面是一个综合示例:
import inspect
def foo(a, *b, c, **d):
pass
for name, parame in inspect.signature(foo).parameters.items():
print(name, ': ', parame.kind)
a : POSITIONAL_OR_KEYWORD
b : VAR_POSITIONAL
c : KEYWORD_ONLY
d : VAR_KEYWORD
POSITIONAL_OR_KEYWORD
和KEYWORD_ONLY
可以自定义默认参数,而VAR_POSITIONAL
和VAR_KEYWORD
不允许自定义默认参数的,因为VAR_POSITIONAL
的默认参数是tuple()
空元祖,而VAR_KEYWORD
的默认参数是dict()
空字典。POSITIONAL_OR_KEYWORD
类型的默认参数一定要放在后面,否则会报错,KEYWORD_ONLY
虽然没有强制要求,因为都是用关键字传参,谁先谁后都无所谓,但最好还是尽可能地放在后面吧。正确的示例:
def foo(p1, p2=2.0, *, k1, k2=None):
a_list = k2 or list()
pass
foo(1, k1='3')
POSITIONAL_OR_KEYWORD
KEYWORD_ONLY
VAR_POSITIONAL
和VAR_KEYWORD
,这两者没有交集def foo(a, *b, c, **d):
print(a, b, c, d, sep='\n')
foo(1, 2, '3', c=3, x=1, y=2)
# a: 1
# b: (2, '3')
# c: 3
# d: {'x': 1, 'y': 2}
可以使用inspect模块的signature方法获取函数签名
import inspect
def func_a(arg_a, *args, arg_b='hello', **kwargs):
print(arg_a, arg_b, args, kwargs)
if __name__ == '__main__':
# 获取函数签名
func_signature = inspect.signature(func_a)
func_args = []
# 获取函数所有参数
for k, v in func_signature.parameters.items():
# 获取函数参数后,需要判断参数类型
# 当kind为 POSITIONAL_OR_KEYWORD,说明在这个参数之前没有任何类似*args的参数,那这个函数可以通过参数位置或者参数关键字进行调用
# 这两种参数要另外做判断
if str(v.kind) in ('POSITIONAL_OR_KEYWORD', 'KEYWORD_ONLY'):
# 通过v.default可以获取到参数的默认值
# 如果参数没有默认值,则default的值为:class inspect_empty
# 所以通过v.default的__name__ 来判断是不是_empty 如果是_empty代表没有默认值
# 同时,因为类本身是type类的实例,所以使用isinstance判断是不是type类的实例
if isinstance(v.default, type) and v.default.__name__ == '_empty':
func_args.append({k: None})
else:
func_args.append({k: v.default})
# 当kind为 VAR_POSITIONAL时,说明参数是类似*args
elif str(v.kind) == 'VAR_POSITIONAL':
args_list = []
func_args.append(args_list)
# 当kind为 VAR_KEYWORD时,说明参数是类似**kwargs
elif str(v.kind) == 'VAR_KEYWORD':
args_dict = {}
func_args.append(args_dict)
print(func_args)