Validation and parsing library
Project description
Trafaret
========
-----
|circleci_build| |gitter_chat| |pypi_version| |pypi_license|
-----
Read The Docs hosted documentation <http://trafaret.readthedocs.org/en/latest/>
or look to the docs/api/intro.rst for start.
New
---
* converters and ``convert=False`` are deleted in favor of ``And`` and ``&``
* 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
---
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:
.. code-block:: python
>>> 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)})}
For simple example what can be done:
.. code-block:: python
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:
.. code-block:: python
>>> c = t.String(regex=r'^name=(\w+)$') >> (lambda m: m.groups()[0])
>>> c.check('name=Jeff')
'Jeff'
Rename dict keys:
.. code-block:: python
>>> c = t.Dict(t.Key('uNJ') >> 'user_name': t.String})
>>> c.check({'uNJ': 'Adam'})
{'user_name': 'Adam'}
``Arrow`` date checking:
.. code-block:: python
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.
Related projects
----------------
`Trafaret Config <https://github.com/tailhook/trafaret-config>`_
`Trafaret Validator <https://github.com/Lex0ne/trafaret_validator>`_
.. |circleci_build| image:: https://circleci.com/gh/Deepwalker/trafaret.svg?style=shield
:target: https://circleci.com/gh/Deepwalker/trafaret
:alt: Build status
.. |gitter_chat| image:: https://badges.gitter.im/Deepwalker/trafaret.png
:target: https://gitter.im/Deepwalker/trafaret
:alt: Gitter
.. |pypi_version| image:: https://img.shields.io/pypi/v/trafaret.svg?style=flat-square
:target: https://pypi-hypernode.com/pypi/trafaret
:alt: Downloads
.. |pypi_license| image:: https://img.shields.io/pypi/l/trafaret.svg?style=flat-square
:target: https://pypi-hypernode.com/pypi/trafaret
:alt: Downloads
========
-----
|circleci_build| |gitter_chat| |pypi_version| |pypi_license|
-----
Read The Docs hosted documentation <http://trafaret.readthedocs.org/en/latest/>
or look to the docs/api/intro.rst for start.
New
---
* converters and ``convert=False`` are deleted in favor of ``And`` and ``&``
* 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
---
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:
.. code-block:: python
>>> 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)})}
For simple example what can be done:
.. code-block:: python
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:
.. code-block:: python
>>> c = t.String(regex=r'^name=(\w+)$') >> (lambda m: m.groups()[0])
>>> c.check('name=Jeff')
'Jeff'
Rename dict keys:
.. code-block:: python
>>> c = t.Dict(t.Key('uNJ') >> 'user_name': t.String})
>>> c.check({'uNJ': 'Adam'})
{'user_name': 'Adam'}
``Arrow`` date checking:
.. code-block:: python
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.
Related projects
----------------
`Trafaret Config <https://github.com/tailhook/trafaret-config>`_
`Trafaret Validator <https://github.com/Lex0ne/trafaret_validator>`_
.. |circleci_build| image:: https://circleci.com/gh/Deepwalker/trafaret.svg?style=shield
:target: https://circleci.com/gh/Deepwalker/trafaret
:alt: Build status
.. |gitter_chat| image:: https://badges.gitter.im/Deepwalker/trafaret.png
:target: https://gitter.im/Deepwalker/trafaret
:alt: Gitter
.. |pypi_version| image:: https://img.shields.io/pypi/v/trafaret.svg?style=flat-square
:target: https://pypi-hypernode.com/pypi/trafaret
:alt: Downloads
.. |pypi_license| image:: https://img.shields.io/pypi/l/trafaret.svg?style=flat-square
:target: https://pypi-hypernode.com/pypi/trafaret
:alt: Downloads
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-0.11.dev1.tar.gz
(21.1 kB
view details)
Built Distribution
File details
Details for the file trafaret-0.11.dev1.tar.gz.
File metadata
- Download URL: trafaret-0.11.dev1.tar.gz
- Upload date:
- Size: 21.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9f0bc4a1e83935c7134ea0a570f117b45ea72f29515a9696da27b971feed5ad3 |
|
| MD5 | e36ec281aaae9c0c67aafbc0d50a947a |
|
| BLAKE2b-256 | 2d8bdd115cb1c572dd70eb9d8f8d6c6e5be914b6a4e3e08331d4a8c6f99e0dae |
File details
Details for the file trafaret-0.11.dev1-py3-none-any.whl.
File metadata
- Download URL: trafaret-0.11.dev1-py3-none-any.whl
- Upload date:
- Size: 25.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 83aa5f977ed1a9d4f04e4e5b1fe06abd9efdc07c8c1f235865b562f1e543ef21 |
|
| MD5 | 1e7acd873a6d0ed972bde76f9240d594 |
|
| BLAKE2b-256 | c303c035ac9e175cc2156578c83a976d30095fe6ab8f23eb2ff24bc7503f5bb4 |
