Programming by contract
Project description
Deal -- python library for design by contract (DbC) programming.
That's nice assert statements in decorators style to validate function input, output, available operations and object state. Goal is make testing much easier and detect errors in your code that occasionally was missed in tests.
Features
- Automatic property-based tests.
- Static analysis.
- Generators and async coroutines support.
- External validators support.
- Type-annotated and mypy-friendly.
- Specify allowed exceptions for function.
- Invariant for all actions with class instances.
- Decorators to control available resources: forbid output, network operations, raising exceptions.
- You can disable contracts on production.
Available decorators
CLassic DbC:
- deal.pre -- validate function arguments (pre-condition)
- deal.post -- validate function return value (post-condition)
- deal.ensure -- post-condition that accepts not only result, but also function arguments.
- deal.inv -- validate object internal state (invariant).
Take more control:
- deal.module_load -- check contracts at module initialization.
- deal.offline -- forbid network requests
- deal.raises -- allow only list of exceptions
- deal.reason -- check function arguments that caused a given exception.
- deal.silent -- forbid output into stderr/stdout.
Helpers:
- deal.chain -- chain a few contracts in one.
- deal.pure -- forbid side-effects and combine
safe,silent, andoffline. - deal.safe -- forbid exceptions.
Installation
python3 -m pip install --user deal
Quick Start
import re
import attr
import deal
REX_LOGIN = re.compile(r'^[a-zA-Z][a-zA-Z0-9]+$')
class PostAlreadyLiked(Exception):
pass
@deal.inv(lambda post: post.visits >= 0)
class Post:
visits: int = attr.ib(default=0)
likes: set = attr.ib(factory=set)
@deal.pre(lambda user: REX_LOGIN.match(user), message='invalid username format')
@deal.raises(PostAlreadyLiked)
@deal.chain(deal.offline, deal.silent)
def like(self, user: str) -> None:
if user in self.likes:
raise PostAlreadyLiked
self.likes.add(user)
@deal.post(lambda result: 'visits' in result)
@deal.post(lambda result: 'likes' in result)
@deal.post(lambda result: result['likes'] > 0)
@deal.pure
def get_state(self):
return dict(visits=self.visits, likes=len(self.likes))
Now, Deal controls conditions and states of the object at runtime:
@deal.invcontrols that visits count in post always non-negative.@deal.prechecks user name format. We assume that it should be validated somewhere before by some nice forms with user-friendly error messages. So, if we have invalid login passed here, it's definitely developer's mistake.@deal.raisessays that only possible exception that can be raised isPostAlreadyLiked.@deal.chain(deal.offline, deal.silent)controls that function has no network requests and has no output in stderr or stdout. So, if we are making unexpected network requests somewhere inside, deal let us know about it.deal.postchecks result format forget_state. So, all external code can be sure that fieldslikesandvisitsalways represented in the result and likes always positive.
If code violates some condition, sub-exception of deal.ContractError will be raised:
p = Post()
p.visits = -1
# InvContractError:
Dive deeper on deal.readthedocs.io.
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-3.8.0.tar.gz
(38.4 kB
view details)
Built Distribution
deal-3.8.0-py3-none-any.whl
(78.3 kB
view details)
File details
Details for the file deal-3.8.0.tar.gz.
File metadata
- Download URL: deal-3.8.0.tar.gz
- Upload date:
- Size: 38.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: DepHell/0.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 86c2a0212ff4ad8857d500b6f4ba1b9cabdc22e4dc45a5a3925524ffd2ce1d4c |
|
| MD5 | b67f27fee5c72047441bb26f9a526b09 |
|
| BLAKE2b-256 | 23b5d57db49507f22a1ad63aa56cc77c7df36dd7cfdb82e2545d877bd1402bc8 |
File details
Details for the file deal-3.8.0-py3-none-any.whl.
File metadata
- Download URL: deal-3.8.0-py3-none-any.whl
- Upload date:
- Size: 78.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: DepHell/0.8.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ac71448c43fe7cbf48a003d4702f04bfbfd7accbc80ce8209fed05555bd8c77f |
|
| MD5 | 515773f7d5f789cf7d9978bef01250e2 |
|
| BLAKE2b-256 | dcde0d1dda0117da0860a50e497c97c24bbf401b0fb7dd1bd1e4bba497c0e40b |
