<img src="doc/source/logo-gray.png" width="5%" align="left">

CrossHair

An analysis tool for Python that blurs the line between testing and type systems.

THE LATEST NEWS: Python's most popular property-based testing tool, Hypothesis, now supports running CrossHair as an optional backend!

If you have a function with type annotations and add a contract in a supported syntax, CrossHair will attempt to find counterexamples for you:

CrossHair works by repeatedly calling your functions with symbolic inputs. It uses an SMT solver (a kind of theorem prover) to explore viable execution paths and find counterexamples for you. This is not a new idea; a Python approach was first described in this paper. However, to my knowledge, CrossHair is the most complete implementation: it can use symbolic reasoning for the built-in types, user-defined classes, and much of the standard library.

Try CrossHair right now, in your browser, at crosshair-web.org!

CrossHair has IDE integrations for VS Code, PyCharm, and more.

Finally, CrossHair can do more than check contracts. It can also generate unit tests and find behavioral differences between functions.

Want to help? Sign up for email or RSS updates. Star ⭐️ the repository. There are other ways to help too.

Documentation

• Introduction
• Get Started
• The Details: Contracts
• The Details: cover
• The Details: diffbehavior
• Kinds of Contracts
• Hints for Your Classes
• IDE Integrations
• Case Studies
• Limitations
• Plugins
• How Does It Work?
• How Can I Help?
• Related Work
• Contributing
• Changelog