https://github.com/ausaki/python-validator
a data validator like Django ORM
https://github.com/ausaki/python-validator
data python python-validator schema validate validation validation-library validator
Last synced: 5 days ago
JSON representation
a data validator like Django ORM
- Host: GitHub
- URL: https://github.com/ausaki/python-validator
- Owner: ausaki
- License: mit
- Created: 2018-07-27T10:17:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T11:52:18.000Z (over 2 years ago)
- Last Synced: 2025-10-28T05:12:08.791Z (3 months ago)
- Topics: data, python, python-validator, schema, validate, validation, validation-library, validator
- Language: Python
- Size: 1.01 MB
- Stars: 43
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python-validator
python-validator 是一个类似于 Django ORM 的数据校验库，适用与任何需要进行数据校验的应用，比较常见的是 Web 后端校验前端的输入数据。
[文档](https://ausaki.github.io/python-validator)
---
[
](https://pypi.org/project/python-validator/)
[](https://pypi.org/project/python-validator/)
[](https://pypi.org/project/python-validator/)
[](https://pypi.org/project/python-validator/)
[](https://travis-ci.org/ausaki/python-validator)
---
## 特性
- 支持 python2 和 python3。
- 使用类描述数据结构，数据字段一目了然。另外也支持使用字典定义数据结构。
- 可以自动生成用于测试的 mocking data。
- 可以打印出清晰的数据结构。
- 易于扩展。
## 依赖
- six
- IPy
- pytz[可选，`DatetimeField` 的 `tzinfo` 参数需要一个 `tzinfo` 对象]
## 安装
`pip install python-validator`
## 快速入门
假设现在正在开发一个上传用户信息的接口 `POST /api/user/`，用户信息如下：
| 字段 | 类型 | 描述 |
|--|--|--|
|name|String| 必选 |
|age|integer| 可选，默认 20|
|sex|String, 'f'表示女, 'm'表示男 | 可选, 默认 None|
原始的、枯燥无味的、重复性劳动的数据校验代码可能是下面这样：
```python
def user(request):
# data = json.loads(request.body)
data = {
'age': '24f',
'sex': 'f'
}
name = data.get('name')
age = data.get('age', 20)
sex = dage.get('sex')
if name is None or len(name) == 0:
return Response('必须提供 name', status=400)
try:
age = int(age)
except ValueError as e:
return Response('age 格式错误', status=400)
if sex is not None and sex not in ('f', 'm'):
return Response('sex 格式错误', status=400)
user_info = {
'name': name,
'age': age,
'sex': sex,
}
...
```
上面这段代码总的来说有几个问题：
- 枯燥无味和重复性代码，不断的取出数据，检查字段是否缺失，类型是否合法等等。
- 从数据校验的代码无法轻易看出用户信息的数据结构，即字段是什么类型的，是否可选，默认值是什么。
**使用 python-validator 校验数据**
首先定义一个 UserInfoValidator 类
```python
# validators.py
from validator import Validator, StringField, IntegerField, EnumField
class UserInfoValidator(Validator):
name = StringField(max_length=50, required=True)
age = IntegerField(min_value=1, max_value=120, default=20)
sex = EnumField(choices=['f', 'm'])
```
接下来使用 `UserInfoValidator` 进行数据校验，
```python
from .validators import UserInfoValidator
def user(request):
# data = json.loads(request.body)
data = {
'age': '24',
'sex': 'f'
}
v = UserInfoValidator(data)
if not v.is_valid():
return Response({'msg': v.str_errors, 'code': 400}, status=400)
user_info = v.validated_data
...
```
`v.str_errors` 是一个字段名 - 错误信息的 dict，例如：
```python
{'age': 'got a wrong type: str, expect integer', 'name': 'Field is required'}
```
错误信息解释：
- `age` 等于 "24"，不是合法的 `int` 类型。
- `name` 是必须提供的，且没有指定默认值。
v.validated_data 是校验后合法的数据，例如：
```json
{'age': 24, 'name': u'Michael', 'sex': 'f'}
```
下面是一些错误数据的例子：
```python
data: {'age': 24, 'name': 'abcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabc', 'sex': 'f'}
is_valid: False
errors: {'name': 'string is too long, max-lenght is 50'}
validated_data: None
```
```python
data: {'age': 24, 'name': 'Michael', 'sex': 'c'}
is_valid: False
errors: {'sex': "'c' not in the choices"}
validated_data: None
```
细心的同学可能发现了 `IntegerField` 不接受 “数字字符串”，上面的例子中 `age` 是一个 `IntegerField`，形如 `'24'` 这样的值是非法的。在某些情况下，你可能希望 `IntegerField` 不要这么严格，`'24'` 这样的值也是可以接受的，那么可以把 `strict` 选项设为 `False`，如：`age = IntegerField(min_value=1, max_value=120, default=20, strict=False)`。当 `strict` 选项为 `False` 时，python-validator 会尝试进行类型转换，假如转换失败则会报错。
接下来你可以 [查看进阶](https://ausaki.github.io/python-validator/advanced/) 了解 python-validator 更多的用法，[查看字段 API](https://ausaki.github.io/python-validator/fields/) 了解字段的详细信息。
## 测试
使用 tox 和 pytest 进行代码测试。
推荐使用 [pipenv](https://github.com/pypa/pipenv) 来管理项目依赖。
**假如使用 pipenv：**
- `pipenv install`(安装依赖库)
- `pipenv run test`
**假如使用 pip：**
- `pip install -r requirements.txt`(安装依赖库)
- `tox`
## 其它
如果遇到 BUG 或者有任何建议，欢迎提交 issue 或者 PR。
如果希望贡献代码，请尽量编写测试用例并测试你的代码，然后再提交 PR。