Pyjoyment.Validator - Validate values¶
from Pyjoyment.Validator import Validator
validator = Validator()
v = validator.validation()
v.input = {'foo': 'bar'}
v.required('foo').like(re.compile(r'ar$'))
print(v.param('foo'))
# Or import the module, as in Google Python Style Guide
import Pyjoyment.Validator
validator = Pyjoyment.Validator.new()
v = validator.validation()
v.input = {'foo': 'bar'}
v.required('foo').like(re.compile(r'ar$'))
print(v.param('foo'))
Pyjoyment.Validator validates values for Pyjoyment.
Checks¶
These validation checks are available by default.
equal_to
v = v.equal_to('foo')
String value needs to be equal to the value of another field.
in
v = v.one_of('foo', 'bar', 'baz')
String value needs to match one of the values in the list. in is a
keyword of Python, so the method of the check is one_of, and in_ is
its alias.
like
v = v.like(re.compile(r'^[A-Z]'))
String value needs to match the regular expression.
num
v = v.num()
v = v.num(2, 5)
v = v.num(-3, 7)
v = v.num(2, None)
v = v.num(None, 5)
String value needs to be a non-fractional number (positive or negative) and if provided in the given range.
size
v = v.size(2, 5)
v = v.size(2, None)
v = v.size(None, 5)
String value length or size of Pyjo.Upload object in bytes needs to be
between these two values.
upload
v = v.upload()
Value needs to be a Pyjo.Upload object, representing a file upload.
Filters¶
These filters are available by default.
comma_separated
v = v.optional('foo', 'comma_separated')
Split string of comma separated values into separate values.
not_empty
v = v.optional('foo', 'not_empty')
Remove empty string values and treat them as if they had not been submitted.
trim
v = v.optional('foo', 'trim')
Trim whitespace characters from both ends of string value with
Pyjo.Util.trim().
See also¶
Pyjoyment, https://mojolicious.org.
Ported from Mojolicious::Validator of Mojolicious 9.49.
Classes¶
- class Pyjoyment.Validator.Pyjoyment_Validator[source]¶
Pyjoyment.Validatorinherits all methods fromPyjo.Baseand implements the following new ones.- add_check(name: str, cb: None = None) Callable[[F], F][source]¶
- add_check(name: str, cb: Check) Self
validator = validator.add_check('size', lambda v, name, value, *args: ...) @validator.add_check('size') def size(v, name, value, *args): ...
Register a validation check.
@validator.add_check('foo') def foo(v, name, value, *args): ... return None
- add_filter(name: str, cb: None = None) Callable[[F], F][source]¶
- add_filter(name: str, cb: Filter) Self
validator = validator.add_filter('trim', lambda v, name, value: ...) @validator.add_filter('trim') def trim(v, name, value): ...
Register a new filter.
@validator.add_filter('foo') def foo(v, name, value): ... return value
- checks: dict[str, Check]¶
checks = validator.checks validator.checks = {'size': lambda v, name, value, *args: ...}
Registered validation checks, by default only
equal_to,in,like,num,sizeanduploadare already defined.
- filters: dict[str, Filter]¶
filters = validator.filters validator.filters = {'trim': lambda v, name, value: ...}
Registered filters, by default only
comma_separated,not_emptyandtrimare already defined.
- validation() Pyjoyment_Validator_Validation[source]¶
v = validator.validation()
Build
Pyjoyment.Validator.Validationobject to perform validations.v = validator.validation() v.input = {'foo': 'bar'} v.required('foo').size(1, 5) print(v.param('foo'))