专栏首页lzj_learn_note8-函数类型详解

8-函数类型详解

python的参数类型

python中函数(function)或方法(method)的参数类型有哪些,每种参数类型要怎么传参才能调用,默认参数要怎么设置才算合理。在python有一个标准模块inspect, 主要提供了四种用处:

  1. 对是否是模块,框架,函数等进行类型检查。
  2. 获取源码
  3. 获取类或函数的参数的信息
  4. 解析堆栈

很明显第3点就是我们想要的功能,inspect模块有对python函数的参数类型有详细的定义。

有哪几种参数类型?


POSITIONAL_OR_KEYWORD

如果没有任何*的声明,那么就是POSITIONAL_OR_KEYWORD类型的,如同语义一样,POSITIONAL_OR_KEYWORD类型的参数可以通过位置POSITIONAL传参调用,也可以过关键字KEYWORD传参。以下是一个最简单的例子:

def foo(a): 
    pass

# 位置传参调用
foo(1)
# 关键字传参调用
foo(a=1)

VAR_POSITIONAL

第二种是可变的位置参数,通过一个*前缀来声明,如果看到一个*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)

KEYWORD_ONLY

第三种是关键字参数,这种参数只会在VAR_POSITIONAL类型参数的后面而且不带**前缀。这类参数只能用关键字KEYWORD来传参,不可以用位置传参,因为位置传的参数全让前面的VAR_POSITIONAL类型参数接收完了,所以KEYWORD_ONLY只能通过关键字才能接收到参数值。以下是一个简单的例子:

# VAR_POSITIONAL不需要使用时,可以匿名化
def foo(*, c):
    pass

# 只能关键字传参调用
foo(c=1)

VAR_KEYWORD

第四种是可变的关键字参数,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}

POSITIONAL_ONLY

第五种是位置参数,属于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

默认参数


  • VAR类型不允许设置默认参数 POSITIONAL_OR_KEYWORDKEYWORD_ONLY可以自定义默认参数,而VAR_POSITIONALVAR_KEYWORD不允许自定义默认参数的,因为VAR_POSITIONAL的默认参数是tuple()空元祖,而VAR_KEYWORD的默认参数是dict()空字典。
  • 默认参数的位置 POSITIONAL_OR_KEYWORD类型的默认参数一定要放在后面,否则会报错,KEYWORD_ONLY虽然没有强制要求,因为都是用关键字传参,谁先谁后都无所谓,但最好还是尽可能地放在后面吧。
  • 默认参数绝对不能设置为可变类型(比如list, dict, set),如果你在函数内改变了默认参数,下次再调用时它就不再是默认值了。

正确的示例:

def foo(p1, p2=2.0, *, k1, k2=None):
    a_list = k2 or list()
    pass

foo(1, k1='3')

接收参数的优先级


  1. 先接收POSITIONAL_OR_KEYWORD
  2. 再接收KEYWORD_ONLY
  3. 再接收VAR_POSITIONALVAR_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)

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Android RecyclerView之粘性头部+点击事件

    实现上图列表的粘性头部功能一般通过在布局页面额外写粘性头部View,然后通过监听列表的滑动来控制显示隐藏粘性头部View。而如果列表使用RecyclerView...

    用户3106371
  • 前端开发学习──初识Html

    type:disc默认 实心小圆圈;square 小方块;circle 空心小圆圈

    用户3106371
  • 3-序列、列表、元组

    序列就是一堆数据元素的集合,并对每个元素进行编号。在Python中,字符串、列表、元组都属于序列,他们都具有一些特定的操作,如索引、切片、相加、相乘、in、长度...

    用户3106371
  • 实体识别+表格识别,A股上市公司公告信息抽取(附数据集+视频)

    数据说明 本次比赛将提供3种类型的数据: 1、原始公告pdf,以{公告id}.pdf命名; 2、公告pdf转换的html文件,以{公告id}.html命名; 3...

    机器学习AI算法工程
  • Java编程的一些小技巧-----基础语法篇(3)

    总之,如果你无需关心同步(synchronized)问题,我会建议用HashMap。反之,你可以考虑使用ConcurrentHashMap。

    秃头哥编程
  • Spring Boot中的Properties

    本文我们将会讨怎么在Spring Boot中使用Properties。使用Properties有两种方式,一种是java代码的注解,一种是xml文件的配置。本文...

    程序那些事
  • Python画一棵漂亮的樱花树(不同种樱花+玫瑰+圣诞树喔)

    最近翻到一篇知乎,上面有不少用Python(大多是turtle库)绘制的树图,感觉很漂亮,我整理了一下,挑了一些我觉得不错的代码分享给大家(这些我都测试过,确实...

    小草AI
  • 如何在 Ubuntu 20.04 上安装 TeamViewer

    TeamViewer 是一个跨平台解决方案,它可以被用来进行远程控制,桌面共享,在线会议,以及计算机之间的文件传输。

    雪梦科技
  • Java自动化测试框架-08 - TestNG之并行性和超时篇 (详细教程)

    可以通过在suite标签中使用 parallel 属性来让测试方法运行在不同的线程中。这个属性可以带有如下这样的值:

    北京-宏哥
  • 推荐系统结合知识图谱简单总结

    链接 | https://zhuanlan.zhihu.com/p/59762355

    张小磊

扫码关注云+社区

领取腾讯云代金券