在Python 3中实现类型检查器的简单方法


Posted in Python onJuly 03, 2015

示例函数

为了开发类型检查器,我们需要一个简单的函数对其进行实验。欧几里得算法就是一个完美的例子:
 

def gcd(a, b):
  
'''Return the greatest common divisor of a and b.'''
  a = abs(a)
  b = abs(b)
  if a < b:
    a, b = b, a
  while b != 0:
    a, b = b, a % b
  return a

在上面的示例中,参数 a 和 b 以及返回值应该是 int 类型的。预期的类型将会以函数注解的形式来表达,函数注解是 Python 3 的一个新特性。接下来,类型检查机制将会以一个装饰器的形式实现,注解版本的第一行代码是:
 

def gcd(a: int, b: int) -> int:

使用“gcd.__annotations__”可以获得一个包含注解的字典:
 

>>> gcd.__annotations__
{'return': <class 'int'>, 'b': <class 'int'>, 'a': <class 'int'>}
>>> gcd.__annotations__['a']
<class 'int'>

需要注意的是,返回值的注解存储在键“return”下。这是有可能的,因为“return”是一个关键字,所以不能用作一个有效的参数名。
检查返回值类型

返回值注解存储在字典“__annotations__”中的“return”键下。我们将使用这个值来检查返回值(假设注解存在)。我们将参数传递给原始函数,如果存在注解,我们将通过注解中的值来验证其类型:
 

def typecheck(f):
  def wrapper(*args, **kwargs):
    result = f(*args, **kwargs)
    return_type = f.__annotations__.get('return', None)
    if return_type and not isinstance(result, return_type):
      raise RuntimeError("{} should return {}".format(f.__name__, return_type.__name__))
    return result
  return wrapper

我们可以用“a”替换函数gcd的返回值来测试上面的代码:

Traceback (most recent call last):
 File "typechecker.py", line 9, in <module>
  gcd(1, 2)
 File "typechecker.py", line 5, in wrapper
  raise RuntimeError("{} should return {}".format(f.__name__, return_type.__name__))
RuntimeError: gcd should return int

由上面的结果可知,确实检查了返回值的类型。
检查参数类型

函数的参数存在于关联代码对象的“co_varnames”属性中,在我们的例子中是“gcd.__code__.co_varnames”。元组包含了所有局部变量的名称,并且该元组以参数开始,参数数量存储在“co_nlocals”中。我们需要遍历包括索引在内的所有变量,并从参数“args”中获取参数值,最后对其进行类型检查。

得到了下面的代码:
 

def typecheck(f):
  def wrapper(*args, **kwargs):
    for i, arg in enumerate(args[:f.__code__.co_nlocals]):
      name = f.__code__.co_varnames[i]
      expected_type = f.__annotations__.get(name, None)
      if expected_type and not isinstance(arg, expected_type):
        raise RuntimeError("{} should be of type {}; {} specified".format(name, expected_type.__name__, type(arg).__name__))
    result = f(*args, **kwargs)
    return_type = f.__annotations__.get('return', None)
    if return_type and not isinstance(result, return_type):
      raise RuntimeError("{} should return {}".format(f.__name__, return_type.__name__))
    return result
  return wrapper

在上面的循环中,i是数组args中参数的以0起始的索引,arg是包含其值的字符串。可以利用“f.__code__.co_varnames[i]”读取到参数的名称。类型检查代码与返回值类型检查完全一样(包括错误消息的异常)。

为了对关键字参数进行类型检查,我们需要遍历参数kwargs。此时的类型检查几乎与第一个循环中相同:
 

for name, arg in kwargs.items():
  expected_type = f.__annotations__.get(name, None)
  if expected_type and not isinstance(arg, expected_type):
    raise RuntimeError("{} should be of type {}; {} specified".format(name, expected_type.__name__, type(arg).__name__))

得到的装饰器代码如下:
 

def typecheck(f):
  def wrapper(*args, **kwargs):
    for i, arg in enumerate(args[:f.__code__.co_nlocals]):
      name = f.__code__.co_varnames[i]
      expected_type = f.__annotations__.get(name, None)
      if expected_type and not isinstance(arg, expected_type):
        raise RuntimeError("{} should be of type {}; {} specified".format(name, expected_type.__name__, type(arg).__name__))
    for name, arg in kwargs.items():
      expected_type = f.__annotations__.get(name, None)
      if expected_type and not isinstance(arg, expected_type):
        raise RuntimeError("{} should be of type {}; {} specified".format(name, expected_type.__name__, type(arg).__name__))
    result = f(*args, **kwargs)
    return_type = f.__annotations__.get('return', None)
    if return_type and not isinstance(result, return_type):
      raise RuntimeError("{} should return {}".format(f.__name__, return_type.__name__))
    return result
  return wrapper

将类型检查代码写成一个函数将会使代码更加清晰。为了简化代码,我们修改错误信息,而当返回值是无效的类型时,将会使用到这些错误信息。我们也可以利用 functools 模块中的 wraps 方法,将包装函数的一些属性复制到 wrapper 中(这使得 wrapper 看起来更像原来的函数):
 

