python装饰器使用实例:验证参数合法性

python是不带静态检查的动态语言,有时候需要在调用函数时保证参数合法。检查参数合法性是一个显著的切面场景,各个函数都可能有这个需求。但另一方面,参数合法性是不是应该由调用方来保证比较好也是一个需要结合实际才能回答的问题,总之双方约定好,不要都不检查或者都检查就可以了。下面这个模块用于在函数上使用装饰器进行参数的合法性验证。

你可以直接执行这个模块进行测试,如果完全没有输出则表示通过。你也可以找到几个以_test开头的函数,所有的测试用例都包含在这几个函数中。使用方法参见模块文档和测试用例。

# -*- coding: utf-8 -*-
”’
@summary: 验证器
该模块提供了一个装饰器用于验证参数是否合法,使用方法为:
from validator import validparam, nullok, multitype
@validparam(i=int)
def foo(i):
return i+1
编写验证器:
1. 仅验证类型:
@validparam(type, …)
例如:
检查第一个位置的参数是否为int类型:
@validparam(int)
检查名为x的参数是否为int类型:
@validparam(x=int)
验证多个参数:
@validparam(int, int)
指定参数名验证:
@validparam(int, s=str)
针对*和**参数编写的验证器将验证这些参数实际包含的每个元素:
@validparam(varargs=int)
def foo(*varargs): pass
@validparam(kws=int)
def foo7(s, **kws): pass
2. 带有条件的验证:
@validparam((type, condition), …)
其中,condition是一个表达式字符串,使用x引用待验证的对象;
根据bool(表达式的值)判断是否通过验证,若计算表达式时抛出异常,视为失败。
例如:
验证一个10到20之间的整数:
@validparam(i=(int, ’10

Posted in 未分类