A dead-simple utility that validates if object has a certain structure.
Project description
Simple schema validator
A dead-simple utility that validates if object has a certain structure. Used in some of our projects.
pip install simple_schema_validator
An example:
Lets say we have an API that returns the following data:
{
"user": 1,
"profile": {
"email": "some@user.com",
"name": "Some User",
"age": 20
},
"tokens": {
"jwt": "...",
"refresh": "...",
"firebase": "...",
}
}
And we are writing a simple integration test, that wants to assure the response has a certain structure.
Then we can use the schema validator like so:
from simple_schema_validator import schema_validator
data = get_data_from_api()
schema = {
'user': None,
'profile': {
'email': None,
'name': None,
'age': None
},
'tokens': {
'jwt': None,
'refresh': None,
'firebase': None
}
}
valid, missing_keys, additional_keys = schema_validator(schema, data)
assert valid, f'Response not valid, missing: {missing_keys}, additional: {additional_keys}'
missing_keys
are those keys that are required in theschema
, but not found indata
.additional_keys
are those keys present indata
, but not required by theschema
.- Nested keys are represented with "dot" notation -
profile.email
,tokens.jwt
, etc.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for simple_schema_validator-0.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3820ac5debd96e477c3b510465e5b71cd2a451549e83bf02033fa13b13188940 |
|
MD5 | 24b3dfe204ea8f7f242aa93f56085dd0 |
|
BLAKE2b-256 | f4be3deebf051072db449bff4a8c4df20bef4e2a1aafde7005091e5a9f291ec3 |
Close
Hashes for simple_schema_validator-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b42bc05c094437a98f77ac840c8f42bc1bb321aba9f6d494ba014fca4d8abd80 |
|
MD5 | 4f7cec2aa8c1b94406ddf669829b0d22 |
|
BLAKE2b-256 | 26e4de3a6df5a78d7f696f52b8bed3309a8370fa293750785c8a69bf12d66ef3 |