Skip to main content

validation library

Project description

Procrustes is a validation library, suitable for validating user input data, i.e. web forms or API calls. With procrustes you can validate any structure.

For doing this procrustes has three container classes - Tuple, List and Dict. Tuple come from FP, has fixed count of elements with fixed types. List can include any amount of values of one type. And Dict is a dict.

Procrustes consist of validators and forms. You can use validators without forms functionality. Forms adds mainly widgets and form data parsing.

Validators

Most simple what you can to do with procrustes is build validator and use it:

>>> from procrustes import validators as v
>>> two_strings_v = v.Tuple(v.String(), v.String())
>>> auth = two_strings_v(['login', 'password'])
>>> auth.data
('login', 'password')
>>> auth.errors
[]
>>> auth = two_strings_v(['login'])
>>> auth.data
>>> auth.errors
['Must be iterable of length 2']

We have very powerful List:

>>> list_of_pairs_v = v.List(two_strings_v)
>>> pairs = list_of_pairs_v([(str(x), str(x)) for x in xrange(10)])
>>> pairs.data
[('0', '0'), ('1', '1'), ('2', '2'), ('3', '3'), ('4', '4'), ('5', '5'), ('6', '6'), ('7', '7'), ('8', '8'), ('9', '9')]
>>> pairs.errors
[]

List, Tuple and Dict are recursive, so you can build any data structure you want.

Dict example:

>>> dict_v = v.Dict({'pair': two_strings_v, 'pairs': list_of_pairs_v})
>>> data = dict_v({'pair': ['a', 'b'], 'pairs': [['a', 'b'], ['c', 'd']]})
>>> data.data
{'pair': ('a', 'b'), 'pairs': [('a', 'b'), ('c', 'd')]}
>>> data.errors
[]

Validators have required keyword argument:

>>> two_strings_v = v.Tuple(v.String(), v.String(), required=False)
>>> dict_v = v.Dict({'pair': two_strings_v, 'pairs': list_of_pairs_v})
>>> data = dict_v({'pairs': [['a', 'b'], ['c', 'd']]})
>>> data.data
{'pair': None, 'pairs': [('a', 'b'), ('c', 'd')]}
>>> data.errors
[]

Flat

Procrustes can flat data:

>>> list(data.flatten())
[('pairs__0__0', 'a'), ('pairs__0__1', 'b'), ('pairs__1__0', 'c'), ('pairs__1__1', 'd')]

And unflat it back:

>>> dict_v.deepen(dict([('pairs__0__0', 'a'), ('pairs__0__1', 'b'), ('pairs__1__0', 'c'), ('pairs__1__1', 'd')]))
{'pair': (None, None), 'pairs': [('c', 'd'), ('a', 'b')]}

Forms

Forms derived from validators and implemented as mixins to them. Every Field can work as form. Your form may consist from one forms.String(). In addition to validators forms adds methods widgets, template_widgets, unflat and is_valid.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

procrustes-0.2.0.tar.gz (6.0 kB view details)

Uploaded Source

File details

Details for the file procrustes-0.2.0.tar.gz.

File metadata

  • Download URL: procrustes-0.2.0.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for procrustes-0.2.0.tar.gz
Algorithm Hash digest
SHA256 69ae1ec160cb22a71e96eca509faddb4ec927ce9320412d0947bbd96b0519a9c
MD5 953a3b1c99d9af8f50096309516e7d44
BLAKE2b-256 d5cdfcf8f9dd5ea1adb57afefdd2bbe5288d6150489b7e517b592dc902682d63

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page