Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/humbertzhang/jsoncensor
Check json data in your python web service.
https://github.com/humbertzhang/jsoncensor
aiohttp flask python web webservice
Last synced: 22 days ago
JSON representation
Check json data in your python web service.
- Host: GitHub
- URL: https://github.com/humbertzhang/jsoncensor
- Owner: Humbertzhang
- Created: 2018-02-07T13:56:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-09T03:39:21.000Z (almost 6 years ago)
- Last Synced: 2024-10-04T12:34:02.946Z (about 1 month ago)
- Topics: aiohttp, flask, python, web, webservice
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jsoncensor
Check json data in your python web service.
# 作用
1,检查key数目是否一致
2,检查key是否一致
3,检查value的type是否一致, 若value为一个对象，则递归地检查它的key number，Key name, value type.
# Usage
Support both python2.7 and python3
`pip install jsoncensor`
创建一个标准json数据的字典，把它和待检查字典作为初始化JsonCensor对象的参数传入
调用JsonCensor对象的check方法.
```Python
from jsoncensor import JsonCensor
standard = {...}
suspect = {...}
jc = JsonCensor(standard, suspect)
ret = jc.check()
if ret['statu'] == True:
print("ok")
else:
print(ret)
```
返回结构体:
```
{
"statu": True Or False,
"error": string 若有错误为错误类型，否则为None,
"error_indicator": string 错误对象的字符串,
"should_be": string 错误对象应有的状态
}
```
# 示例
`plain_example`
```Python
from jsoncensor import JsonCensor
standard = {
"k1":"v1",
"k2":"v2",
"k3":["v3_1", "v3_2", "v3_3"],
"k4":{
"k4_1":"v4_1",
"k4_2":"v4_2",
"k4_3":["v4_3_1", "v_4_3_2"],
"k4_4":{
"k_4_4_1":"v_4_4_1"
}
},
"k5":{
"k5_1":{
"k5_1_1":{
"k5_1_1_1":{
"k5_1_1_1":"pass"
}
}
}
}
}
perfect_suspect = {
"k1":"test",
"k2":"test",
"k3":["v3_1", "v3_2", "v3_3"],
"k4":{
"k4_1":"v4_1",
"k4_2":"v4_2",
"k4_3":["v4_3_1", "v_4_3_2", "Helloooo"],
"k4_4":{
"k_4_4_1":"v_4_4_1"
}
},
"k5":{
"k5_1":{
"k5_1_1":{
"k5_1_1_1":{
"k5_1_1_1":"test"
}
}
}
}
}
keynumber_suspect = {
"k3":["v3_1", "v3_2", "v3_3"],
"k4":{
"k4_1":"v4_1",
"k4_2":"v4_2",
"k4_3":["v4_3_1", "v_4_3_2", "Helloooo"],
"k4_4":{
"k_4_4_1":"v_4_4_1"
}
},
"k5":{
"k5_1":{
"k5_1_1":{
"k5_1_1_1":{
"k5_1_1_1":"test"
}
}
}
}
}
keyname_suspect = {
"k1":"test",
"k2":"test",
"k3":["v3_1", "v3_2", "v3_3"],
"k4":{
"k4_1":"v4_1",
"k4_2":"v4_2",
"k4_3":["v4_3_1", "v_4_3_2", "Helloooo"],
"k4_4":{
"k_4_4_1":"v_4_4_1"
}
},
"k5":{
"k5_1":{
"k5_1_1":{
"fuckccnu":{ #<-Here
"k5_1_1_1":"test"
}
}
}
}
}
valtype_suspect = {
"k1":["test"], #<- Difference Here
"k2":"test",
"k3":["v3_1", "v3_2", "v3_3"],
"k4":{
"k4_1":"v4_1",
"k4_2":"v4_2",
"k4_3":["v4_3_1", "v_4_3_2", "Helloooo"],
"k4_4":{
"k_4_4_1":"v_4_4_1"
}
},
"k5":{
"k5_1":{
"k5_1_1":{
"k5_1_1_1":{
"k5_1_1_1":"test"
}
}
}
}
}
jc1 = JsonCensor(standard, perfect_suspect)
print(jc1.check() == True)
print(jc1.check())
jc2 = JsonCensor(standard, keynumber_suspect)
print(jc2.check() == True)
print(jc2.check())
jc3 = JsonCensor(standard, keyname_suspect)
print(jc3.check() == True)
print(jc3.check())
jc4 = JsonCensor(standard, valtype_suspect)
print(jc4.check() == True)
print(jc4.check())
```
python3 plain_example.py 结果输出
```
True
{'statu': True, 'error': None, 'error_indicator': None, 'should_be': None}
False
{'statu': False, 'error': 'KeyNumberError', 'error_indicator': 'k3, k4, k5', 'should_be': 'k1, k2, k3, k4, k5'}
False
{'statu': False, 'error': 'KeyNameError', 'error_indicator': 'fuckccnu', 'should_be': 'k5_1_1_1'}
False
{'statu': False, 'error': 'TypeError', 'error_indicator': "['test']", 'should_be': 'str'}
```
关于flask或aiohttp的例子请见example
`https://www.cnblogs.com/sting2me/p/6550897.html`