Python中的函数参数类型检查

 更新时间:2022年12月19日 09:17:51   作者:子休_  
这篇文章主要介绍了Python中的函数参数类型检查,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

Python函数参数类型检查

有一个很经典的笑话:

三个月之前,只有我和上帝知道这代码是干什么的。

现在,只有上帝知道了。

在Python中,不知道函数参数类型是一个很正常的事情,特别是在一个大项目里。

我见过有些项目里,每一个函数体的前十几行都在检查参数类型,这实在是太麻烦了。而且一旦参数有改动,这部分也需要改动。

下面我们用装饰器来实现

函数参数的强制类型检查。

首先,这个装饰器,要接受类型参数,和指定函数参数的类型参数。也就是一个list和一个dict

from functools import wraps

def typeassert(*type_args, **type_kwargs):
    def decorate(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            return func(*args, **kwargs)
        return wrapper
    return decorate

@wraps(func)的作用请看我的另一篇

那么,接下来,在装饰器中,我们需要获取函数参数列表,并且要和类型参数表映射。

这要借助Python的一个标准库——inspect 这个库一般用于Python代码调试

from inspect import signature
from functools import wraps

def typeassert(*type_args, **type_kwargs):
    def decorate(func):
        sig = signature(func)
        bound_types = sig.bind_partial(*type_args, **type_kwargs).arguments

        @wraps(func)
        def wrapper(*args, **kwargs):
            return func(*args, **kwargs)
        return wrapper
    return decorate

上面的代码中,我们使用inspect中的signature方法获取了func的Signature对象,然后使用bind_partial方法创建了(*type_args, **type_kwargs)到func参数的映射(也就是一个字典)。

接下来就简单了,我们只需要再获取(*args, **kwargs)的类型,使用isintance函数进行比较就好。

from inspect import signature
from functools import wraps

def typeassert(*type_args, **type_kwargs):
    def decorate(func):
        sig = signature(func)
        bound_types = sig.bind_partial(*type_args, **type_kwargs).arguments

        @wraps(func)
        def wrapper(*args, **kwargs):
            bound_values = sig.bind(*args, **kwargs)
            for name, value in bound_values.arguments.items():
                if name in bound_types:
                    if not isinstance(value, bound_types[name]):
                        raise TypeError('Argument {} must be {}'.format(name, bound_types[name]))
            return func(*args, **kwargs)
        return wrapper
    return decorate

运行如下代码

@typeassert(int, int)
def add(x, y):
    return x+y

print(add("u", 2))

能看到报错如下

Traceback (most recent call last):
  File "c:\Users\Chen\Desktop\typeassert.py", line 32, in <module>
    print(add("u", 2))
  File "c:\Users\Chen\Desktop\typeassert.py", line 22, in wrapper
    'Argument {} must be {}'.format(name, bound_types[name])
TypeError: Argument x must be <class 'int'>

很贴心的提醒了我们哪一个参数应该是什么类型。

你甚至可以自己改动这个装饰器,让它还能告诉你传进去了什么错误参数(特别是写爬虫的时候,参数很难掌握,一旦报错,还得重跑一遍才知道为什么。)

你也可以指定某一个参数的类型,譬如

@typeassert(int, z=str)
def display(x, y, z):
    print(x, y, z)

这时你会发现,y的类型就像原生的Python函数一样,什么都行。而x必须是int,z必须是str。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • tkinter如何实现label超链接调用浏览器打开网址

    tkinter如何实现label超链接调用浏览器打开网址

    这篇文章主要介绍了tkinter如何实现label超链接调用浏览器打开网址问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-01-01
  • python通过实例讲解反射机制

    python通过实例讲解反射机制

    这篇文章主要介绍了python通过实例讲解反射机制,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-10-10
  • anaconda虚拟环境python sklearn库的安装过程

    anaconda虚拟环境python sklearn库的安装过程

    Anaconda是专注于数据分析的Python发行版本,包含了conda、Python等190多个科学包及其依赖项,这篇文章主要给大家介绍了关于anaconda虚拟环境python sklearn库的安装过程,需要的朋友可以参考下
    2023-11-11
  • Flask实现定制日志并输出到文件

    Flask实现定制日志并输出到文件

    这篇文章主要为大家学习介绍了Flask如何实现定制日志并输出到文件,文中的示例代码简介易懂,感兴趣的小伙伴快跟随小编一起学习一下吧
    2023-07-07
  • tensorflow模型转ncnn的操作方式

    tensorflow模型转ncnn的操作方式

    这篇文章主要介绍了tensorflow模型转ncnn的操作方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-05-05
  • 如何使用Python 绘制瀑布图

    如何使用Python 绘制瀑布图

    这篇文章主要介绍了如何使用Python 绘制瀑布图,我们一起了解瀑布图的重要性,以及如何使用不同的绘图库绘制瀑布图。瀑布图是一种二维图表,专门用于了解随着时间或多个步骤或变量的增量正负变化的影响,下文更多详细内容需要的小伙伴可以参考一下
    2022-05-05
  • 浅谈flask中的before_request与after_request

    浅谈flask中的before_request与after_request

    这篇文章主要介绍了浅谈flask中的before_request与after_request,小编觉得还是挺不错的,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01
  • Python PyJWT库简化JSON Web Token的生成与验证

    Python PyJWT库简化JSON Web Token的生成与验证

    PyJWT库为Python开发者提供了简便的生成和验证JWT的工具,本文将深入介绍PyJWT库的核心概念、功能以及实际应用,通过丰富的示例代码,帮助大家更全面地了解和应用这一强大的JWT库
    2023-12-12
  • Pytorch深度学习之实现病虫害图像分类

    Pytorch深度学习之实现病虫害图像分类

    PyTorch是一个开源的Python机器学习库,基于Torch,用于自然语言处理等应用程序。它具有强大的GPU加速的张量计算和自动求导系统的深度神经网络。本文将介绍如何通过PyTorch实现病虫害图像分类,感兴趣的可以学习一下
    2021-12-12
  • Python Socket编程详解

    Python Socket编程详解

    这篇文章主要介绍了Python Socket编程的相关资料,帮助大家更好的理解和学习使用python,感兴趣的朋友可以了解下
    2021-04-04

最新评论