thonny-crosshair

Automatically verify Python code using CrossHair in Thonny.


Keywords
design-by-contract, contracts, automatic, verification
License
AML
Install
pip install thonny-crosshair==0.0.1

Documentation

thonny-crosshair

Continuous Integration - Ubuntu

Continuous Integration - OSX

Continuous Integration - Windows

Test coverage

PyPI - version

PyPI - Python Version

Thonny-crosshair is a plug-in for Thonny IDE to automatically test Python code using CrossHair.

Installation

In Thonny

The plug-in can be easily installed via Thonny. Go to Tools menu and select Manage plug-ins...:

Tools -> Manage plug-ins...

TODO: screenshot Search for thonny-crosshair on PyPI and click on the link to install it:

Search on PyPI

With pip

In your virtual environment, invoke:

pip install --user thonny-crosshair

Usage

To check all the functions in the file with CrossHair, go to Tools menu and select Check the current file with CrossHair:

Tools -> Check

All changes to the file will be saved prior to executing the tests. If you prefer, you can undo them.

TODO: capture The check will be executed in the Thonny shell:

Shell running the tests

You can stop the check with the "Stop" sign:

Stop the checks

Sometimes it is practical to check only a single function (e.g., if it takes too long to check the whole file). In that case, move the caret to the body of the function that you would like to verify, go to Tools menu and select Check the function under the caret with CrossHair:

Tools -> Check at

TODO: capture Additionally, CrossHair can check your code while you type and immediately warn you of coding mistakes. To check the current file continuously, go to Tools menu and select Check the current file with CrossHair continuously:

Tools -> Watch

Contributing

Feature requests or bug reports are always very, very welcome!

Please see quickly if the issue does not already exist in the issue section and, if not, create a new issue.

You can also contribute in code. Please see contributing.rst.

Versioning

We follow a bit unusual semantic versioning schema:

  • X is the oldest supported version of CrossHair,
  • Y is the minor version (new or modified features), and
  • Z is the patch version (only bug fixes).