Skip to main content

Validation and parsing library

Project description

Build status Gitter Downloads Downloads

Ultimate transformation library that supports validation, contexts and aiohttp.

Trafaret is rigid and powerful lib to work with foreign data, configs etc. It provides simple way to check anything, and convert it accordingly to your needs.

It have shortcut syntax and ability to express anything that you can code:

>>> from trafaret.constructor import construct
>>> validator = construct({'a': int, 'b': [str]})
>>> validator({'a': 5, 'b': ['lorem', 'ipsum']})
{'a': 5, 'b': ['lorem', 'ipsum']}

>>> validator({'a': 5, 'b': ['gorky', 9]})
Traceback (most recent call last):
  File "<console>", line 1, in <module>
  File "/Users/mkrivushin/w/trafaret/trafaret/__init__.py", line 204, in __call__
    return self.check(val)
  File "/Users/mkrivushin/w/trafaret/trafaret/__init__.py", line 144, in check
    return self._convert(self.check_and_return(value))
  File "/Users/mkrivushin/w/trafaret/trafaret/__init__.py", line 1105, in check_and_return
    raise DataError(error=errors, trafaret=self)
trafaret.DataError: {'b': DataError({1: DataError(value is not a string)})}

Read The Docs hosted documentation http://trafaret.readthedocs.org/en/latest/ or look to the docs/intro.rst for start.

Trafaret can even generate Trafarets instances to build transformators from json, like in json schema implementation Trafaret Schema

New

  • converters and convert=False are deleted in favor of And and &

  • String parameter regex deleted in favor of Regexp and RegexpRaw usage

  • new OnError to customize error message

  • context=something argument for __call__ and check Trafaret methods. Supported by Or, And, Forward etc.

  • new customizable method transform like change_and_return but takes context= arg

  • new trafaret_instance.async_check method that works with await

Doc

For simple example what can be done:

import datetime
import trafaret as t

date = t.Dict(year=t.Int, month=t.Int, day=t.Int) >> (lambda d: datetime.datetime(**d))
assert date.check({'year': 2012, 'month': 1, 'day': 12}) == datetime.datetime(2012, 1, 12)

Work with regex:

>>> c = t.RegexpRaw(r'^name=(\w+)$') >> (lambda m: m.group(1))
>>> c.check('name=Jeff')
'Jeff'

Rename dict keys:

>>> c = t.Dict(t.Key('uNJ') >> 'user_name': t.String})
>>> c.check({'uNJ': 'Adam'})
{'user_name': 'Adam'}

Arrow date checking:

import arrow

def check_datetime(str):
    try:
        return arrow.get(str).naive
    except arrow.parser.ParserError:
        return t.DataError('value is not in proper date/time format')

Yes, you can write trafarets that simple.

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

trafaret-1.1.2.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

trafaret-1.1.2-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

Details for the file trafaret-1.1.2.tar.gz.

File metadata

  • Download URL: trafaret-1.1.2.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for trafaret-1.1.2.tar.gz
Algorithm Hash digest
SHA256 766593f9a1c327f8e1398267c95c89fa44058280eaef836156a854c4cc1d6a39
MD5 81747a61bbdaf02ba99521296bd851f5
BLAKE2b-256 42443e5edb6784a339cb93cc571ef41e4e91a3465d7a4b948924a8e4edeb9126

See more details on using hashes here.

File details

Details for the file trafaret-1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for trafaret-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 deccca0830732952ebc71000a11b1cfe65bdc0d874705ef4f69bbcb1090c8657
MD5 058dd7e69c54f4e98334c1272375e075
BLAKE2b-256 c400e7870d3548c9bdbf017a108161d08d5c2f933e64573463cde7db7696bf19

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