**Deal** is a Python library for [design by contract][wiki] (DbC) programming.
Project description
A Python library for 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 to get started.
Features
- Classic DbC: precondition, postcondition, invariant.
- Tracking exceptions and side-effects.
- Property-based testing.
- Static checker.
- Integration with pytest, flake8, sphinx, and hypothesis.
- Type annotations support.
- External validators support.
- Contracts for importing modules.
- Can be enabled or disabled on production.
- 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: 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: prove that your code works for all input (or find out when it doesn't).
- 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.
Deal in 30 seconds
# 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 lintorflake8to statically check errors. - Run
python3 -m deal testorpytestto generate and run tests. - Just use the function in the project and check errors in runtime.
Read more in the documentation.
Installation
python3 -m pip install --user deal
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.
Thank you :heart:
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
deal-4.19.1.tar.gz
(708.8 kB
view details)
Built Distribution
deal-4.19.1-py3-none-any.whl
(172.4 kB
view details)
File details
Details for the file deal-4.19.1.tar.gz.
File metadata
- Download URL: deal-4.19.1.tar.gz
- Upload date:
- Size: 708.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.25.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d62d959bd7cc1248b45bbf2d3e0b32a4e1f205994f030a84c75c524e7910f0cd |
|
| MD5 | d0fe6be6b010654a3b2864eaa160d41e |
|
| BLAKE2b-256 | 4cd56f2ba9ae4cf231567e181d3f35416c8b049ee537c77d2b2fc3cf85bc9a31 |
File details
Details for the file deal-4.19.1-py3-none-any.whl.
File metadata
- Download URL: deal-4.19.1-py3-none-any.whl
- Upload date:
- Size: 172.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.25.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 28efc7f377525c93d3dbd21b76e486030eb9490e672a56a0a63ddc590758fd2d |
|
| MD5 | 1af180d2d813b21dad1dfb02713c8c39 |
|
| BLAKE2b-256 | 55ca78500950e35b30260e7e2a2dcb22999964fa9bce25984209b95a5bc9bf2b |
