Python数据验证库(一) validators

很多时候我们的程序会接收来自外部的数据，但是我们不能确保接收的数据是我们期待的数据，这时可能需要对数据进行一些验证。比如，在做接口测试时，我们发送http请求，会受到服务器的应答信息，这时需要对接收的数据进行检查，判断是否符合预期。

这里介绍一个简单的数据验证库validators，后续还会介绍其他的数据验证库。

python有很多数据验证工具，但是其他的数据验证工具都需要自己定义模式。validators是一个简单的数据验证库，当验证一个简单的值时，不需要定义一个表单或模式。

一、安装

$ pip install validators

目前validators支持python版本2.7, 3.3, 3.4, 3.5 和PyPy

二、基础的validators

在validators中每一个validator是一个简单的函数，函数参数为要验证的值，一些函数可能有额外的关键字参数。对于每一个函数，如果验证成功，则返回True；若验证失败，则返回一个ValidationFailure对象。

验证函数介绍

1、`validators.between(value, min=None, max=None)`

验证一个数字value是否在最小值min和最大值max之间，value不仅仅可以是整数，也可以是其它数据类型，例如floats, decimals 和 dates.

>>>from validators import between
>>>between(5, min=2)
True
>>>between(13.2, min=13, max=14)
True
>>>between(500, max=400)
ValidationFailure(func=between, args=...)
>>>between(
...     datetime(2000, 11, 11),
...     min=datetime(1999, 11, 11)
... )
True

Parameters:
• min – The minimum required value of the number. If not provided, minimum value will not be checked.
• max – The maximum value of the number. If not provided, maximum value will not be checked.

2、`validators.domain(value)`

验证value是否是一个有效域。如果value是一个有效域名，函数返回True, 否则返回 ValidationFailure.

>>> domain('example.com')
True
>>> domain('example.com/')
ValidationFailure(func=domain, ...)

也支持国际化域名(IDN domain),例如：

>>> domain('xn----gtbspbbmkef.xn--p1ai')
True

3、`validators.email(value, whitelist=None)`

验证是否是合法的邮件地址，如果是，函数返回True, 否则返回 ValidationFailure.

>>> email('someone@example.com')
True
>>> email('bogus@@')
ValidationFailure(func=email, ...)

4、`validators.iban(value)`

验证是否是合法的国际银行账户号码，如果是，函数返回True, 否则返回 ValidationFailure.

>>> iban('DE29100500001061045672')
True
>>> iban('123456')
ValidationFailure(func=iban, ...)

5、`validators.ip_address.ipv4(value)`

验证是否是合法的ipv4地址，如果是，函数返回True, 否则返回 ValidationFailure.

>>>ipv4('123.0.0.7')
True
>>> ipv4('900.80.70.11')
ValidationFailure(func=ipv4, args={'value': '900.80.70.11'})

6、`validators.ip_address.ipv6(value)`

验证是否是合法的ipv6地址，如果是，函数返回True, 否则返回 ValidationFailure.

>>>ipv6('abcd:ef::42:1')
True
>>> ipv6('abc.0.0.1')
ValidationFailure(func=ipv6, args={'value': 'abc.0.0.1'})

7、validators.length(value, min=None, max=None)

验证给定的字符串长度是否在指定范围内。

>>> length('something', min=2)
True
>>> length('something', min=9, max=9)
True
>>> length('something', max=5)
ValidationFailure(func=length, ...)

8、`validators.mac_address(value)`

验证是否是合法的mac地址，如果是，函数返回True, 否则返回 ValidationFailure.

>>> mac_address('01:23:45:67:ab:CD')
True
>>> mac_address('00:00:00:00:00')
ValidationFailure(func=mac_address, args={'value': '00:00:00:00:00'})

9、`validators.slug(value)`

验证是否是合法的slug，如果是，函数返回True, 否则返回 ValidationFailure.

>>> slug('my.slug')
ValidationFailure(func=slug, args={'value': 'my.slug'})
>>> slug('my-slug-2134')
True

10、`validators.truthy(value)`

>>> truthy(1)
True
>>> truthy('someone')
True
>>> truthy(0)
ValidationFailure(func=truthy, args={'value': 0})
>>> truthy('    ')
ValidationFailure(func=truthy, args={'value': '    '})
>>> truthy(False)
ValidationFailure(func=truthy, args={'value': False})
>>> truthy(None)
ValidationFailure(func=truthy, args={'value': None})

11、`validators.url(value, public=False)`

验证是否是合法的url，如果是，函数返回True, 否则返回 ValidationFailure.

>>> url('http://foobar.dk')
True
>>> url('http://10.0.0.1')
True
>>> url('http://foobar.d')
ValidationFailure(func=url, ...)
>>> url('http://10.0.0.1', public=True)
ValidationFailure(func=url, ...)

Parameters:
• value – 要验证的url
• public – (default=False) Set True to only allow a public IP address

12、`validators.i18n.fi.fi_business_id(business_id)`

验证Finnish Business ID.

>>> fi_business_id('0112038-9')  # Fast Monkeys Ltd
True
>>> fi_business_id('1234567-8')  # Bogus ID
ValidationFailure(func=fi_business_id, ...)

13、`validators.i18n.fi.fi_ssn(ssn)`

验证Finnish Social Security Number.

>>> fi_ssn('010101-0101')
True
>>> fi_ssn('101010-0102')
ValidationFailure(func=fi_ssn, args={'ssn': '101010-0102'})

三、装饰器，自定义验证函数

class validators.utils.ValidationFailure(func, args)

validators.utils.validator(func, *args, **kwargs)

例：

@validator
def is_even(value):
    return not (value % 2)

@validator
def is_positive(value):
    return value > 0

@validator
def is_string(value):
    return isinstance(value, str)

if __name__ == "__main__" :
    print is_even(2)
    print is_even(3)
    print is_positive(4)
    print is_positive(0)
    print is_positive(-1)
    print is_string("hello")
    print is_string(3)

控制台输出结果：

True
ValidationFailure(func=is_even, args={'value': 3})
True
ValidationFailure(func=is_positive, args={'value': 0})
ValidationFailure(func=is_positive, args={'value': -1})
True
ValidationFailure(func=is_string, args={'value': 3})

下一篇：Python数据验证库（二）validator
http://www.jianshu.com/p/eee56214af9c