PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

A library for property-based testing

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for DRMacIver from gravatar.com DRMacIver Avatar for Zac-HD from gravatar.com Zac-HD

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: MPL-2.0
    SPDX License Expression
  • Author: David R. MacIver and Zac Hatfield-Dodds
  • Tags python, testing, fuzzing, property-based-testing
  • Requires: Python >=3.9
  • Provides-Extra: cli, codemods, ghostwriter, pytz, dateutil, lark, numpy, pandas, pytest, dpcontracts, redis, crosshair, zoneinfo, django, watchdog, all
Classifiers
Report project as malware

Project description

Hypothesis

Hypothesis is the property-based testing library for Python. With Hypothesis, you write tests which should pass for all inputs in whatever range you describe, and let Hypothesis randomly choose which of those inputs to check - including edge cases you might not have thought about. For example:

from hypothesis import given, strategies as st


@given(st.lists(st.integers()))
def test_matches_builtin(ls):
    assert sorted(ls) == my_sort(ls)

This randomized testing can catch bugs and edge cases that you didn't think of and wouldn't have found. In addition, when Hypothesis does find a bug, it doesn't just report any failing example — it reports the simplest possible one. This makes property-based tests a powerful tool for debugging, as well as testing.

For instance,

def my_sort(ls):
    return sorted(set(ls))

fails with the simplest possible failing example:

Falsifying example: test_matches_builtin(ls=[0, 0])

Installation

To install Hypothesis:

pip install hypothesis

There are also optional extras available.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page