Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paxosglobal/dsert
Library to test all fields of a python dictionary
https://github.com/paxosglobal/dsert
Last synced: 2 months ago
JSON representation
Library to test all fields of a python dictionary
- Host: GitHub
- URL: https://github.com/paxosglobal/dsert
- Owner: paxosglobal
- License: mit
- Created: 2017-01-11T19:36:07.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-28T19:04:12.000Z (almost 7 years ago)
- Last Synced: 2024-05-19T07:28:09.580Z (8 months ago)
- Language: Python
- Size: 15.6 KB
- Stars: 12
- Watchers: 26
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - dsert - Library to test all fields of a python dictionary (Python)
README
# dsert
[](https://travis-ci.org/paxos-bankchain/dsert)
Library to explicitly test *all* the fields of a python dictionary, even when you don't know all of their values.
## Install
From [PyPi](https://pypi.python.org/pypi/dsert/):
```bash
$ pip install dsert
```
From [GitHub](https://github.com/paxos-bankchain/dsert/):
```bash
$ pip install git+https://github.com/paxos-bankchain/dsert.git
```
## Examples
```python
>>> from dsert import assert_valid_dict
>>> my_dict = {'balance': 123.45, 'status': 'homeowner', 'good_credit': True}
```
Check all the fields (will return `None`):
```python
>>> assert_valid_dict(my_dict, known_contents={'balance': 123.45}, known_types={'status': str, 'good_credit': bool})
>>>
```
Check some of the fields (will raise an `Exception` with helpful debug instructions):
```python
>>> assert_valid_dict(my_dict, known_contents={'balance': 123.45})
Traceback (most recent call last):
File "", line 1, in
File "dsert/__init__.py", line 35, in assert_valid_dict
raise KeyError(err_msg)
KeyError: "Keys for {'good_credit': True, 'status': 'homeowner'} not in known_contents keys (['balance']), known_types keys ([]), nor excluded_fields ([])."
```
## Why
Most tests are opt-in, where we test certain keys/values only:
```python
>>> self.assertEqual(some_dict['a'], 1)
```
This can work well, but it can also cause situations where the tests pass and yet a bug has slipped in!
From [The Zen of Python](https://www.python.org/dev/peps/pep-0020/)
> Explicit is better than implicit.
## Coming Soon
More complex validators. Don't just test that a dictionary value is of type `int`, test that it's a positive/even/prime `int`.
## Contributing
Check out repo:
```bash
$ git checkout git+https://github.com/paxos-bankchain/dsert.git && cd dsert
```
Install locally
```bash
$ pip install --editable .
```
Confirm tests pass:
```
$ nosetests .
```
(this requires having [nose](http://nose.readthedocs.io/en/latest/) installed)
Make your changes and confirm that tests still pass:
```
$ nosetests .
```
## Updating PyPi
You must have the credentials in order to push updates to [PyPi](https://pypi.python.org/pypi).
Create a `.pypirc` file in your home directory:
```
$ cat ~/.pypirc
[distutils]
index-servers=
pypi
[pypi]
repository = https://pypi.python.org/pypi
username = paxos
password =
```
Install twine:
```
$ pip install twine
```
Create a distribution:
```
$ python setup.py sdist bdist_wheel
```
Push your distribution to PyPi:
```
$ twine upload dist/* -r pypi
```
To test this process, you can use [PyPi's test server](https://testpypi.python.org/). Add an entry to `.pypirc` that looks like this with whatever creds you create for testpypi:
```
[testpypi]
repository = https://testpypi.python.org/pypi
username =
password =
```
Then use the following command to push your distrobution to test PyPi:
```
$ twine upload dist/* -r testpypi
```