Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/life4/deal
🤝 Design by contract for Python. Write bug-free code. Add a few decorators, get static analysis and tests for free.
https://github.com/life4/deal
contracts contracts-programming dbc deal decorators design-by-contract flake8 functional-programming hacktoberfest interface invariant linter mypy property-based-testing python pythonic refinement-types testing typing validation
Last synced: about 2 months ago
JSON representation
🤝 Design by contract for Python. Write bug-free code. Add a few decorators, get static analysis and tests for free.
- Host: GitHub
- URL: https://github.com/life4/deal
- Owner: life4
- License: mit
- Created: 2018-01-25T06:38:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-24T19:46:00.000Z (6 months ago)
- Last Synced: 2024-05-23T08:32:50.337Z (4 months ago)
- Topics: contracts, contracts-programming, dbc, deal, decorators, design-by-contract, flake8, functional-programming, hacktoberfest, interface, invariant, linter, mypy, property-based-testing, python, pythonic, refinement-types, testing, typing, validation
- Language: Python
- Homepage: https://deal.readthedocs.io/
- Size: 1.91 MB
- Stars: 699
- Watchers: 13
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-testing - deal - Design by contract for Python with static checker and test generation. (Design by Contract)
README
# 
[](https://cloud.drone.io/life4/deal)
[](https://pypi.python.org/pypi/deal)
[](https://pypi.python.org/pypi/deal)
A Python library for [design by contract](https://en.wikipedia.org/wiki/Design_by_contract) (DbC) and checking values, exceptions, and side-effects. In a nutshell, deal empowers you to write bug-free code. By adding a few decorators to your code, you get for free tests, static analysis, formal verification, and much more. Read [intro](https://deal.readthedocs.io/basic/intro.html) to get started.
## Features
* [Classic DbC: precondition, postcondition, invariant.][values]
* [Tracking exceptions and side-effects.][exceptions]
* [Property-based testing.][tests]
* [Static checker.][linter]
* Integration with pytest, flake8, sphinx, and hypothesis.
* Type annotations support.
* [External validators support.][validators]
* [Contracts for importing modules.][module_load]
* [Can be enabled or disabled on production.][runtime]
* [Colorless][colorless]: annotate only what you want. Hence, easy integration into an existing project.
* Colorful: syntax highlighting for every piece of code in every command.
* [Memory leaks detection][leaks]: deal makes sure that pure functions don't leave unexpected objects in the memory.
* DRY: test discovery, error messages generation.
* Partial execution: linter executes contracts to statically check possible values.
* [Formal verification][verification]: prove that your code works for all input (or find out when it doesn't).
* Zero-dependency runtime: there are some dependencies for analysis tools, but nothing of it is required on the production.
* Fast: each code change is benchmarked and profiled.
* Reliable: the library has 100% test coverage, partially verified, and runs on production by multiple companies since 2018.
[values]: https://deal.readthedocs.io/basic/values.html
[exceptions]: https://deal.readthedocs.io/basic/exceptions.html
[tests]: https://deal.readthedocs.io/basic/tests.html
[linter]: https://deal.readthedocs.io/basic/linter.html
[validators]: https://deal.readthedocs.io/details/contracts.html#external-validators
[module_load]: https://deal.readthedocs.io/details/module_load.html
[runtime]: https://deal.readthedocs.io/basic/runtime.html
[colorless]: http://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function/
[leaks]: https://deal.readthedocs.io/basic/tests.html#memory-leaks
[verification]: https://deal.readthedocs.io/basic/verification.html
## Deal in 30 seconds
```python
# the result is always non-negative
@deal.post(lambda result: result >= 0)
# the function has no side-effects
@deal.pure
def count(items: List[str], item: str) -> int:
return items.count(item)
# generate test function
test_count = deal.cases(count)
```
Now we can:
* Run `python3 -m deal lint` or `flake8` to statically check errors.
* Run `python3 -m deal test` or `pytest` to generate and run tests.
* Just use the function in the project and check errors in runtime.
Read more in the [documentation](https://deal.readthedocs.io/).
## Installation
```bash
python3 -m pip install --user 'deal[all]'
```
## Contributing
Contributions are welcome! A few ideas what you can contribute:
* Add new checks for the linter.
* Improve documentation.
* Add more tests.
* Improve performance.
* Found a bug? Fix it!
* Made an article about deal? Great! Let's add it into the `README.md`.
* Don't have time to code? No worries! Just tell your friends and subscribers about the project. More users -> more contributors -> more cool features.
To run tests locally, all you need is [task](http://taskfile.dev/). Run `task all` to run all code formatters, linters, and tests.
Thank you :heart: