PyValitron
PyValitron is a light-weight python inputs validation library.
Installation
To install PyValitron run this command:
pip3 install pyvalitron
Usage
After installing the library, Read the following usage criteria:
Validate Values:
To validate a list of values:
from pyvalitron.form import Form
form = Form({
'test_field1': {
'value': 'Hello World',
'validate': {
'length_between': {
'param': [1, 12],
'error': 'Input lenght must be between 1 and 12 characters'
}
}
},
'test_field2': {
'value': 'Hello World',
'validate': {
'length_between': {
'param': [1, 9],
'error': 'Input lenght must be between 1 and 9 characters'
}
}
}
})
form.process()
errors = form.get_errors()
print(errors['test_field2']) # Input lenght must be between 1 and 9 characters
Sanitize Values:
To sanitize a list of values:
from __future__ import print_function
from pyvalitron.form import Form
form = Form({
'test_field': {
'value': 'Hello& W"or"ld<br>.',
'sanitize': {
'escape': {}
}
}
})
form.process()
inputs = form.get_inputs()
print(inputs['test_field']) # {'is_exact': False, 'svalue': 'Hello& W"or"ld<br>.', 'sanitize': {'escape': {}}, 'value': 'Hello& W"or"ld<br>.'}
print(inputs['test_field']['is_exact']) # False
print(inputs['test_field']['svalue']) # Hello& W"or"ld<br>.
print(inputs['test_field']['value']) # Hello& W"or"ld<br>.
from __future__ import print_function
from pyvalitron.form import Form
form = Form({
'test_field': {
'value': 'Hello World.',
'sanitize': {
'escape': {}
}
}
})
form.process()
inputs = form.get_inputs()
print(inputs['test_field']) # {'is_exact': True, 'svalue': 'Hello World.', 'sanitize': {'escape': {}}, 'value': 'Hello World.'}
print(inputs['test_field']['is_exact']) # True
print(inputs['test_field']['svalue']) # Hello World.
print(inputs['test_field']['value']) # Hello World.
Validate & Sanitize Values:
To validate and sanitize a list of values:
from __future__ import print_function
from pyvalitron.form import Form
form = Form({
'test_field': {
'value': 'hello@clivern.com',
'sanitize': {
'escape': {}
},
'validate': {
'email': {
'error': 'Please provide a valid email.'
}
}
}
})
form.process()
inputs = form.get_inputs()
errors = form.get_errors()
print(errors) # {'test_field': []}
print(errors['test_field']) # []
print(inputs['test_field']) # {'status': True, 'is_exact': True, 'value': 'hello@clivern.com', 'sanitize': {'escape': {}}, 'svalue': 'hello@clivern.com', 'validate': {'email': {'error': 'Please provide a valid email.'}}}
print(inputs['test_field']['status']) # True
print(inputs['test_field']['is_exact']) # True
print(inputs['test_field']['value']) # hello@clivern.com
print(inputs['test_field']['svalue']) # hello@clivern.com
from __future__ import print_function
from pyvalitron.form import Form
form = Form({
'test_field': {
'value': 'hello@cliv@ern.com',
'sanitize': {
'escape': {}
},
'validate': {
'email': {
'error': 'Please provide a valid email.'
}
}
}
})
form.process()
inputs = form.get_inputs()
errors = form.get_errors()
print(errors) # {'test_field': ['Please provide a valid email.']}
print(errors['test_field']) # ['Please provide a valid email.']
print(inputs['test_field']) # {'status': False, 'is_exact': True, 'value': 'hello@cliv@ern.com', 'sanitize': {'escape': {}}, 'svalue': 'hello@cliv@ern.com', 'validate': {'email': {'error': 'Please provide a valid email.'}}}
print(inputs['test_field']['status']) # False
print(inputs['test_field']['is_exact']) # True
print(inputs['test_field']['value']) # hello@cliv@ern.com
print(inputs['test_field']['svalue']) # hello@cliv@ern.com
Using With Frameworks:
Flask Framework
from flask import Flask
from flask import request
from pyvalitron.form import Form
app = Flask(__name__)
@app.route("/")
def hello():
form = Form({
'test_field1': {
'value': request.args.get('test_field1'),
'validate': {
'length_between': {
'param': [1, 12],
'error': 'Input lenght must be between 1 and 12 characters'
}
}
},
'test_field2': {
'value': request.args.get('test_field2'),
'validate': {
'length_between': {
'param': [1, 9],
'error': 'Input lenght must be between 1 and 9 characters'
}
}
}
}, 'values')
form.process()
errors = form.get_errors()
if 'Input lenght must be between 1 and 9 characters' in errors['test_field2']:
return 'error'
else:
return 'success'
if __name__ == "__main__":
app.run(debug=True)
Validators List:
Here is a list of all available validators:
empty: Validate if input or a value is empty.not_empty: Validate if input or a value is not empty.length_between: Validate if input or a value length is between provided lengths. It requires two parameters[from_length, to_length]like[1, 13].min_length: Validate if input or a value min lenght is like provided one. It requires one parameter[min_length]like[1].max_length: Validate if input or a value max lenght is like provided one. It requires one parameter[max_length]like[12].exact_length: Validate if input or a value lenght is equal to provided one. It requires one parameter[exact_length]like[9].greater_than: Validate if input or a value is greater than provided one. It requires one parameter[number]like[5].greater_than_equal: Validate if input or a value is greater than or equal provided one. It requires one parameter[number]like[4].less_than: Validate if input or a value is less than provided one. It requires one parameter[number]like[5].less_than_equal: Validate if input or a value is less than or equal provided one. It requires one parameter[number]like[5].equal: Validate if input or a value is equal to provided one. It requires one parameter[number]like[5].same_as: Validate if input or a value is same as provided one. It requires one parameter[text]like['Hello World']any_of: Validate if input or a value is any of the provided list. It requires one parameter[[options]]like[1,5,'text'].all_of: Validate if input or a value is all of the provided list. It requires one parameter[[options]]like[1,5,'text'].none_of: Validate if input or a value is none of the provided list. It requires one parameter[[options]]like[1,5,'text'].alpha: Validate if input or a value is alphabetical.alpha_numeric: Validate if input or a value is alphanumeric.digit: Validate if input or a value is digits.email: Validate if input or a value is email.emails: Validate if input or a value is a list of emails. It requires one parameter[separator]like[','].url: Validate if input or a value is a URL. It requires one parameter (a list of protocols)[[protocols]]like[['http', 'https']].ip: Validate if input or a value is IP. It requires one parameter (a list of formats)[[formats]]like['ipv4']ipv4: Validate if input or a value is IPv4.uuid: Validate if input or a value is universally unique identifier (UUID)matches: Validate if input or a value matches provided regex. It requires one parameter[regex]like[r'^[_a-z0-9-]+$'].
Sanitizers List
Here is a list of all available sanitizers:
strip: Strip the input value. It accepts one parameter[[chars]]like[[',', '.', '\s']].lstrip: Left strip the input value. It accepts one parameter[[chars]]like[[',', '.', '\s']].rstrip: Right strip the input value. It accepts one parameter[[chars]]like[[',', '.', '\s']].escape: Escape the input value to prevent evil scripts. It accepts one parameter (a list of chars to escape). currently it support these characters['&', '"', '\'', '>', '<'].
Custom Validators
To define a new validator:
from pyvalitron.validator import Validator
from pyvalitron.form import Form
class MyValidator(Validator):
def username(self):
if not isinstance(self._input, (str)):
return False
current_input = self._input.strip()
if len(current_input) > 5 and current_input.isalpha():
return True
return False
def otherrule(self):
return True
#...and so one
form = Form()
form.add_validator(MyValidator())
form.add_inputs({
'user_name': {
'value': '',
'validate': {
'username': {
'error': 'Invalid Username'
}
}
}
})
form.process()
errors = form.get_errors() #{'user_name': ['Invalid Username']}
Custom Sanitizers
To define a new sanitizer:
from __future__ import print_function
from pyvalitron.sanitizer import Sanitizer
from pyvalitron.form import Form
class MySanitizer(Sanitizer):
def clear_spaces(self):
if not isinstance(self._input, (str)):
self._sinput = str(self._input)
else:
self._sinput = self._input
self._sinput = self._sinput.replace(" ", "")
return self._sinput
def lower_case(self):
if not isinstance(self._input, (str)):
self._sinput = str(self._input)
else:
self._sinput = self._input
self._sinput = self._sinput.lower()
return self._sinput
form = Form({
'test_field': {
'value': 'Hello World',
'sanitize': {
'clear_spaces':{},
'lower_case': {}
}
}
}, 'values')
form.add_sanitizer(MySanitizer())
form.process()
inputs = form.get_inputs()
print(inputs['test_field']['svalue']) #helloworld
Misc
Changelog
Version 1.1.3:
Fix issue with validation extensions.
Version 1.1.2:
Fix import issues.
Version 1.1.1:
New Validation Rules.
Add python lint check.
Version 1.0.0:
Initial Release.
Acknowledgements
© 2019, Silverback. Released under MIT License.
PyValitron is authored and maintained by @silverbackhq.
Metadata
Release files for pyvalitron 1.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyvalitron-1.1.3.tar.gz | 9.2 kB | Without provenance | Details for pyvalitron-1.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyvalitron-1.1.3-py3-none-any.whl | Python 3 | none | any | Details for pyvalitron-1.1.3-py3-none-any.whl |
Total release size: 17.6 kB
Release files / pyvalitron-1.1.3.tar.gz
| Download URL | pyvalitron-1.1.3.tar.gz |
|---|---|
| Size | 9.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
66d0cfdfd05c4db365e4afd02be6046b1bc1f1d24b4fbd3c7bfb67cb96c71674
|
|
BLAKE2b-256 checksum How to use checksums |
b65a6cfa08da7dc86bd6e22fe8a02f342050f856f5c34e592cde6b1909839ee2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.5
|
Release files / pyvalitron-1.1.3-py3-none-any.whl
| Download URL | pyvalitron-1.1.3-py3-none-any.whl |
|---|---|
| Size | 8.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4d3005f929aba51203b841a610054cdf1e3dfc5cc1cafd806e1cf1bcb2f7b2a1
|
|
BLAKE2b-256 checksum How to use checksums |
2a00c71922192246ae57567386e37636102b5b8dae81898c7c3ca2080588d6f1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/3.6.5
|
Security for pyvalitron 1.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.