Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elliotgao2/xdata
Data validator for the zen of python
https://github.com/elliotgao2/xdata
data-validation datatype marshalling python serialization validation validator xdata
Last synced: about 1 month ago
JSON representation
Data validator for the zen of python
- Host: GitHub
- URL: https://github.com/elliotgao2/xdata
- Owner: elliotgao2
- License: mit
- Created: 2017-03-09T16:02:00.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-29T02:59:46.000Z (almost 8 years ago)
- Last Synced: 2024-10-28T22:38:09.354Z (2 months ago)
- Topics: data-validation, datatype, marshalling, python, serialization, validation, validator, xdata
- Language: Python
- Homepage: https://gaojiuli.github.io/xdata/
- Size: 753 KB
- Stars: 23
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# XData
](https://travis-ci.org/gaojiuli/xdata.svg?branch=master)
](https://img.shields.io/pypi/l/xdata.svg)
](https://img.shields.io/pypi/v/xdata.svg)
](https://img.shields.io/pypi/pyversions/xdata.svg)
A simple but useful library for validating data.
## Features
- Easy to use, only one step
- Easy to extend
- No dependencies
## Required
- python >= 3.5
## Installation
`pip install xdata`
## Usage
### ValidatedData
```python
from xdata.schema import Schema
from xdata.types import *
class UserSchema(Schema):
telephone = Str(length=11, required=True)
password = Str(min_length=8,max_length=16, required=True)
request_data = {
'telephone':'18180050000',
'password':'idonotknow'
}
schema = UserSchema(request_data)
if schema.valid:
print(schema.validated_data) # {'telephone': '18180050000', 'password': 'idonotknow'}
```
### Errors
```python
from xdata.schema import Schema
from xdata.types import *
class UserSchema(Schema):
telephone = Str(length=11, required=True)
password = Str(min_length=8, max_length=16, required=True)
request_data = {}
schema = UserSchema(request_data)
if not schema.valid:
print(schema.errors) # {'telephone': 'telephone is required', 'password': 'password is required'}
```
### DataTypes
```python
from xdata.schema import Schema
from xdata.types import *
DataType(required=True,default='11',choices=[])
Str(length=11, max_length=12,min_length=10,regex="")
Int(max=10000,min=12)
Bool(max=10000,min=12)
Decimal(left=5,right=2)
DateTime(max_datetime='2001-01-01 00:00:00', min_datetime='2000-01-01 00:00:00')
Date(max_date='2001-01-01', min_date='2000-01-01')
Time(max_time='06:00:00', min_time='05:00:00')
```
## Test
`coverage run --source=xdata -m pytest && coverage report`
## Todos
1. More DataTypes
2. More Check rules
## License
MIT