Programming by contract
Project description
Deal -- python library for design by contract (DbC) and checking values, exceptions, and side-effects. 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, 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 a pure function doesn't leave unexpected objects in the memory.
- DRY: test discovery, error messages generation.
- Partial execution: linter executes contracts to statically check possible values.
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)
# test case
@pytest.mark.parametrize('case', deal.cases(count))
def test_count(case: deal.TestCase):
case()
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.3.0.tar.gz
(87.2 kB
view details)
Built Distribution
deal-4.3.0-py3-none-any.whl
(128.7 kB
view details)
File details
Details for the file deal-4.3.0.tar.gz.
File metadata
- Download URL: deal-4.3.0.tar.gz
- Upload date:
- Size: 87.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: DepHell/0.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ce9b088ccc23d974fdc5abc6be1e227f442262f29e129e649fbb762413f49563 |
|
| MD5 | 83a11ec960de581db07dbc38044c164b |
|
| BLAKE2b-256 | ea1ca83120168d0023cd4671ea5b995100c76edf342c47af92500e7029d1d963 |
File details
Details for the file deal-4.3.0-py3-none-any.whl.
File metadata
- Download URL: deal-4.3.0-py3-none-any.whl
- Upload date:
- Size: 128.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: DepHell/0.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 229bd5cc35cc072d8edaf83431337edcccdf4cb6d876795ff9112d36e6d0de5b |
|
| MD5 | 398d8605e0905c91d28a09418847679d |
|
| BLAKE2b-256 | 668c3085ba867a400c372e04fffcde5ed6435ab043df0039f43ec55ee872a254 |