def typecheck(f):
  def do_typecheck(name, arg):
    expected_type = f.__annotations__.get(name, None)
    if expected_type and not isinstance(arg, expected_type):
      raise RuntimeError("{} should be of type {} instead of {}".format(name, expected_type.__name__, type(arg).__name__))
 
  @functools.wraps(f)
  def wrapper(*args, **kwargs):
    for i, arg in enumerate(args[:f.__code__.co_nlocals]):
      do_typecheck(f.__code__.co_varnames[i], arg)
    for name, arg in kwargs.items():
      do_typecheck(name, arg)
 
    result = f(*args, **kwargs)
 
    do_typecheck('return', result)
    return result
  return wrapper

结论

注解是 Python 3 中的一个新元素,本文例子中的使用方法很普通,你也可以想象很多特定领域的应用。虽然上面的实现代码并不能满足实际产品要求,但它的目的本来就是用作概念验证。可以对其进行以下改善:

  •     处理额外的参数( args 中意想不到的项目)
  •     默认值类型检查
  •     支持多个类型
  •     支持模板类型(例如,int 型列表)
Python 相关文章推荐
python中lambda与def用法对比实例分析
Apr 30 Python
详解Python的hasattr() getattr() setattr() 函数使用方法
Jul 09 Python
pip安装py_zipkin时提示的SSL问题对应
Dec 29 Python
Python使用LDAP做用户认证的方法
Jun 20 Python
对Python中class和instance以及self的用法详解
Jun 26 Python
介绍一款python类型检查工具pyright(推荐)
Jul 03 Python
python中update的基本使用方法详解
Jul 17 Python
Python处理session的方法整理
Aug 29 Python
numpy实现神经网络反向传播算法的步骤
Dec 24 Python
Python3基于print打印带颜色字符串
Jul 06 Python
详解用selenium来下载小姐姐图片并保存
Jan 26 Python
pycharm配置安装autopep8自动规范代码的实现
Mar 02 Python
python插入排序算法实例分析
Jul 03 #Python
python列出目录下指定文件与子目录的方法
Jul 03 #Python
python清除字符串里非字母字符的方法
Jul 02 #Python
python清除字符串里非数字字符的方法
Jul 02 #Python
python实现在控制台输入密码不显示的方法
Jul 02 #Python
python获取外网ip地址的方法总结
Jul 02 #Python
python实现将英文单词表示的数字转换成阿拉伯数字的方法
Jul 02 #Python
You might like
php mysql数据库操作类
2008/06/04 PHP
php递归获取目录内文件(包含子目录)封装类分享
2013/12/25 PHP
PHP SPL标准库中的常用函数介绍
2015/05/11 PHP
PHP类型约束用法示例
2016/09/28 PHP
PHP缩略图生成和图片水印制作
2017/01/07 PHP
Yii2.0框架实现带分页的多条件搜索功能示例
2019/02/20 PHP
TP5框架请求响应参数实例分析
2019/10/17 PHP
javascript 实现 秒杀,团购 倒计时展示的记录 分享
2013/07/12 Javascript
ExtJS自定义主题(theme)样式详解
2013/11/18 Javascript
display和visibility的区别示例介绍
2014/02/26 Javascript
简介JavaScript中strike()方法的使用
2015/06/08 Javascript
jquery实现移动端点击图片查看大图特效
2020/09/11 Javascript
Node.js用readline模块实现输入输出
2016/12/16 Javascript
Javascript中的 “&amp;” 和 “|” 详解
2017/02/02 Javascript
Vue.js bootstrap前端实现分页和排序
2017/03/10 Javascript
node.JS md5加密中文与php结果不一致的解决方法
2017/05/05 Javascript
JS关于刷新页面的相关总结
2018/05/09 Javascript
angular实现input输入监听的示例
2018/08/31 Javascript
如何使用JavaScript实现栈与队列
2019/06/24 Javascript
解决await在forEach中不起作用的问题
2021/02/25 Javascript
[02:05]2014DOTA2西雅图国际邀请赛 BBC第二天小组赛总结
2014/07/11 DOTA
python分析网页上所有超链接的方法
2015/05/08 Python
简单讲解Python编程中namedtuple类的用法
2016/06/21 Python
pandas series序列转化为星期几的实例
2018/04/11 Python
python+selenium实现自动化百度搜索关键词
2019/06/03 Python
Django admin禁用编辑链接和添加删除操作详解
2019/11/15 Python
python循环输出三角形图案的例子
2019/11/22 Python
以SQLite和PySqlite为例来学习Python DB API
2020/02/05 Python
New Era英国官网:美国棒球帽品牌
2018/03/21 全球购物
VICHY薇姿俄罗斯官方网上商店:法国护肤品牌,火山温泉水
2019/11/22 全球购物
农民工工资支付承诺函
2014/03/31 职场文书
教师个人培训总结
2015/02/11 职场文书
大学生社会实践活动总结报告
2015/05/06 职场文书
土木工程毕业答辩开场白
2015/05/29 职场文书
闪闪的红星观后感
2015/06/08 职场文书
电台广播稿范文
2015/08/19 职场文书