Provide design-by-contract with informative violation messages
Project description
icontract
icontract provides design-by-contract to Python3 with informative violation messages.
There exist a couple of contract libraries. However, at the time of this writing (July 2018), they all required the programmer either to learn a new syntax (PyContracts) or to write redundant condition descriptions ( e.g., contracts, covenant, dpcontracts, pyadbc and pcd).
This library was strongly inspired by them, but we go a step further and use the meta programming library to infer violation messages from the code in order to promote dont-repeat-yourself principle (DRY) and spare the programmer the tedious task of repeating the message that was already written in code.
We want this library to be used mainly in production code and let us spot both development and production bugs with enough information. Therefore, we decided to implement only the pre-conditions and post-conditions which require little overhead, and left out intentionally the class invariants. Class invariants seem to us tricky to grasp ( for example, depending on the design class invariants may hold only at the first call of the public function, but not in the private functions; or they may hold only at the first call to a method of a class, but not in the sequent calls to other class methods etc.). The invariants hence need to come with an overhead which is generally impractical for production systems.
Usage
icontract provides two decorators, pre and post for pre-conditions and post-conditions, respectively.
The condition argument specifies the contract and is usually written in lambda notation. In post-conditions, condition function receives a reserved parameter result corresponding to the result of the function. The condition can take as input a subset of arguments required by the wrapped function. This allows for very succinct conditions.
You can provide an optional description by passing in description argument.
Whenever a violation occurs, ViolationError is raised. Its message includes:
the human-readable representation of the condition,
description (if supplied) and
representation of all the arguments.
You can provide a custom representation function with the argument repr_args that needs to cover all the input arguments (including result in post-conditions) of the condition function and return a string. If no representation function was specified, the input arguments are represented by concatenation of __repr__ on each one of them.
>>> import icontract
>>> @icontract.pre(lambda x: x > 3)
... def some_func(x: int, y: int = 5)->None:
... pass
...
>>> some_func(x=5)
# Pre-condition violation
>>> some_func(x=1)
Traceback (most recent call last):
...
icontract.ViolationError: Precondition violated: x > 3: x was 1
# Pre-condition violation with a description
>>> @icontract.pre(lambda x: x > 3, "x must not be small")
... def some_func(x: int, y: int = 5) -> None:
... pass
...
>>> some_func(x=1)
Traceback (most recent call last):
...
icontract.ViolationError: Precondition violated: x must not be small: x > 3: x was 1
# Pre-condition violation with a custom representation function
>>> @icontract.pre(lambda x: x > 3, repr_args=lambda x: "x was {:03}".format(x))
... def some_func(x: int, y: int = 5) -> None:
... pass
...
>>> some_func(x=1)
Traceback (most recent call last):
...
icontract.ViolationError: Precondition violated: x > 3: x was 001
# Post-condition
>>> @icontract.post(lambda result, x: result > x)
... def some_func(x: int, y: int = 5) -> int:
... return x - y
...
>>> some_func(x=10)
Traceback (most recent call last):
...
icontract.ViolationError: Post-condition violated: result > x: result was 5: x was 10Installation
Install icontract with pip:
pip3 install icontractDevelopment
Check out the repository.
In the repository root, create the virtual environment:
python3 -m venv venv3Activate the virtual environment:
source venv3/bin/activateInstall the development dependencies:
pip3 install -e .[dev]We use tox for testing and packaging the distribution. Run:
toxWe also provide a set of pre-commit checks that lint and check code for formatting. Run them locally from an activated virtual environment with development dependencies:
./precommit.pyThe pre-commit script can also automatically format the code:
./precommit.py --overwriteVersioning
We follow Semantic Versioning. The version X.Y.Z indicates:
X is the major version (backward-incompatible),
Y is the minor version (backward-compatible), and
Z is the patch version (backward-compatible bug fix).
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
File details
Details for the file icontract-1.0.1.tar.gz.
File metadata
- Download URL: icontract-1.0.1.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/20.10.1 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.5.2+
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2d828062819ee039214ce681a1cce24b70311fda696c5f1109011c1f40fd0459 |
|
| MD5 | fe81555dfd21d4cad6c940ebc0aa6ab3 |
|
| BLAKE2b-256 | 42684920a167126004a2189a70f9d6639a1fd446cd682adbb0793dd757a787fe |
