Changelog¶

This is a record of all past Hypothesis releases and what went into them, in reverse chronological order. All previous releases should still be available on PyPI.

Hypothesis 6.x¶

6.67.1 - 2023-02-05¶

This patch updates our autoformatting tools, improving our code style without any API changes.

6.67.0 - 2023-02-05¶

This release allows for more precise generation of complex numbers using from_dtype(), by supporting the width, min_magnitude, and min_magnitude arguments (issue #3468).

Thanks to Felix Divo for this feature!

6.66.2 - 2023-02-04¶

This patch fixes a rare RecursionError when pretty-printing a multi-line object without type-specific printer, which was passed to a function which returned the same object by .map() or builds() and thus recursed due to the new pretty reprs in Hypothesis 6.65.0 - 2023-01-24 (issue #3560). Apologies to all those affected.

6.66.1 - 2023-02-03¶

This makes from_dtype() pass through the parameter allow_subnormal for complex dtypes.

6.66.0 - 2023-02-02¶

This release adds a width parameter to complex_numbers(), analogously to floats().

Thanks to Felix Divo for the new feature!

6.65.2 - 2023-01-27¶

This patch fixes invalid annotations detected for the tests generated by Ghostwritter. It will now correctly generate Optional types with just one type argument and handle union expressions inside of type arguments correctly. Additionally, it now supports code with the from __future__ import annotations marker for Python 3.10 and newer.

6.65.1 - 2023-01-26¶

This release improves the pretty-printing of enums in falsifying examples, so that they print as their full identifier rather than their repr.

6.65.0 - 2023-01-24¶

Hypothesis now reports some failing inputs by showing the call which constructed an object, rather than the repr of the object. This can be helpful when the default repr does not include all relevant details, and will unlock further improvements in a future version.

For now, we capture calls made via builds(), and via SearchStrategy.map().

6.64.0 - 2023-01-23¶

The Ghostwritter will now include type annotations on tests for type-annotated code. If you want to force this to happen (or not happen), pass a boolean to the new annotate= argument to the Python functions, or the --[no-]annotate CLI flag.

Thanks to Nicolas Ganz for this new feature!

6.63.0 - 2023-01-20¶

range_indexes() now accepts a name= argument, to generate named pandas.RangeIndex objects.

Thanks to Sam Watts for this new feature!

6.62.1 - 2023-01-14¶

This patch tweaks xps.arrays() internals to improve PyTorch compatibility. Specifically, torch.full() does not accept integers as the shape argument (n.b. technically “size” in torch), but such behaviour is expected in internal code, so we copy the torch module and patch in a working full() function.

6.62.0 - 2023-01-08¶

A classic error when testing is to write a test function that can never fail, even on inputs that aren’t allowed or manually provided. By analogy to the design pattern of:

@pytest.mark.parametrize("arg", [
    ...,  # passing examples
    pytest.param(..., marks=[pytest.mark.xfail])  # expected-failing input
])

we now support @example(...).xfail(), with the same (optional) condition, reason, and raises arguments as pytest.mark.xfail().

Naturally you can also write .via(...).xfail(...), or .xfail(...).via(...), if you wish to note the provenance of expected-failing examples.

6.61.3 - 2023-01-08¶

This patch teaches our enhanced get_type_hints() function to ‘see through’ partial application, allowing inference from type hints to work in a few more cases which aren’t (yet!) supported by the standard-library version.

6.61.2 - 2023-01-07¶

This patch improves our pretty-printing of failing examples, including some refactoring to prepare for exciting future features.

6.61.1 - 2023-01-06¶

This patch brings our domains() and emails() strategies into compliance with RFC 5890 §2.3.1: we no longer generate parts-of-domains where the third and fourth characters are -- (“R-LDH labels”), though future versions may deliberately generate xn-- punycode labels. Thanks to python-email-validator for the report!

6.61.0 - 2022-12-11¶

This release improves our treatment of database keys, which based on (among other things) the source code of your test function. We now post-process this source to ignore decorators, comments, trailing whitespace, and blank lines - so that you can add @example()s or make some small no-op edits to your code without preventing replay of any known failing or covering examples.

6.60.1 - 2022-12-11¶

This patch updates our vendored list of top-level domains, which is used by the provisional domains() strategy.

6.60.0 - 2022-12-04¶

This release improves Hypothesis’ ability to resolve forward references in type annotations. It fixes a bug that prevented builds() from being used with pydantic models that possess updated forward references. See issue #3519.

6.59.0 - 2022-12-02¶

The @example(...) decorator now has a .via() method, which future tools will use to track automatically-added covering examples (issue #3506).

6.58.2 - 2022-11-30¶

This patch updates our vendored list of top-level domains, which is used by the provisional domains() strategy.

6.58.1 - 2022-11-26¶

This patch shifts hypothesis[lark] from depending on the old lark-parser package to the new lark package. There are no code changes in Hypothesis, it’s just that Lark got a new name on PyPI for version 1.0 onwards.

6.58.0 - 2022-11-19¶

register_random() has used weakref since 6.27.1 - 2021-11-22, allowing the Random-compatible objects to be garbage-collected when there are no other references remaining in order to avoid memory leaks. We now raise an error or emit a warning when this seems likely to happen immediately.

The type annotation of register_random() was also widened so that structural subtypes of Random are accepted by static typecheckers.

6.57.1 - 2022-11-14¶

This patch updates some internal type annotations and fixes a formatting bug in the explain phase reporting.

6.57.0 - 2022-11-14¶

Hypothesis now raises an error if you passed a strategy as the alphabet= argument to text(), and it generated something which was not a length-one string. This has never been supported, we’re just adding explicit validation to catch cases like this StackOverflow question.

6.56.4 - 2022-10-28¶

This patch updates some docs, and depends on exceptiongroup 1.0.0 final to avoid a bug in the previous version.

6.56.3 - 2022-10-17¶

This patch teaches text() to rewrite a few more filter predicates (issue #3134). You’re unlikely to notice any change.

6.56.2 - 2022-10-10¶

This patch updates our vendored list of top-level domains, which is used by the provisional domains() strategy, and fixes some incorrect examples in the docs for mutually_broadcastable_shapes().

6.56.1 - 2022-10-05¶

This patch improves the error message when Hypothesis detects “flush to zero” mode for floating-point: we now report which package(s) enabled this, which can make debugging much easier. See issue #3458 for details.

6.56.0 - 2022-10-02¶

This release defines __bool__() on SearchStrategy. It always returns True, like before, but also emits a warning to help with cases where you intended to draw a value (issue #3463).

6.55.0 - 2022-09-29¶

In preparation for future versions of the Array API standard, make_strategies_namespace() now accepts an optional api_version argument, which determines the version conformed to by the returned strategies namespace. If None, the version of the passed array module xp is inferred.

This release also introduces xps.real_dtypes(). This is currently equivalent to the existing xps.numeric_dtypes() strategy, but exists because the latter is expected to include complex numbers in the next version of the standard.

6.54.6 - 2022-09-18¶

If multiple explicit examples (from @example()) raise a Skip exception, for consistency with generated examples we now re-raise the first instead of collecting them into an ExceptionGroup (issue #3453).

6.54.5 - 2022-09-05¶

This patch updates our autoformatting tools, improving our code style without any API changes.

6.54.4 - 2022-08-20¶

This patch fixes some type annotations for Python 3.9 and earlier (issue #3397), and teaches explain mode about certain locations it should not bother reporting (issue #3439).

6.54.3 - 2022-08-12¶

This patch teaches the Ghostwriter an additional check for function and class locations that should make it use public APIs more often.

6.54.2 - 2022-08-10¶

This patch fixes our workaround for a pytest bug where the inner exceptions in an ExceptionGroup are not displayed (issue #3430).

6.54.1 - 2022-08-02¶

This patch makes FailedHealthCheck and DeadlineExceeded exceptions picklable, for compatibility with Django’s parallel test runner (issue #3426).

6.54.0 - 2022-08-02¶

Reporting of multiple failing examples now uses the PEP 654 ExceptionGroup type, which is provided by the exceptiongroup backport on Python 3.10 and earlier (issue #3175). hypothesis.errors.MultipleFailures is therefore deprecated.

Failing examples and other reports are now stored as PEP 678 exception notes, which ensures that they will always appear together with the traceback and other information about their respective error.

6.53.0 - 2022-07-25¶

from_field() now supports UsernameField from django.contrib.auth.forms.

Thanks to Afonso Silva for reporting and working on issue #3417.

6.52.4 - 2022-07-22¶

This patch improves the error message when you pass filenames to the hypothesis write CLI, which takes the name of a module or function (e.g. hypothesis write gzip or hypothesis write package.some_function rather than hypothesis write script.py).

Thanks to Ed Rogers for implementing this as part of the SciPy 2022 sprints!

6.52.3 - 2022-07-19¶

This patch ensures that the warning for non-interactive .example() points to your code instead of Hypothesis internals (issue #3403).

Thanks to @jameslamb for this fix.

6.52.2 - 2022-07-19¶

This patch makes integers() more likely to generate boundary values for large two-sided intervals (issue #2942).

6.52.1 - 2022-07-18¶

This patch adds filter rewriting for math.isfinite(), math.isinf(), and math.isnan() on integers() or floats() (issue #2701).

Thanks to Sam Clamons at the SciPy Sprints!

6.52.0 - 2022-07-18¶

This release adds the allow_subnormal argument to complex_numbers() by applying it to each of the real and imaginary parts separately. Closes issue #3390.

Thanks to Evan Tey for this fix.

6.51.0 - 2022-07-17¶

Issue a deprecation warning if a function decorated with @composite does not draw any values (issue #3384).

Thanks to Grzegorz Zieba, Rodrigo Girão, and Thomas Ball for working on this at the EuroPython sprints!

6.50.1 - 2022-07-09¶

This patch improves the error messages in @example() argument validation following the recent release of 6.49.1.

6.50.0 - 2022-07-09¶

This release allows from_dtype() to generate Unicode strings which cannot be encoded in UTF-8, but are valid in Numpy arrays (which use UTF-32).

This logic will only be used with Numpy >= 1.19, because earlier versions have an issue which led us to revert Hypothesis 5.2 last time!

6.49.1 - 2022-07-05¶

This patch fixes some inconsistency between argument handling for @example and @given (2706).

6.49.0 - 2022-07-04¶

This release uses PEP 612 python:typing.ParamSpec (or the typing_extensions backport) to express the first-argument-removing behaviour of @st.composite and signature-preservation of functions() to IDEs, editor plugins, and static type checkers such as mypy.

6.48.3 - 2022-07-03¶

hypothesis.event() now works for hashable objects which do not support weakrefs, such as integers and tuples.

6.48.2 - 2022-06-29¶

This patch tidies up some internal introspection logic, which will improve support for positional-only arguments in a future release (issue #2706).

6.48.1 - 2022-06-27¶

This release automatically rewrites some simple filters, such as floats().filter(lambda x: x >= 10) to the more efficient floats(min_value=10), based on the AST of the predicate.

We continue to recommend using the efficient form directly wherever possible, but this should be useful for e.g. pandera “Checks” where you already have a simple predicate and translating manually is really annoying. See issue #2701 for details.

6.48.0 - 2022-06-27¶

This release raises SkipTest for which never executed any examples, for example because the phases setting excluded the explicit, reuse, and generate phases. This helps to avoid cases where broken tests appear to pass, because they didn’t actually execute (issue #3328).

6.47.5 - 2022-06-25¶

This patch fixes type annotations that had caused the signature of @given to be partially-unknown to type-checkers for Python versions before 3.10.

6.47.4 - 2022-06-23¶

This patch fixes from_type() on Python 3.11, following python/cpython#93754.

6.47.3 - 2022-06-15¶

This patch makes the too_slow health check more consistent with long deadline tests (issue #3367) and fixes an install issue under pipenv which was introduced in Hypothesis 6.47.2 (issue #3374).

6.47.2 - 2022-06-12¶

We now use the PEP 654 ExceptionGroup type - provided by the exceptiongroup backport on older Pythons - to ensure that if multiple errors are raised in teardown, they will all propagate.

6.47.1 - 2022-06-10¶

Our pretty-printer no longer sorts dictionary keys, since iteration order is stable in Python 3.7+ and this can affect reproducing examples (issue #3370). This PR was kindly supported by Ordina Pythoneers.

6.47.0 - 2022-06-07¶

The Ghostwritter can now write tests for @classmethod or @staticmethod methods, in addition to the existing support for functions and other callables (issue #3318). Thanks to Cheuk Ting Ho for the patch.

6.46.11 - 2022-06-02¶

Mention hypothesis.strategies.timezones() in the documentation of hypothesis.strategies.datetimes() for completeness.

Thanks to George Macon for this addition.

6.46.10 - 2022-06-01¶

This release contains some small improvements to our documentation. Thanks to Felix Divo for his contribution!

6.46.9 - 2022-05-25¶

This patch by Adrian Garcia Badaracco adds type annotations to some private internals (issue #3074).

6.46.8 - 2022-05-25¶

This patch by Phillip Schanely makes changes to the floats() strategy when min_value or max_value is present. Hypothesis will now be capable of generating every representable value in the bounds. You may notice that hypothesis is more likely to test values near boundaries, and values that are very close to zero.

These changes also support future integrations with symbolic execution tools and fuzzers (issue #3086).

6.46.7 - 2022-05-19¶

This patch updates the type annotations for tuples() and one_of() so that type-checkers require its arguments to be positional-only, and so that it no longer fails under pyright-strict mode (see issue #3348). Additional changes are made to Hypothesis’ internals improve pyright scans.

6.46.6 - 2022-05-18¶

This patch by Cheuk Ting Ho adds support for PEP 655 Required and NotRequired as attributes of TypedDict in from_type() (issue #3339).

6.46.5 - 2022-05-15¶

This patch fixes from_dtype() with long-precision floating-point datatypes (typecode g; see numpy:numpy.typename()).

6.46.4 - 2022-05-15¶

This patch improves some error messages for custom signatures containing invalid parameter names (issue #3317).

6.46.3 - 2022-05-11¶

This patch by Cheuk Ting Ho makes it an explicit error to call from_type() or register_type_strategy() with types that have no runtime instances (issue #3280).

6.46.2 - 2022-05-03¶

This patch fixes silently dropping examples when the @example decorator is applied to itself (issue #3319). This was always a weird pattern, but now it works. Thanks to Ray Sogata, Keeri Tramm, and Kevin Khuong for working on this patch!

6.46.1 - 2022-05-01¶

This patch fixes a rare bug where we could incorrectly treat empty as a type annotation, if the callable had an explicitly assigned __signature__.

6.46.0 - 2022-05-01¶

This release adds an allow_nil argument to uuids(), which you can use to… generate the nil UUID. Thanks to Shlok Gandhi for the patch!

6.45.4 - 2022-05-01¶

This patch fixes some missing imports for certain Ghostwritten tests. Thanks to Mel Seto for fixing issue #3316.

6.45.3 - 2022-04-30¶

This patch teaches the Ghostwriter to recognize many more common argument names (issue #3311).

6.45.2 - 2022-04-29¶

This patch fixes issue #3314, where Hypothesis would raise an internal error from domains() or (only on Windows) from timezones() in some rare circumstances where the installation was subtly broken.

Thanks to Munir Abdinur for this contribution.

6.45.1 - 2022-04-27¶

This release fixes deprecation warnings about sre_compile and sre_parse imports and importlib.resources usage when running Hypothesis on Python 3.11.

Thanks to Florian Bruhin for this contribution.

6.45.0 - 2022-04-22¶

This release updates xps.indices() by introducing an allow_newaxis argument, defaulting to False. If allow_newaxis=True, indices can be generated that add dimensions to arrays, which is achieved by the indexer containing None. This change is to support a specification change that expand dimensions via indexing (data-apis/array-api#408).

6.44.0 - 2022-04-21¶

This release adds a names argument to indexes() and series(), so that you can create Pandas objects with specific or varied names.

Contributed by Sam Watts.

6.43.3 - 2022-04-18¶

This patch updates the type annotations for @given so that type-checkers will warn on mixed positional and keyword arguments, as well as fixing issue #3296.

6.43.2 - 2022-04-16¶

Fixed a type annotation for pyright --strict (issue #3287).

6.43.1 - 2022-04-13¶

This patch makes it an explicit error to call register_type_strategy() with a Pydantic GenericModel and a callable, because GenericModel isn’t actually a generic type at runtime and so you have to register each of the “parametrized versions” (actually subclasses!) manually. See issue #2940 for more details.

6.43.0 - 2022-04-12¶

This release makes it an explicit error to apply @pytest.fixture to a function which has already been decorated with @given(). Previously, pytest would convert your test to a fixture, and then never run it.

6.42.3 - 2022-04-10¶

This patch fixes from_type() on a TypedDict with complex annotations, defined in a file using from __future__ import annotations. Thanks to Katelyn Gigante for identifying and fixing this bug!

6.42.2 - 2022-04-10¶

The Hypothesis pytest plugin was not outputting valid xunit2 nodes when --junit-xml was specified. This has been broken since Pytest 5.4, which changed the internal API for adding nodes to the junit report.

This also fixes the issue when using hypothesis with --junit-xml and pytest-xdist where the junit xml report would not be xunit2 compatible. Now, when using with pytest-xdist, the junit report will just omit the <properties> node.

For more details, see this pytest issue, this pytest issue, and issue #1935

Thanks to Brandon Chinn for this bug fix!

6.42.1 - 2022-04-10¶

This patch fixes pretty-printing of regular expressions in Python 3.11.0a7, and updates our vendored list of top-level domains,.

6.42.0 - 2022-04-09¶

This release makes st.functions(pure=True) less noisy (issue #3253), and generally improves pretty-printing of functions.

6.41.0 - 2022-04-01¶

This release changes the implementation of infer to be an alias for python:Ellipsis. E.g. @given(a=infer) is now equivalent to @given(a=...). Furthermore, @given(...) can now be specified so that @given will infer the strategies for all arguments of the decorated function based on its annotations.

6.40.3 - 2022-04-01¶

This patch simplifies the repr of the strategies namespace returned in make_strategies_namespace(), e.g.

>>> from hypothesis.extra.array_api import make_strategies_namespace
>>> from numpy import array_api as xp
>>> xps = make_strategies_namespace(xp)
>>> xps
make_strategies_namespace(numpy.array_api)

6.40.2 - 2022-04-01¶

Fixed from_type() support for PEP 604 union types, like int | None (issue #3255).

6.40.1 - 2022-04-01¶

Fixed an internal error when given() was passed a lambda.

6.40.0 - 2022-03-29¶

The Ghostwriter can now write tests which check that two or more functions are equivalent on valid inputs, or raise the same type of exception for invalid inputs (issue #3267).

6.39.6 - 2022-03-27¶

This patch makes some quality-of-life improvements to the Ghostwriter: we guess the text() strategy for arguments named text (…obvious in hindsight, eh?); and improved the error message if you accidentally left in a nothing() or broke your rich install.

6.39.5 - 2022-03-26¶

This patch improves our error detection and message when Hypothesis is run on a Python implementation without support for -0.0, which is required for the floats() strategy but can be disabled by unsafe compiler options (issue #3265).

6.39.4 - 2022-03-17¶

This patch tweaks some internal formatting. There is no user-visible change.

6.39.3 - 2022-03-07¶

If the shrink phase is disabled, we now stop the generate phase as soon as an error is found regardless of the value of the report_multiple_examples setting, since that’s probably what you wanted (issue #3244).

6.39.2 - 2022-03-07¶

This patch clarifies rare error messages in builds() (issue #3225) and floats() (issue #3207).

6.39.1 - 2022-03-03¶

This patch fixes a regression where the bound inner function (your_test.hypothesis.inner_test) would be invoked with positional arguments rather than passing them by name, which broke pytest-asyncio (issue #3245).

6.39.0 - 2022-03-01¶

This release improves Hypothesis’ handling of positional-only arguments, which are now allowed @st.composite strategies.

On Python 3.8 and later, the first arguments to builds() and from_model() are now natively positional-only. In cases which were already errors, the TypeError from incorrect usage will therefore be raises immediately when the function is called, rather than when the strategy object is used.

6.38.0 - 2022-02-26¶

This release makes floats() error consistently when your floating-point hardware has been configured to violate IEEE-754 for subnormal numbers, instead of only when an internal assertion was tripped (issue #3092).

If this happens to you, passing allow_subnormal=False will suppress the explicit error. However, we strongly recommend fixing the root cause by disabling global-effect unsafe-math compiler options instead, or at least consulting e.g. Simon Byrne’s Beware of fast-math explainer first.

6.37.2 - 2022-02-21¶

This patch fixes a bug in stateful testing, where returning a single value wrapped in multiple() would be printed such that the assigned variable was a tuple rather than the single element (issue #3236).

6.37.1 - 2022-02-21¶

This patch fixes a warning under pytest 7 relating to our rich traceback display logic (issue #3223).

6.37.0 - 2022-02-18¶

When distinguishing multiple errors, Hypothesis now looks at the inner exceptions of PEP 654 ExceptionGroups.

6.36.2 - 2022-02-13¶

This patch updates our vendored list of top-level domains, which is used by the provisional domains() strategy.

6.36.1 - 2022-01-31¶

This patch fixes some deprecation warnings from pytest 7.0, along with some code formatting and docs updates.

6.36.0 - 2022-01-19¶

This release disallows using python:typing.Final with from_type() and register_type_strategy().

Why? Because Final can only be used during class definition. We don’t generate class attributes.

It also does not make sense as a runtime type on its own.

6.35.1 - 2022-01-17¶

This patch fixes hypothesis write output highlighting with rich version 12.0 and later.

6.35.0 - 2022-01-08¶

This release disallows using python:typing.ClassVar with from_type() and register_type_strategy().

Why? Because ClassVar can only be used during class definition. We don’t generate class attributes.

It also does not make sense as a runtime type on its own.

6.34.2 - 2022-01-05¶

This patch updates our vendored list of top-level domains, which is used by the provisional domains() strategy.

6.34.1 - 2021-12-31¶

This patch fixes issue #3169, an extremely rare bug which would trigger if an internal least-recently-reused cache dropped a newly added entry immediately after it was added.

6.34.0 - 2021-12-31¶

This release fixes issue #3133 and issue #3144, where attempting to generate Pandas series of lists or sets would fail with confusing errors if you did not specify dtype=object.

6.33.0 - 2021-12-30¶

This release disallows using python:typing.TypeAlias with from_type() and register_type_strategy().

Why? Because TypeAlias is not really a type, it is a tag for type checkers that some expression is a type alias, not something else.

It does not make sense for Hypothesis to resolve it as a strategy. References issue #2978.

6.32.1 - 2021-12-23¶

This patch updates our autoformatting tools, improving our code style without any API changes.

6.32.0 - 2021-12-23¶

This release drops support for Python 3.6, which reached end of life upstream on 2021-12-23.

6.31.6 - 2021-12-15¶

This patch adds a temporary hook for a downstream tool, which is not part of the public API.

6.31.5 - 2021-12-14¶

This release updates our copyright headers to use a general authorship statement and omit the year.

6.31.4 - 2021-12-11¶

This patch makes the .example() method more representative of test-time data generation, albeit often at a substantial cost to readability (issue #3182).

6.31.3 - 2021-12-10¶

This patch improves annotations on some of Hypothesis’ internal functions, in order to deobfuscate the signatures of some strategies. In particular, strategies shared between hypothesis.extra.numpy and the hypothesis.extra.array_api extra will benefit from this patch.

6.31.2 - 2021-12-10¶

This patch fix invariants display in stateful falsifying examples (issue #3185).

6.31.1 - 2021-12-10¶

This patch updates xps.indices() so no flat indices are generated, i.e. generated indices will now always explicitly cover each axes of an array if no ellipsis is present. This is to be consistent with a specification change that dropped support for flat indexing (#272).

6.31.0 - 2021-12-09¶

This release makes us compatible with Django 4.0, in particular by adding support for use of zoneinfo timezones (though we respect the new USE_DEPRECATED_PYTZ setting if you need it).

6.30.1 - 2021-12-05¶

This patch updates our vendored list of top-level domains, which is used by the provisional domains() strategy.

6.30.0 - 2021-12-03¶

This release adds an allow_subnormal argument to the floats() strategy, which can explicitly toggle the generation of subnormal floats (issue #3155). Disabling such generation is useful when testing flush-to-zero builds of libraries.

nps.from_dtype() and xps.from_dtype() can also accept the allow_subnormal argument, and xps.from_dtype() or xps.arrays() will disable subnormals by default if the array module xp is detected to flush-to-zero (like is typical with CuPy).

6.29.3 - 2021-12-02¶

This patch fixes a bug in mutually_broadcastable_shapes(), which restricted the patterns of singleton dimensions that could be generated for dimensions that extended beyond base_shape (issue #3170).

6.29.2 - 2021-12-02¶

This patch clarifies our pretty-printing of DataFrames (issue #3114).

6.29.1 - 2021-12-02¶

This patch documents timezones() Windows-only requirement for the tzdata package, and ensures that pip install hypothesis[zoneinfo] will install the latest version.

6.29.0 - 2021-11-29¶

This release teaches builds() to use deferred() when resolving unrecognised type hints, so that you can conveniently register strategies for recursive types with constraints on some arguments (issue #3026):

class RecursiveClass:
    def __init__(self, value: int, next_node: typing.Optional["SomeClass"]):
        assert value > 0
        self.value = value
        self.next_node = next_node


st.register_type_strategy(
    RecursiveClass, st.builds(RecursiveClass, value=st.integers(min_value=1))
)

6.28.1 - 2021-11-28¶

This release fixes some internal calculations related to collection sizes (issue #3143).

6.28.0 - 2021-11-28¶

This release modifies our pytest plugin, to avoid importing Hypothesis and therefore triggering Hypothesis’ entry points for test suites where Hypothesis is installed but not actually used (issue #3140).

6.27.3 - 2021-11-28¶

This release fixes issue #3080, where from_type() failed on unions containing PEP 585 builtin generic types (like list[int]) in Python 3.9 and later.

6.27.2 - 2021-11-26¶

This patch makes the hypothesis codemod command somewhat faster.

6.27.1 - 2021-11-22¶

This patch changes the backing datastructures of register_random() and a few internal caches to use weakref.WeakValueDictionary. This reduces memory usage and may improve performance when registered Random instances are only used for a subset of your tests (issue #3131).

6.27.0 - 2021-11-22¶

This release teaches Hypothesis’ multiple-error reporting to format tracebacks using pytest or better-exceptions, if they are installed and enabled (issue #3116).

6.26.0 - 2021-11-21¶

Did you know that of the 2⁶⁴ possible floating-point numbers, 2⁵³ of them are nan - and Python prints them all the same way?

While nans usually have all zeros in the sign bit and mantissa, this isn’t always true, and ‘signaling’ nans might trap or error. To help distinguish such errors in e.g. CI logs, Hypothesis now prints -nan for negative nans, and adds a comment like # Saw 3 signaling NaNs if applicable.

6.25.0 - 2021-11-19¶

This release adds special filtering logic to make a few special cases like s.map(lambda x: x) and lists().filter(len) more efficient (issue #2701).

6.24.6 - 2021-11-18¶

This patch makes floats() generate “subnormal” floating point numbers more often, as these rare values can have strange interactions with unsafe compiler optimisations like -ffast-math (issue #2976).

6.24.5 - 2021-11-16¶

This patch fixes a rare internal error in the datetimes() strategy, where the implementation of allow_imaginary=False crashed when checking a time during the skipped hour of a DST transition if the DST offset is negative - only true of Europe/Dublin, who we presume have their reasons - and the tzinfo object is a pytz timezone (which predates PEP 495).

6.24.4 - 2021-11-15¶

This patch gives Hypothesis it’s own internal Random instance, ensuring that test suites which reset the global random state don’t induce weird correlations between property-based tests (issue #2135).

6.24.3 - 2021-11-13¶

This patch updates documentation of note() (issue #3147).

6.24.2 - 2021-11-05¶

This patch updates internal testing for the Array API extra to be consistent with new specification changes: sum() not accepting boolean arrays (#234), unique() split into separate functions (#275), and treating NaNs as distinct (#310). It has no user visible impact.

6.24.1 - 2021-11-01¶

This patch updates our vendored list of top-level domains, which is used by the provisional domains() strategy.

6.24.0 - 2021-10-23¶

This patch updates our vendored list of top-level domains, which is used by the provisional domains() strategy.

(did you know that gTLDs can be both added and removed?)

6.23.4 - 2021-10-20¶

This patch adds an error for when shapes in xps.arrays() is not passed as either a valid shape or strategy.

6.23.3 - 2021-10-18¶

This patch updates our formatting with shed.

6.23.2 - 2021-10-08¶

This patch replaces external links to NumPy API docs with sphinx.ext.intersphinx cross-references. It is purely a documentation improvement.

6.23.1 - 2021-09-29¶

This patch cleans up internal logic for xps.arrays(). There is no user-visible change.

6.23.0 - 2021-09-26¶

This release follows pytest in considering SystemExit and GeneratorExit exceptions to be test failures, meaning that we will shink to minimal examples and check for flakiness even though they subclass BaseException directly (issue #2223).

KeyboardInterrupt continues to interrupt everything, and will be re-raised immediately.

6.22.0 - 2021-09-24¶

This release adds LiveServerTestCase and StaticLiveServerTestCase for django test. Thanks to Ivan Tham for this feature!

6.21.6 - 2021-09-19¶

This patch fixes some new linter warnings such as flake8-bugbear’s B904 for explicit exception chaining, so tracebacks might be a bit nicer.

6.21.5 - 2021-09-16¶

This release fixes None being inferred as the float64 dtype in from_dtype() and arrays() from the Array API extra.

6.21.4 - 2021-09-16¶

This release fixes the type hint for the @given() decorator when decorating an async function (issue #3099).

6.21.3 - 2021-09-15¶

This release improves Ghostwritten tests for builtins (issue #2977).

6.21.2 - 2021-09-15¶

This release deprecates use of both min_dims > len(shape) and max_dims > len(shape) when allow_newaxis == False in basic_indices() (issue #3091).

6.21.1 - 2021-09-13¶

This release improves the behaviour of builds() and from_type() in certain situations involving decorators (issue #2495 and issue #3029).

6.21.0 - 2021-09-11¶

This release introduces strategies for array/tensor libraries adopting the Array API standard (issue #3037). They are available in the hypothesis.extra.array_api extra, and work much like the existing strategies for NumPy.

6.20.1 - 2021-09-10¶

This patch fixes issue #961, where calling given() inline on a bound method would fail to handle the self argument correctly.

6.20.0 - 2021-09-09¶

This release allows slices() to generate step=None, and fixes an off-by-one error where the start index could be equal to size. This works fine for all Python sequences and Numpy arrays, but is undefined behaviour in the Array API standard (see pull request #3065).

6.19.0 - 2021-09-08¶

This release makes stateful testing more likely to tell you if you do something unexpected and unsupported:

The return_value health check now applies to rule() and initialize() rules, if they don’t have target bundles, as well as invariant().
Using a consumes() bundle as a target is deprecated, and will be an error in a future version.

If existing code triggers these new checks, check for related bugs and misunderstandings - these patterns never had any effect.

6.18.0 - 2021-09-06¶

This release teaches from_type() a neat trick: when resolving an python:typing.Annotated type, if one of the annotations is a strategy object we use that as the inferred strategy. For example:

PositiveInt = Annotated[int, st.integers(min_value=1)]

If there are multiple strategies, we use the last outer-most annotation. See issue #2978 and pull request #3082 for discussion.

Requires Python 3.9 or later for get_type_hints(..., include_extras=False).

6.17.4 - 2021-08-31¶

This patch makes unique arrays() much more efficient, especially when there are only a few valid elements - such as for eight-bit integers (issue #3066).

6.17.3 - 2021-08-30¶

This patch fixes the repr of array_shapes().

6.17.2 - 2021-08-30¶

This patch wraps some internal helper code in our proxies decorator to prevent mutations of method docstrings carrying over to other instances of the respective methods.

6.17.1 - 2021-08-29¶

This patch moves some internal helper code in preparation for issue #3065. There is no user-visible change, unless you depended on undocumented internals.

6.17.0 - 2021-08-27¶

This release adds type annotations to the stateful testing API.

Thanks to Ruben Opdebeeck for this contribution!

6.16.0 - 2021-08-27¶

This release adds the DrawFn type as a reusable type hint for the draw argument of @composite functions.

Thanks to Ruben Opdebeeck for this contribution!

6.15.0 - 2021-08-22¶

This release emits a more useful error message when @given() is applied to a coroutine function, i.e. one defined using async def (issue #3054).

This was previously only handled by the generic return_value health check, which doesn’t direct you to use either a custom executor or a library such as pytest-trio or pytest-asyncio to handle it for you.

6.14.9 - 2021-08-20¶

This patch fixes a regression in Hypothesis 6.14.8, where from_type() failed to resolve types which inherit from multiple parametrised generic types, affecting the returns package (issue #3060).

6.14.8 - 2021-08-16¶

This patch ensures that registering a strategy for a subclass of a a parametrised generic type such as class Lines(Sequence[str]): will not “leak” into unrelated strategies such as st.from_type(Sequence[int]) (issue #2951). Unfortunately this fix requires PEP 560, meaning Python 3.7 or later.

6.14.7 - 2021-08-14¶

This patch fixes issue #3050, where attrs classes could cause an internal error in the ghostwriter.

6.14.6 - 2021-08-07¶

This patch improves the error message for issue #3016, where PEP 585 builtin generics with self-referential forward-reference strings cannot be resolved to a strategy by from_type().

6.14.5 - 2021-07-27¶

This patch fixes hypothesis.strategies._internal.types.is_a_new_type. It was failing on Python 3.10.0b4, where NewType is a function.

6.14.4 - 2021-07-26¶

This patch fixes from_type() and register_type_strategy() for python:typing.NewType on Python 3.10, which changed the underlying implementation (see bpo-44353 for details).

6.14.3 - 2021-07-18¶

This patch updates our autoformatting tools, improving our code style without any API changes.

6.14.2 - 2021-07-12¶

This patch ensures that we shorten tracebacks for tests which fail due to inconsistent data generation between runs (i.e. raise Flaky).

6.14.1 - 2021-07-02¶

This patch updates some internal type annotations. There is no user-visible change.

6.14.0 - 2021-06-09¶

The explain phase now requires shrinking to be enabled, and will be automatically skipped for deadline-exceeded errors.

6.13.14 - 2021-06-04¶

This patch improves the tuples() strategy type annotations, to preserve the element types for up to length-five tuples (issue #3005).

As for one_of(), this is the best we can do before a planned extension to PEP 646 is released, hopefully in Python 3.11.

6.13.13 - 2021-06-04¶

This patch teaches the Ghostwriter how to find custom ufuncs from any module that defines them, and that yaml.unsafe_load() does not undo yaml.safe_load().

6.13.12 - 2021-06-03¶

This patch reduces the amount of internal code excluded from our test suite’s code coverage checks.

There is no user-visible change.

6.13.11 - 2021-06-02¶

This patch removes some old internal helper code that previously existed to make Python 2 compatibility easier.

There is no user-visible change.

6.13.10 - 2021-05-30¶

This release adjusts some internal code to help make our test suite more reliable.

There is no user-visible change.

6.13.9 - 2021-05-30¶

This patch cleans up some internal code related to filtering strategies.

There is no user-visible change.

6.13.8 - 2021-05-28¶

This patch slightly improves the performance of some internal code for generating integers.

6.13.7 - 2021-05-27¶

This patch fixes a bug in from_regex() that caused from_regex("", fullmatch=True) to unintentionally generate non-empty strings (issue #4982).

The only strings that completely match an empty regex pattern are empty strings.

6.13.6 - 2021-05-26¶

This patch fixes a bug that caused integers() to shrink towards negative values instead of positive values in some cases.

6.13.5 - 2021-05-24¶

This patch fixes rare cases where hypothesis write --binary-op could print reproducing instructions from the internal search for an identity element.

6.13.4 - 2021-05-24¶

This patch removes some unnecessary intermediate list-comprehensions, using the latest versions of pyupgrade and shed.

6.13.3 - 2021-05-23¶

This patch adds a .hypothesis property to invalid test functions, bringing them inline with valid tests and fixing a bug where pytest-asyncio would swallow the real error message and mistakenly raise a version incompatibility error.

6.13.2 - 2021-05-23¶

Some of Hypothesis’s numpy/pandas strategies use a fill argument to speed up generating large arrays, by generating a single fill value and sharing that value among many array slots instead of filling every single slot individually.

When no fill argument is provided, Hypothesis tries to detect whether it is OK to automatically use the elements argument as a fill strategy, so that it can still use the faster approach.

This patch fixes a bug that would cause that optimization to trigger in some cases where it isn’t 100% guaranteed to be OK.

If this makes some of your numpy/pandas tests run more slowly, try adding an explicit fill argument to the relevant strategies to ensure that Hypothesis always uses the faster approach.

6.13.1 - 2021-05-20¶

This patch strengthens some internal import-time consistency checks for the built-in strategies.

There is no user-visible change.

6.13.0 - 2021-05-18¶

This release adds URL fragment generation to the urls() strategy (issue #2908). Thanks to Pax (R. Margret) for contributing this patch at the PyCon US Mentored Sprints!

6.12.1 - 2021-05-17¶

This patch fixes issue #2964, where .map() and .filter() methods were omitted from the repr() of just() and sampled_from() strategies, since version 5.43.7.

6.12.0 - 2021-05-06¶

This release automatically rewrites some simple filters, such as integers().filter(lambda x: x > 9) to the more efficient integers(min_value=10), based on the AST of the predicate.

We continue to recommend using the efficient form directly wherever possible, but this should be useful for e.g. pandera “Checks” where you already have a simple predicate and translating manually is really annoying. See issue #2701 for ideas about floats and simple text strategies.

6.11.0 - 2021-05-06¶

hypothesis.target() now returns the observation value, allowing it to be conveniently used inline in expressions such as assert target(abs(a - b)) < 0.1.

6.10.1 - 2021-04-26¶

This patch fixes a deprecation warning if you’re using recent versions of importlib-metadata (issue #2934), which we use to load third-party plugins such as Pydantic’s integration. On older versions of importlib-metadata, there is no change and you don’t need to upgrade.

6.10.0 - 2021-04-17¶

This release teaches the Ghostwriter to read parameter types from Sphinx, Google, or Numpy-style structured docstrings, and improves some related heuristics about how to test scientific and numerical programs.

6.9.2 - 2021-04-15¶

This release improves the Ghostwriter’s handling of exceptions, by reading :raises ...: entries in function docstrings and ensuring that we don’t suppresss the error raised by test assertions.

6.9.1 - 2021-04-12¶

This patch updates our autoformatting tools, improving our code style without any API changes.

6.9.0 - 2021-04-11¶

This release teaches from_type() how to see through python:typing.Annotated. Thanks to Vytautas Strimaitis for reporting and fixing issue #2919!

6.8.12 - 2021-04-11¶

If rich is installed, the hypothesis write command will use it to syntax-highlight the Ghostwritten code.

6.8.11 - 2021-04-11¶

This patch improves an error message from builds() when from_type() would be more suitable (issue #2930).

6.8.10 - 2021-04-11¶

This patch updates the type annotations for arrays() to reflect that shape: SearchStrategy[int] is supported.

6.8.9 - 2021-04-07¶

This patch fixes from_type() with abstract types which have either required but non-type-annotated arguments to __init__, or where from_type() can handle some concrete subclasses but not others.

6.8.8 - 2021-04-07¶

This patch teaches hypothesis write to check for possible roundtrips in several more cases, such as by looking for an inverse in the module which defines the function to test.

6.8.7 - 2021-04-07¶

This patch adds a more helpful error message if you try to call sampled_from() on an Enum which has no members, but does have dataclass()-style annotations (issue #2923).

6.8.6 - 2021-04-06¶

The fixed_dictionaries() strategy now preserves dict iteration order instead of sorting the keys. This also affects the pretty-printing of keyword arguments to @given() (issue #2913).

6.8.5 - 2021-04-05¶

This patch teaches hypothesis write to default to ghostwriting tests with --style=pytest only if pytest is installed, or --style=unittest otherwise.

6.8.4 - 2021-04-01¶

This patch adds type annotations for the settings decorator, to avoid an error when running mypy in strict mode.

6.8.3 - 2021-03-28¶

This patch improves the Ghostwriter’s handling of strategies to generate various fiddly types including frozensets, keysviews, valuesviews, regex matches and patterns, and so on.

6.8.2 - 2021-03-27¶

This patch fixes some internal typos. There is no user-visible change.

6.8.1 - 2021-03-14¶

This patch lays more groundwork for filter rewriting (issue #2701). There is no user-visible change… yet.

6.8.0 - 2021-03-11¶

This release registers the remaining builtin types, and teaches from_type() to try resolving ForwardRef and Type references to built-in types.

6.7.0 - 2021-03-10¶

This release teaches RuleBasedStateMachine to avoid checking invariant()s until all initialize() rules have been run. You can enable checking of specific invariants for incompletely initialized machines by using @invariant(check_during_init=True) (issue #2868).

In previous versions, it was possible if awkward to implement this behaviour using precondition() and an auxiliary variable.

6.6.1 - 2021-03-09¶

This patch improves the error message when from_type() fails to resolve a forward-reference inside a python:typing.Type such as Type["int"] (issue #2565).

6.6.0 - 2021-03-07¶

This release makes it an explicit error to apply invariant() to a rule() or initialize() rule in stateful testing. Such a combination had unclear semantics, especially in combination with precondition(), and was never meant to be allowed (issue #2681).

6.5.0 - 2021-03-07¶

This release adds the explain phase, in which Hypothesis attempts to explain why your test failed by pointing to suspicious lines of code (i.e. those which were always, and only, run on failing inputs). We plan to include “generalising” failing examples in this phase in a future release (issue #2192).

6.4.3 - 2021-03-04¶

This patch fixes issue #2794, where nesting deferred() strategies within recursive() strategies could trigger an internal assertion. While it was always possible to get the same results from a more sensible strategy, the convoluted form now works too.

6.4.2 - 2021-03-04¶

This patch fixes several problems with mypy when –no-implicit-reexport was activated in user projects.

Thanks to Nikita Sobolev for fixing issue #2884!

6.4.1 - 2021-03-04¶

This patch fixes an exception that occurs when using type unions of the typing_extensions Literal backport on Python 3.6.

Thanks to Ben Anhalt for identifying and fixing this bug.

6.4.0 - 2021-03-02¶

This release fixes stateful testing methods with multiple precondition() decorators. Previously, only the outer-most precondition was checked (issue #2681).

6.3.4 - 2021-02-28¶

This patch refactors some internals of RuleBasedStateMachine. There is no change to the public API or behaviour.

6.3.3 - 2021-02-26¶

This patch moves some internal code, so that future work can avoid creating import cycles. There is no user-visible change.

6.3.2 - 2021-02-25¶

This patch enables register_type_strategy() for subclasses of python:typing.TypedDict. Previously, from_type() would ignore the registered strategy (issue #2872).

Thanks to Ilya Lebedev for identifying and fixing this bug!

6.3.1 - 2021-02-24¶

This release lays the groundwork for automatic rewriting of simple filters, for example converting integers().filter(lambda x: x > 9) to integers(min_value=10).

Note that this is not supported yet, and we will continue to recommend writing the efficient form directly wherever possible - predicate rewriting is provided mainly for the benefit of downstream libraries which would otherwise have to implement it for themselves (e.g. pandera and icontract-hypothesis). See issue #2701 for details.

6.3.0 - 2021-02-20¶

The Hypothesis pytest plugin now requires pytest version 4.6 or later. If the plugin detects an earlier version of pytest, it will automatically deactivate itself.

(4.6.x is the earliest pytest branch that still accepts community bugfixes.)

Hypothesis-based tests should continue to work in earlier versions of pytest, but enhanced integrations provided by the plugin (such as --hypothesis-show-statistics and other command-line flags) will no longer be available in obsolete pytest versions.

6.2.0 - 2021-02-12¶

If you use pytest-html, Hypothesis now includes the summary statistics for each test in the HTML report, whether or not the --hypothesis-show-statistics argument was passed to show them in the command-line output.

6.1.1 - 2021-01-31¶

This patch updates our automatic code formatting to use shed, which includes autoflake, black, isort, and pyupgrade (issue #2780).

6.1.0 - 2021-01-29¶

This release teaches Hypothesis to distinguish between errors based on the __cause__ or __context__ of otherwise identical exceptions, which is particularly useful when internal errors can be wrapped by a library-specific or semantically appropriate exception such as:

try:
    do_the_thing(foo, timeout=10)
except Exception as err:
    raise FooError("Failed to do the thing") from err

Earlier versions of Hypothesis only see the FooError, while we can now distinguish a FooError raised because of e.g. an internal assertion from one raised because of a TimeoutExceeded exception.

6.0.4 - 2021-01-27¶

This release prevents a race condition inside recursive() strategies. The race condition occurs when the same recursive() strategy is shared among tests that are running in multiple threads (issue #2717).

6.0.3 - 2021-01-23¶

This patch improves the type annotations for one_of(), by adding overloads to handle up to five distinct arguments as Union before falling back to Any, as well as annotating the | (__or__) operator for strategies (issue #2765).

6.0.2 - 2021-01-14¶

This release makes some small improvements to how filtered strategies work. It should improve the performance of shrinking filtered strategies, and may under some (probably rare) circumstances improve the diversity of generated examples.

6.0.1 - 2021-01-13¶

This patch fixes an interaction where our test statistics handling made Pytest’s --junit-xml output fail to validate against the strict xunit2 schema (issue #1975).

6.0.0 - 2021-01-08¶

Welcome to the next major version of Hypothesis!

There are no new features here, as we release those in minor versions. Instead, 6.0 is a chance for us to remove deprecated features (many already converted into no-ops), and turn a variety of warnings into errors.

If you were running on the last version of Hypothesis 5.x without any Hypothesis deprecation warnings, this will be a very boring upgrade. In fact, nothing will change for you at all.

Changes¶

Many functions now use PEP 3102 keyword-only arguments where passing positional arguments was deprecated since 5.5.
hypothesis.extra.django.from_model() no longer accepts model as a keyword argument, where it could conflict with fields named “model”.
randoms() now defaults to use_true_random=False.
complex_numbers() no longer accepts min_magnitude=None; either use min_magnitude=0 or just omit the argument.
hypothesis.provisional.ip4_addr_strings and ip6_addr_strings are removed in favor of ip_addresses(v=...).map(str).
register_type_strategy() no longer accepts generic types with type arguments, which were always pretty badly broken.
Using function-scoped pytest fixtures is now a health-check error, instead of a warning.

Tip

The hypothesis codemod command can automatically refactor your code, particularly to convert positional to keyword arguments where those are now required.

Hypothesis 5.x¶

5.49.0 - 2021-01-07¶

This release adds the function_scoped_fixture health check value, which can be used to suppress the existing warning that appears when @given is applied to a test that uses pytest function-scoped fixtures.

(This warning exists because function-scoped fixtures only run once per function, not once per example, which is usually unexpected and can cause subtle problems.)

When this warning becomes a health check error in a future release, suppressing it via Python warning settings will no longer be possible. In the rare case that once-per-function behaviour is intended, it will still be possible to use function_scoped_fixture to opt out of the health check error for specific tests.

5.48.0 - 2021-01-06¶

This release adds hypothesis.currently_in_test_context(), which can be used to check whether the calling code is currently running inside an @given or stateful test.

This is most useful for third-party integrations and assertion helpers which may wish to use assume() or target(), without also requiring that the helper only be used from property-based tests (issue #2581).

5.47.0 - 2021-01-05¶

This release upgrades the import logic for ghostwritten tests, handling many cases where imports would previously be missing or from unexpected locations.

5.46.0 - 2021-01-04¶

This release upgrades from_type(), to infer strategies for type-annotated arguments even if they have defaults when it otherwise falls back to builds() (issue #2708).

5.45.0 - 2021-01-04¶

This release adds the codemods extra, which you can use to check for and automatically fix issues such as use of deprecated Hypothesis APIs (issue #2705).

5.44.0 - 2021-01-03¶

This patch fixes from_type() with the typing_extensions Literal backport on Python 3.6.

5.43.9 - 2021-01-02¶

This patch fixes issue #2722, where certain orderings of register_type_strategy(), ForwardRef, and from_type() could trigger an internal error.

5.43.8 - 2021-01-02¶

This patch makes some strategies for collections with a uniqueness constraint much more efficient, including dictionaries(keys=sampled_from(...), values=..) and lists(tuples(sampled_from(...), ...), unique_by=lambda x: x[0]). (related to issue #2036)

5.43.7 - 2021-01-02¶

This patch extends our faster special case for sampled_from() elements in unique lists() to account for chains of .map(...) and .filter(...) calls (issue #2036).

5.43.6 - 2021-01-02¶

This patch improves the type annotations on assume() and @reproduce_failure().

5.43.5 - 2021-01-01¶

This patch updates our copyright headers to include 2021. Happy new year!

5.43.4 - 2020-12-24¶

This change fixes a documentation error in the database setting.

The previous documentation suggested that callers could specify a database path string, or the special string ":memory:", but this setting has never actually allowed string arguments.

Permitted values are None, and instances of ExampleDatabase.

5.43.3 - 2020-12-11¶

This patch fixes issue #2696, an internal error triggered when the @example decorator was used and the verbosity setting was quiet.

5.43.2 - 2020-12-10¶

This patch improves the error message from the data_frames() strategy when both the rows and columns arguments are given, but there is a missing entry in rows and the corresponding column has no fill value (issue #2678).

5.43.1 - 2020-12-10¶

This patch improves the error message if builds() is passed an Enum which cannot be called without arguments, to suggest using sampled_from() (issue #2693).

5.43.0 - 2020-12-09¶

This release adds new timezones() and timezone_keys() strategies (issue #2630) based on the new python:zoneinfo module in Python 3.9.

pip install hypothesis[zoneinfo] will ensure that you have the appropriate backports installed if you need them.

5.42.3 - 2020-12-09¶

This patch fixes an internal error in datetimes() with allow_imaginary=False where the timezones argument can generate tzinfo=None (issue #2662).

5.42.2 - 2020-12-09¶

This patch teaches hypothesis.extra.django.from_field() to infer more efficient strategies by inspecting (not just filtering by) field validators for numeric and string fields (issue #1116).

5.42.1 - 2020-12-09¶

This patch refactors hypothesis.settings to use type-annotated keyword arguments instead of **kwargs, which makes tab-completion much more useful - as well as type-checkers like mypy.

5.42.0 - 2020-12-09¶

This patch teaches the magic() ghostwriter to recognise “en/de” function roundtrips other than the common encode/decode pattern, such as encrypt/decrypt or, encipher/decipher.

5.41.5 - 2020-12-05¶

This patch adds a performance optimisation to avoid saving redundant seeds when using the .fuzz_one_input hook.

5.41.4 - 2020-11-28¶

This patch fixes issue #2657, where passing unicode patterns compiled with python:re.IGNORECASE to from_regex() could trigger an internal error when casefolding a character creates a longer string (e.g. "\u0130".lower() -> "i\u0370").

5.41.3 - 2020-11-18¶

This patch adds a final fallback clause to our plugin logic to fail with a warning rather than error on Python < 3.8 when neither the importlib_metadata (preferred) or setuptools (fallback) packages are available.

5.41.2 - 2020-11-08¶

This patch fixes urls() strategy ensuring that ~ (tilde) is treated as one of the url-safe characters (issue #2658).

5.41.1 - 2020-11-03¶

This patch improves our CLI help and documentation.

5.41.0 - 2020-10-30¶

Hypothesis now shrinks examples where the error is raised while drawing from a strategy. This makes complicated custom strategies much easier to debug, at the cost of a slowdown for use-cases where you catch and ignore such errors.

5.40.0 - 2020-10-30¶

This release teaches from_type() how to handle ChainMap, Counter, Deque, Generator, Match, OrderedDict, Pattern, and Set (issue #2654).

5.39.0 - 2020-10-30¶

from_type() now knows how to resolve PEP 585 parameterized standard collection types, which are new in Python 3.9 (issue #2629).

5.38.1 - 2020-10-26¶

This patch fixes builds(), so that when passed infer for an argument with a non-Optional type annotation and a default value of None to build a class which defines an explicit __signature__ attribute, either None or that type may be generated.

This is unlikely to happen unless you are using pydantic (issue #2648).

5.38.0 - 2020-10-24¶

This release improves our support for @st.composite on a python:classmethod or python:staticmethod (issue #2578).

5.37.5 - 2020-10-24¶

This patch fixes from_type() with Iterable[T] (issue #2645).

5.37.4 - 2020-10-20¶

This patch teaches the magic() ghostwriter to recognise that pairs of functions like rgb_to_hsv() and hsv_to_rgb() should roundtrip().

5.37.3 - 2020-10-15¶

This patch improves builds() and from_type() support for explicitly defined __signature__ attributes, from version 5.8.3, to support generic types from the python:typing module.

Thanks to Rónán Carrigan for identifying and fixing this problem!

5.37.2 - 2020-10-14¶

This patch fixes from_lark() with version 0.10.1+ of the lark-parser package.

5.37.1 - 2020-10-07¶

This patch fixes some broken links in the lark extra documentation.

5.37.0 - 2020-10-03¶

This release adds a new RedisExampleDatabase, along with the ReadOnlyDatabase and MultiplexedDatabase helpers, to support team workflows where failing examples can be seamlessly shared between everyone on the team - and your CI servers or buildbots.

5.36.2 - 2020-10-02¶

This patch ensures that if the “hypothesis” entry point is callable, we call it after importing it. You can still use non-callable entry points (like modules), which are only imported.

We also prefer importlib.metadata or the backport over pkg_resources, which makes import hypothesis around 200 milliseconds faster (issue #2571).

5.36.1 - 2020-09-25¶

This patch adds some helpful suggestions to error messages you might see while learning to use the @example() decorator (issue #2611) or the one_of() strategy.

5.36.0 - 2020-09-24¶

This release upgrades the from_dtype() strategy to pass optional **kwargs to the inferred strategy, and upgrades the arrays() strategy to accept an elements=kwargs dict to pass through to from_dtype().

arrays(floating_dtypes(), shape, elements={"min_value": -10, "max_value": 10}) is a particularly useful pattern, as it allows for any floating dtype without triggering the roundoff warning for smaller types or sacrificing variety for larger types (issue #2552).

5.35.4 - 2020-09-21¶

This patch reformats our code with the latest black to take advantage of the support for magic trailing commas.

5.35.3 - 2020-09-15¶

This release significantly improves the performance of Hypothesis’s internal implementation of automaton learning. However this code does not run as part of the user-accessible API so this has no user-visible impact.

5.35.2 - 2020-09-14¶

This patch ensures that, when the generate phases is disabled, we can replay up to max_examples examples from the database - which is very useful when using Hypothesis with a fuzzer.

Thanks to Afrida Tabassum for fixing issue #2585!

5.35.1 - 2020-09-14¶

This patch changes some internal python:struct.Struct.format strings from bytes to str, to avoid python:BytesWarning when running python -bb.

Thanks to everyone involved in pytest-xdist issue 596, bpo-16349, bpo-21071, and bpo-41777 for their work on this - it was a remarkably subtle issue!

5.35.0 - 2020-09-11¶

The target() function now accepts integers as well as floats.

5.34.1 - 2020-09-11¶

This patch adds explicit Optional annotations to our public API, to better support users who run mypy with --strict or no_implicit_optional=True.

Thanks to Krzysztof Przybyła for bringing this to our attention and writing the patch!

5.34.0 - 2020-09-11¶

This release drops support for Python 3.5, which reached end of life upstream on 2020-09-13.

5.33.2 - 2020-09-09¶

This patch fixes a problem with builds() that was not able to generate valid data for annotated classes with constructors.

Thanks to Nikita Sobolev for fixing issue #2603!

5.33.1 - 2020-09-07¶

This patch improves the error message from the hypothesis write command if black (required for the ghostwriter) is not installed.

Thanks to Nikita Sobolev for fixing issue #2604!

5.33.0 - 2020-09-06¶

When reporting failing examples, or tried examples in verbose mode, Hypothesis now identifies which were from @example(...) explicit examples.

5.32.1 - 2020-09-06¶

This patch contains some internal refactoring. Thanks to Felix Sheldon for fixing issue #2516!

5.32.0 - 2020-09-04¶

An array drawn from arrays() will own its own memory; previously most arrays returned by this strategy were views.

5.31.0 - 2020-09-04¶

builds() will use the __signature__ attribute of the target, if it exists, to retrieve type hints. Previously python:typing.get_type_hints(), was used by default. If argument names varied between the __annotations__ and __signature__, they would not be supplied to the target.

This was particularly an issue for pydantic models which use an alias generator.

5.30.1 - 2020-09-04¶

This patch makes the ghostwriter much more robust when passed unusual modules.

improved support for non-resolvable type annotations
magic() can now write equivalent() tests
running magic() on modules where some names in __all__ are undefined skips such names, instead of raising an error
magic() now knows to skip mocks
improved handling of import-time errors found by the ghostwriter CLI

5.30.0 - 2020-08-30¶

register_type_strategy() now supports python:typing.TypeVar, which was previously hard-coded, and allows a variety of types to be generated for an unconstrained TypeVar instead of just text().

Thanks again to Nikita Sobolev for all your work on advanced types!

5.29.4 - 2020-08-28¶

This release fixes some hard to trigger bugs in Hypothesis’s automata learning code. This code is only run as part of the Hypothesis build process, and not for user code, so this release has no user visible impact.

5.29.3 - 2020-08-27¶

This patch adds type annotations to the hypothesis.database module. There is no runtime change, but your typechecker might notice.

5.29.2 - 2020-08-27¶

This patch tracks some additional information in Hypothesis internals, and has no user-visible impact.

5.29.1 - 2020-08-27¶

This release fixes a bug in some Hypothesis internal support code for learning automata. This mostly doesn’t have any user visible impact, although it slightly affects the learned shrink passes so shrinking may be subtly different.

5.29.0 - 2020-08-24¶

This release adds support for Hypothesis integration via setuptools entry points, which allows for smoother integration of third-party Hypothesis extensions and external libraries. Unless you’re publishing a library with Hypothesis integration, you’ll probably only ever use this indirectly!

5.28.0 - 2020-08-24¶

from_type() can now resolve TypeVar instances when the bound is a ForwardRef, so long as that name is in fact defined in the same module as the typevar (no TYPE_CHECKING tricks, sorry). This feature requires Python 3.7 or later.

Thanks to Zac Hatfield-Dodds and Nikita Sobolev for this feature!

5.27.0 - 2020-08-20¶

This patch adds two new ghostwriters to test binary operations, like python:operator.add(), and Numpy ufuncs and gufuncs like np.matmul().

5.26.1 - 2020-08-19¶

This release improves the performance of some methods in Hypothesis’s internal automaton library. These are currently only lightly used by user code, but this may result in slightly faster shrinking.

5.26.0 - 2020-08-17¶

register_type_strategy() no longer accepts parametrised user-defined generic types, because the resolution logic was quite badly broken (issue #2537).

Instead of registering a strategy for e.g. MyCollection[int], you should register a function for MyCollection and inspect the type parameters within that function.

Thanks to Nikita Sobolev for the bug report, design assistance, and pull request to implement this feature!

5.25.0 - 2020-08-16¶

Tired of writing tests? Or new to Hypothesis and not sure where to start?

This release is for you! With our new Ghostwriter functions and hypothesis write ... command-line interface, you can stop writing tests entirely… or take the source code Hypothesis writes for you as a starting point.

This has been in the works for months, from issue #2118 to versions 5.18.3, 5.23.5, and 5.23.5 - particular thanks to the many people who reviewed pull requests or commented on demos, and to Timothy Crosley’s hypothesis-auto project for inspiration.

5.24.4 - 2020-08-14¶

This patch adds yet more internal functions to support a new feature we’re working on, like version 5.18.3 and version 5.23.6. We promise it’s worth the wait!

5.24.3 - 2020-08-13¶

This release fixes a small internal bug in Hypothesis’s internal automaton library. Fortunately this bug was currently impossible to hit in user facing code, so this has no user visible impact.

5.24.2 - 2020-08-12¶

This release improves shrink quality by allowing Hypothesis to automatically learn new shrink passes for difficult to shrink tests.

The automatic learning is not currently accessible in user code (it still needs significant work on robustness and performance before it is ready for that), but this release includes learned passes that should improve shrinking quality for tests which use any of the text(), floats(), datetimes(), emails(), and complex_numbers() strategies.

5.24.1 - 2020-08-12¶

This patch updates some docstrings, without changing runtime behaviour.

5.24.0 - 2020-08-10¶

The functions() strategy has a new argument pure=True, which ensures that the same return value is generated for identical calls to the generated function (issue #2538).

Thanks to Zac Hatfield-Dodds and Nikita Sobolev for this feature!

5.23.12 - 2020-08-10¶

This release removes a number of Hypothesis’s internal “shrink passes” - transformations it makes to a generated test case during shrinking - which appeared to be redundant with other transformations.

It is unlikely that you will see much impact from this. If you do, it will likely show up as a change in shrinking performance (probably slower, maybe faster), or possibly in worse shrunk results. If you encounter the latter, please let us know.

5.23.11 - 2020-08-04¶

This release fixes a bug in some internal Hypothesis support code. It has no user visible impact.

5.23.10 - 2020-08-04¶

This release improves the quality of shrunk test cases in some special cases. Specifically, it should get shrinking unstuck in some scenarios which require simultaneously changing two parts of the generated test case.

5.23.9 - 2020-08-03¶

This release improves the performance of some internal support code. It has no user visible impact, as that code is not currently run during normal Hypothesis operation.

5.23.8 - 2020-07-31¶

This release adds a heuristic to detect when shrinking has finished despite the fact that there are many more possible transformations to try. This will be particularly useful for tests where the minimum failing test case is very large despite there being many smaller test cases possible, where it is likely to speed up shrinking dramatically.

In some cases it is likely that this will result in worse shrunk test cases. In those cases rerunning the test will result in further shrinking.

5.23.7 - 2020-07-29¶

This release makes some performance improvements to shrinking. They should only be noticeable for tests that are currently particularly slow to shrink.

5.23.6 - 2020-07-29¶

This patch adds some more internal functions to support a new feature we’re working on, like version 5.18.3. There is still no user-visible change… yet.

5.23.5 - 2020-07-29¶

This release makes some changes to internal support code that is not currently used in production Hypothesis. It has no user visible effect at present.

5.23.4 - 2020-07-29¶

This release improves shrinking quality in some special cases.

5.23.3 - 2020-07-27¶

This release fixes issue #2507, where lazy evaluation meant that the values drawn from a sampled_from() strategy could depend on mutations of the sampled sequence that happened after the strategy was constructed.

5.23.2 - 2020-07-27¶

This patch fixes issue #2462, a bug in our handling of unittest.TestCase.subTest(). Thanks to Israel Fruchter for fixing this at the EuroPython sprints!

5.23.1 - 2020-07-26¶

This release improves the behaviour of the characters() strategy when shrinking, by changing which characters are considered smallest to prefer more “normal” ascii characters where available.

5.23.0 - 2020-07-26¶

The default print_blob setting is now smarter. It defaults to True in CI and False for local development.

Thanks to Hugo van Kemenade for implementing this feature at the EuroPython sprints!

5.22.0 - 2020-07-25¶

The slices() strategy can now generate slices for empty sequences, slices with negative start and stop indices (from the end of the sequence), and step=None in place of step=1.

Thanks to Sangarshanan for implementing this feature at the EuroPython sprints!

5.21.0 - 2020-07-23¶

This release ensures that tests which raise RecursionError are not reported as flaky simply because we run them from different initial stack depths (issue #2494).

5.20.4 - 2020-07-23¶

This release improves the performance of the sample method on objects obtained from randoms() when use_true_random=False. This should mostly only be noticeable when the sample size is a large fraction of the population size, but may also help avoid health check failures in some other cases.

5.20.3 - 2020-07-21¶

This release makes some internal changes for testing purposes and should have no user visible effect.

5.20.2 - 2020-07-18¶

This release fixes a small caching bug in Hypothesis internals that may under some circumstances have resulted in a less diverse set of test cases being generated than was intended.

Fixing this problem revealed some performance problems that could occur during targeted property based testing, so this release also fixes those. Targeted property-based testing should now be significantly faster in some cases, but this may be at the cost of reduced effectiveness.

5.20.1 - 2020-07-17¶

This patch updates our formatting to use isort 5. There is no user-visible change.

5.20.0 - 2020-07-17¶

The basic_indices() strategy can now generate bare indexers in place of length-one tuples. Thanks to Andrea for this patch!

5.19.3 - 2020-07-15¶

This patch removes an internal use of distutils in order to avoid this setuptools warning for some users.

5.19.2 - 2020-07-13¶

This patch contains a small internal refactoring with no user-visible impact.

Thanks to Andrea for writing this at the SciPy 2020 Sprints!

5.19.1 - 2020-07-12¶

This release slightly improves shrinking behaviour. This should mainly only impact stateful tests, but may have some minor positive impact on shrinking collections (lists, sets, etc).

5.19.0 - 2020-06-30¶

This release improves the randoms() strategy by adding support for Random instances where Hypothesis generates the random values rather than having them be “truly” random.

5.18.3 - 2020-06-27¶

This patch adds some internal functions to support a new feature we’re working on. There is no user-visible change… yet.

5.18.2 - 2020-06-26¶

This patch improves our docs for the derandomize setting.

5.18.1 - 2020-06-25¶

This release consists of some internal refactoring to the shrinker in preparation for future work. It has no user visible impact.

5.18.0 - 2020-06-22¶

This release teaches Hypothesis to shorten tracebacks for explicit examples, as we already do for generated examples, so that you can focus on your code rather than ours.

If you have multiple failing explicit examples, they will now all be reported. To report only the first failure, you can use the report_multiple_bugs=False setting as for generated examples.

5.17.0 - 2020-06-22¶

This patch adds strategy inference for the Literal, NewType, Type, DefaultDict, and TypedDict types from the typing_extensions backport on PyPI.

5.16.3 - 2020-06-21¶

This patch precomputes some of the setup logic for our external fuzzer integration and sets deadline=None in fuzzing mode, saving around 150us on each iteration.

This is around two-thirds the runtime to fuzz an empty test with @given(st.none()), and nice to have even as a much smaller fraction of the runtime for non-trivial tests.

5.16.2 - 2020-06-19¶

This patch fixes an internal error when warning about the use of function-scoped fixtures for parametrised tests where the parametrised value contained a % character. Thanks to Bryant for reporting and fixing this bug!

5.16.1 - 2020-06-10¶

If you pass a python:list or python:tuple where a strategy was expected, the error message now mentions sampled_from() as an example strategy.

Thanks to the enthusiastic participants in the PyCon Mentored Sprints who suggested adding this hint.

5.16.0 - 2020-05-27¶

functions() can now infer the appropriate returns strategy if you pass a like function with a return-type annotation. Before, omitting the returns argument would generate functions that always returned None.

5.15.1 - 2020-05-21¶

Fix from_type() with generic types under Python 3.9.

5.15.0 - 2020-05-19¶

This patch fixes an error that happens when multiple threads create new strategies.

5.14.0 - 2020-05-13¶

Passing min_magnitude=None to complex_numbers() is now deprecated - you can explicitly pass min_magnitude=0, or omit the argument entirely.

5.13.1 - 2020-05-13¶

This patch fixes an internal error in from_type() for python:typing.NamedTuple in Python 3.9. Thanks to Michel Salim for reporting and fixing issue #2427!

5.13.0 - 2020-05-12¶

This release upgrades the test statistics available via the –hypothesis-show-statistics option to include separate information on each of the phases (issue #1555).

5.12.2 - 2020-05-12¶

This patch teaches the from_type() internals to return slightly more efficient strategies for some generic sets and mappings.

5.12.1 - 2020-05-12¶

This patch adds a # noqa comment for flake8 3.8.0, which disagrees with mypy about how to write the type of ....

5.12.0 - 2020-05-10¶

This release limits the maximum duration of the shrinking phase to five minutes, so that Hypothesis does not appear to hang when making very slow progress shrinking a failing example (issue #2340).

If one of your tests triggers this logic, we would really appreciate a bug report to help us improve the shrinker for difficult but realistic workloads.

5.11.0 - 2020-05-07¶

This release improves the interaction between assume() and the @example() decorator, so that the following test no longer fails with UnsatisfiedAssumption (issue #2125):

@given(value=floats(0, 1))
@example(value=0.56789)  # used to make the test fail!
@pytest.mark.parametrize("threshold", [0.5, 1])
def test_foo(threshold, value):
    assume(value < threshold)
    ...

5.10.5 - 2020-05-04¶

If you have django installed but don’t use it, this patch will make import hypothesis a few hundred milliseconds faster (e.g. 0.704s -> 0.271s).

Thanks to importtime-waterfall for highlighting this problem and Jake Vanderplas for the solution - it’s impossible to misuse code from a module you haven’t imported!

5.10.4 - 2020-04-24¶

This patch improves the internals of builds() type inference, to handle recursive forward references in certain dataclasses. This is useful for e.g. hypothesmith’s forthcoming LibCST mode.

5.10.3 - 2020-04-22¶

This release reverses the order in which some operations are tried during shrinking. This should generally be a slight performance improvement, but most tests are unlikely to notice much difference.

5.10.2 - 2020-04-22¶

This patch fixes issue #2406, where use of pandas:pandas.Timestamp objects as bounds for the datetimes() strategy caused an internal error. This bug was introduced in version 5.8.1.

5.10.1 - 2020-04-19¶

This release is a small internal refactoring to how shrinking interacts with targeted property-based testing that should have no user user visible impact.

5.10.0 - 2020-04-18¶

This release improves our support for datetimes and times around DST transitions.

times() and datetimes() are now sometimes generated with fold=1, indicating that they represent the second occurrence of a given wall-time when clocks are set backwards. This may be set even when there is no transition, in which case the fold value should be ignored.

For consistency, timezones provided by the pytz package can now generate imaginary times (such as the hour skipped over when clocks ‘spring forward’ to daylight saving time, or during some historical timezone transitions). All other timezones have always supported generation of imaginary times.

If you prefer the previous behaviour, datetimes() now takes an argument allow_imaginary which defaults to True but can be set to False for any timezones strategy.

5.9.1 - 2020-04-16¶

This patch fixes the rendering of binary() docstring by using the proper backticks syntax.

5.9.0 - 2020-04-15¶

Failing tests which use target() now report the highest score observed for each target alongside the failing example(s), even without explicitly showing test statistics.

This improves the debugging workflow for tests of accuracy, which assert that the total imprecision is within some error budget - for example, abs(a - b) < 0.5. Previously, shrinking to a minimal failing example could often make errors seem smaller or more subtle than they really are (see the threshold problem, and issue #2180).

5.8.6 - 2020-04-15¶

This patch improves the docstring of binary(), the python:repr() of sampled_from() on an python:enum.Enum subclass, and a warning in our pytest plugin. There is no change in runtime behaviour.

5.8.5 - 2020-04-15¶

This release (potentially very significantly) improves the performance of failing tests in some rare cases, mostly only relevant when using targeted property-based testing, by stopping further optimisation of unrelated test cases once a failing example is found.

5.8.4 - 2020-04-14¶

This release fixes issue #2395, where under some circumstances targeted property-based testing could cause Hypothesis to get caught in an infinite loop.

5.8.3 - 2020-04-12¶

This patch teaches builds() and from_type() to use the __signature__ attribute of classes where it has been set, improving our support for Pydantic models (in pydantic >= 1.5).

5.8.2 - 2020-04-12¶

This release improves the performance of the part of the core engine that deliberately generates duplicate values.

5.8.1 - 2020-04-12¶

This patch improves dates() shrinking, to simplify year, month, and day like datetimes() rather than minimizing the number of days since 2000-01-01.

5.8.0 - 2020-03-24¶

This release adds a .hypothesis.fuzz_one_input attribute to @given tests, for easy integration with external fuzzers such as python-afl (supporting issue #171).

5.7.2 - 2020-03-24¶

This patch fixes issue #2341, ensuring that the printed output from a stateful test cannot use variable names before they are defined.

5.7.1 - 2020-03-23¶

This patch fixes issue #2375, preventing incorrect failure when a function scoped fixture is overridden with a higher scoped fixture.

5.7.0 - 2020-03-19¶

This release allows the array_dtypes() strategy to generate Numpy dtypes which have field titles in addition to field names. We expect this to expose latent bugs where code expects that set(dtype.names) == set(dtype.fields), though the latter may include titles.

5.6.1 - 2020-03-18¶

This makes model a positional-only argument to from_model(), to support models with a field literally named “model” (issue #2369).

5.6.0 - 2020-02-29¶

This release adds an explicit warning for tests that are both decorated with @given(...) and request a function-scoped pytest fixture, because such fixtures are only executed once for all Hypothesis test cases and that often causes trouble (issue #377).

It’s very difficult to fix this on the pytest side, so since 2015 our advice has been “just don’t use function-scoped fixtures with Hypothesis”. Now we detect and warn about the issue at runtime!

5.5.5 - 2020-02-29¶

This release cleans up the internal machinery for Stateful testing, after we dropped the legacy APIs in Hypothesis 5.0 (issue #2218). There is no user-visible change.

5.5.4 - 2020-02-16¶

This patch fixes issue #2351, arrays() would raise a confusing error if we inferred a strategy for datetime64 or timedelta64 values with varying time units.

We now infer an internally-consistent strategy for such arrays, and have a more helpful error message if an inconsistent strategy is explicitly specified.

5.5.3 - 2020-02-14¶

This patch improves the signature of builds() by specifying target as a positional-only argument on Python 3.8 (see PEP 570). The semantics of builds() have not changed at all - this just clarifies the documentation.

5.5.2 - 2020-02-13¶

This release makes Hypothesis faster at generating test cases that contain duplicated values in their inputs.

5.5.1 - 2020-02-07¶

This patch has some tiny internal code clean-ups, with no user-visible change.

5.5.0 - 2020-02-07¶

Our style guide suggests that optional parameters should usually be keyword-only arguments (see PEP 3102) to prevent confusion based on positional arguments - for example, hypothesis.strategies.floats() takes up to four boolean flags and many of the Numpy strategies have both dims and side bounds.

This release converts most optional parameters in our API to use keyword-only arguments - and adds a compatibility shim so you get warnings rather than errors everywhere (issue #2130).

5.4.2 - 2020-02-06¶

This patch fixes compatibility with Python 3.5.2 (issue #2334). Note that we only test the latest patch of each minor version, though as in this case we usually accept pull requests for older patch versions.

5.4.1 - 2020-02-01¶

This patch improves the repr of from_type(), so that in most cases it will display the strategy it resolves to rather than from_type(...). The latter form will continue to be used where resolution is not immediately successful, e.g. invalid arguments or recursive type definitions involving forward references.

5.4.0 - 2020-01-30¶

This release removes support for Python 3.5.0 and 3.5.1, where the python:typing module was quite immature (e.g. missing overload() and Type).

Note that Python 3.5 will reach its end-of-life in September 2020, and new releases of Hypothesis may drop support somewhat earlier.

Note

pip install hypothesis should continue to give you the latest compatible version. If you have somehow ended up with an incompatible version, you need to update your packaging stack to pip >= 9.0 and setuptools >= 24.2 - see here for details. Then pip uninstall hypothesis && pip install hypothesis will get you back to a compatible version.

5.3.1 - 2020-01-26¶

This patch does some minor internal cleanup; there is no user-visible change.

5.3.0 - 2020-01-21¶

The standard library ipaddress module is new in Python 3, and this release adds the new ip_addresses() strategy to generate IPv4Addresses and/or IPv6Addresses (depending on the v and network arguments).

If you use them in type annotations, from_type() now has strategies registered for ipaddress address, network, and interface types.

The provisional strategies for IP address strings are therefore deprecated.

5.2.1 - 2020-01-21¶

This patch reverts version 5.2, due to a strange issue where indexing an array of strings can raise an error instead of returning an item which contains certain surrogate characters.

5.2.0 - 2020-01-19¶

This release allows from_dtype() to generate Unicode strings which cannot be encoded in UTF-8, but are valid in Numpy arrays (which use UTF-32).

5.1.6 - 2020-01-19¶

This patch fixes issue #2320, where from_type(Set[Hashable]) could raise an internal error because Decimal("snan") is of a hashable type, but raises an error when hashed. We now ensure that set elements and dict keys in generic types can actually be hashed.

5.1.5 - 2020-01-12¶

This patch fixes an internal error when running in an IPython repl or Jupyter notebook on Windows (issue #2319), and an internal error on Python 3.5.1 (issue #2318).

5.1.4 - 2020-01-11¶

This patch fixes a bug where errors in third-party extensions such as hypothesis-trio or hypothesis-jsonschema were incorrectly considered to be Hypothesis internal errors, which could result in confusing error messages.

Thanks to Vincent Michel for reporting and fixing the bug!

5.1.3 - 2020-01-11¶

This release converts the type hint comments on our public API to PEP 484 type annotations.

Thanks to Ivan Levkivskyi for com2ann - with the refactoring tools from 5.0.1 it made this process remarkably easy!

5.1.2 - 2020-01-09¶

This patch makes multiple() iterable, so that output like a, b = state.some_rule() is actually executable and can be used to reproduce failing examples.

Thanks to Vincent Michel for reporting and fixing issue #2311!

5.1.1 - 2020-01-06¶

This patch contains many small refactorings to replace our Python 2 compatibility functions with their native Python 3 equivalents. Since Hypothesis is now Python 3 only, there is no user-visible change.

5.1.0 - 2020-01-03¶

This release teaches from_type() how to generate python:datetime.timezone. As a result, you can now generate python:datetime.tzinfo objects without having pytz installed.

If your tests specifically require pytz timezones, you should be using hypothesis.extra.pytz.timezones() instead of st.from_type(tzinfo).

5.0.1 - 2020-01-01¶

This patch contains mostly-automated refactorings to remove code that we only needed to support Python 2. Since Hypothesis is now Python 3 only (hurray!), there is no user-visible change.

Our sincere thanks to the authors of autoflake, black, isort, and pyupgrade, who have each and collectively made this kind of update enormously easier.

5.0.0 - 2020-01-01¶

Welcome to the next major version of Hypothesis!

There are no new features here, as we release those in minor versions. Instead, 5.0 is a chance for us to remove deprecated features (many already converted into no-ops), and turn a variety of warnings into errors.

If you were running on the last version of Hypothesis 4.x without any Hypothesis deprecation warnings, this will be a very boring upgrade. In fact, nothing will change for you at all.

Note

This release drops support for Python 2, which has passed its end of life date. The Python 3 Statement outlines our reasons, and lists many other packages that have made the same decision.

pip install hypothesis should continue to give you the latest compatible version. If you have somehow ended up with Hypothesis 5.0 on Python 2, you need to update your packaging stack to pip >= 9.0 and setuptools >= 24.2 - see here for details. Then pip uninstall hypothesis && pip install hypothesis will get you back to a compatible version.

Strategies¶

integers() bounds must be equal to an integer, though they can still be other types.
If fractions() is passed a max_denominator, the bounds must have at most that denominator.
floats() bounds must be exactly representable as a floating-point number with the given width. If not, the error message includes the nearest such number.
sampled_from([]) is now an error.
The values from the elements and fill strategies for hypothesis.extra.numpy.arrays() must be losslessly representable in an array of the given dtype.
The min_size and max_size arguments to all collection strategies must be of type python:int (or max_size may be None).

Miscellaneous¶

The .example() method of strategies (intended for interactive exploration) no longer takes a random argument.
It is now an error to apply @example, @seed, or @reproduce_failure without also applying @given.
You may pass either the target or targets argument to stateful rules, but not both.
deadline must be None (to disable), a timedelta, or an integer or float number of milliseconds.
Both of derandomize and print_blob must be either True or False, where they previously accepted other values.
stateful_step_count must be at least one.
max_examples must be at least one. To disable example generation, use the phases setting.

Removals¶

hypothesis.stateful.GenericStateMachine in favor of hypothesis.stateful.RuleBasedStateMachine
hypothesis.extra.django.models.models in favor of hypothesis.extra.django.from_model() and hypothesis.extra.django.models.add_default_field_mapping in favor of hypothesis.extra.django.register_field_strategy()
hypothesis.HealthCheck.hung_test, without replacement
hypothesis.settings.buffer, without replacement
hypothesis.PrintSettings, because hypothesis.settings.print_blob takes True or False
hypothesis.settings.timeout, in favor of hypothesis.settings.deadline
hypothesis.unlimited without replacement (only only useful as argument to timeout)

Hypothesis 4.x¶

4.57.1 - 2019-12-29¶

This patch improves the type hints and documentation for the django extra. There is no runtime change.

4.57.0 - 2019-12-28¶

This release improves support for the SupportsOp protocols from the python:typing module when using on from_type() as outlined in issue #2292. The following types now generate much more varied strategies when called with from_type():

python:typing.SupportsAbs
python:typing.SupportsBytes
python:typing.SupportsComplex
python:typing.SupportsInt
python:typing.SupportsFloat
python:typing.SupportsRound

Note that using from_type() with one of the above strategies will not ensure that the the specified function will execute successfully (ie : the strategy returned for from_type(typing.SupportsAbs) may include NaNs or things which cause the python:abs() function to error. )

Thanks to Lea Provenzano for this patch.

4.56.3 - 2019-12-22¶

This release fixes a small internal bug in shrinking which could have caused it to perform slightly more tests than were necessary. Fixing this shouldn’t have much effect but it will make shrinking slightly faster.

4.56.2 - 2019-12-21¶

This release removes an internal heuristic that was no longer providing much benefit. It is unlikely that there will be any user visible effect.

4.56.1 - 2019-12-19¶

This release further improves the optimisation algorithm for targeted property-based testing.

4.56.0 - 2019-12-18¶

This release enables deprecation warnings even when the verbosity setting is quiet, in preparation for Hypothesis 5.0 (issue #2218).

Warnings can still be filtered by the standard mechanisms provided in the standard-library python:warnings module.

4.55.4 - 2019-12-18¶

This release improves Hypothesis’s management of the set of test cases it tracks between runs. It will only do anything if you have the target phase enabled and an example database set. In those circumstances it should result in a more thorough and faster set of examples that are tried on each run.

4.55.3 - 2019-12-18¶

This release makes Hypothesis better at generating test cases where generated values are duplicated in different parts of the test case. This will be especially noticeable with reasonably complex values, as it was already able to do this for simpler ones such as integers or floats.

4.55.2 - 2019-12-17¶

This release expands the set of test cases that Hypothesis saves in its database for future runs to include a representative set of “structurally different” test cases - e.g. it might try to save test cases where a given list is empty or not.

Currently this is unlikely to have much user visible impact except to produce slightly more consistent behaviour between consecutive runs of a test suite. It is mostly groundwork for future improvements which will exploit this functionality more effectively.

4.55.1 - 2019-12-16¶

This patch fixes issue #2257, where from_type() could incorrectly generate bytestrings when passed a generic python:typing.Sequence such as Sequence[set].

4.55.0 - 2019-12-16¶

This release adds database support for targeted property-based testing, so the best examples based on the targeting will be saved and reused between runs. This is mostly laying groundwork for future features in this area, but will also make targeted property-based tests more useful during development, where the same tests tend to get run over and over again.

If max_examples is large, this may increase memory usage significantly under some circumstances, but these should be relatively rare.

This release also adds a dependency on the sortedcontainers package.

4.54.2 - 2019-12-16¶

This release improves the optimisation algorithm for targeted property-based testing, so that it will find higher quality results more reliably. Specifically, in cases where it would previously have got near a local optimum, it will now tend to achieve the locally optimal value.

4.54.1 - 2019-12-16¶

This release is mostly internal changes in support of better testing of the core engine. You are unlikely to see much effect, although some internal heuristics have changed slightly.

4.54.0 - 2019-12-15¶

This release adds a dedicated phase for targeted property-based testing, and (somewhat) improves the targeting algorithm so that it will find higher quality results more reliably. This comes at a cost of making it more likely to get stuck in a local optimum.

4.53.3 - 2019-12-15¶

This patch fixes from_type() with python:typing.Hashable and python:typing.Sized, which previously failed with an internal error on Python 3.7 or later.

Thanks to Lea Provenzano for both reporting issue #2272 and writing the patch!

4.53.2 - 2019-12-11¶

This release reorganises a number of the Hypothesis internal modules into a package structure. If you are only depending on the public API it should have no effect. If you are depending on the internal API (which you shouldn’t be, and which we don’t guarantee compatibility on) you may have to rename some imports.

4.53.1 - 2019-12-09¶

This release changes the size distribution of the number of steps run in stateful testing: It will now almost always run the maximum number of steps permitted.

4.53.0 - 2019-12-09¶

Test statistics now include the best score seen for each label, which can help avoid the threshold problem when the minimal example shrinks right down to the threshold of failure (issue #2180).

4.52.0 - 2019-12-09¶

This release changes the stateful_step_count setting to raise an error if set to 0. This is a backwards compatible change because a value of 0 would never have worked and attempting to run it would have resulted in an internal assertion error.

4.51.1 - 2019-12-09¶

This release makes a small internal change to the distribution of test cases. It is unlikely to have much user visible impact.

4.51.0 - 2019-12-07¶

This release deprecates use of @example, @seed, or @reproduce_failure without @given.

Thanks to Nick Anyos for the patch!

4.50.8 - 2019-12-05¶

This patch makes certain uses of Bundles more efficient in stateful testing (issue #2078).

4.50.7 - 2019-12-05¶

This release refactors some of Hypothesis’s internal interfaces for representing data generation. It should have no user visible effect.

4.50.6 - 2019-12-02¶

This patch removes some old debugging helpers in our Numpy extra which have not been needed since issue #1963 and issue #2245.

4.50.5 - 2019-12-01¶

This patch fixes issue #2229, where Numpy arrays of unsized strings would only ever have strings of size one due to an interaction between our generation logic and Numpy’s allocation strategy.

4.50.4 - 2019-12-01¶

This patch fixes a rare internal error in strategies for a list of unique items sampled from a short non-unique sequence (issue #2247). The bug was discovered via hypothesis-jsonschema.

4.50.3 - 2019-12-01¶

This release improves the error message when @settings tries to inherit settings from a parent argument that isn’t a settings instance.

4.50.2 - 2019-11-29¶

This release improves Hypothesis’s “Falsifying example” output, by breaking output across multiple lines where necessary, and by removing irrelevant information from the stateful testing output.

4.50.1 - 2019-11-29¶

This patch adds flake8-comprehensions to our linter suite. There is no user-visible change - expect perhaps via some strange microbenchmarks - but certain parts of the code now have a clear and more consistent style.

4.50.0 - 2019-11-28¶

This release fixes some cases where we might previously have failed to run the validation logic for some strategies. As a result tests which would previously have been silently testing significantly less than they should may now start to raise InvalidArgument now that these errors are caught.

4.49.0 - 2019-11-28¶

This release significantly improves the data distribution in rule based stateful testing, by using a technique called Swarm Testing (Groce, Alex, et al. “Swarm testing.” Proceedings of the 2012 International Symposium on Software Testing and Analysis. ACM, 2012.) to select which rules are run in any given test case. This should allow it to find many issues that it would previously have missed.

This change is likely to be especially beneficial for stateful tests with large numbers of rules.

4.48.1 - 2019-11-28¶

This release adds some heuristics to test case generation that try to ensure that test cases generated early on will be relatively small.

This fixes a bug introduced in Hypothesis 4.42.0 which would cause occasional too_slow failures on some tests.

4.48.0 - 2019-11-28¶

This release revokes the deprecation of find, as we’ve now rebuilt it on top of @given, which means it has minimal maintenance burden and we’re happy to support it.

4.47.5 - 2019-11-28¶

This release rebuilds find() on top of @given in order to have more code in common. It should have minimal user visible effect.

4.47.4 - 2019-11-27¶

This patch removes an internal compatibility shim that we no longer need.

4.47.3 - 2019-11-26¶

This patch fixes several typos in our docstrings and comments, with no change in behaviour. Thanks to Dmitry Dygalo for identifying and fixing them!

4.47.2 - 2019-11-25¶

This release fixes an internal issue where Hypothesis would sometimes generate test cases that were above its intended maximum size. This would only have happened rarely and probably would not have caused major problems when it did.

Users of the new targeted property-based testing might see minor impact (possibly slightly faster tests and slightly worse target scores), but only in the unlikely event that they were hitting this problem. Other users should not see any effect at all.

4.47.1 - 2019-11-24¶

This release removes some unused code from the core engine. There is no user-visible change.

4.47.0 - 2019-11-24¶

This release commonizes some code between running explicit examples and normal test execution. The main user visible impact of this is that deadlines are now enforced when running explicit examples.

4.46.1 - 2019-11-23¶

This patch ensures that a KeyboardInterrupt received during example generation is not treated as a mystery test failure but instead propagates to the top level, not recording the interrupted generation in the conjecture data tree. Thanks to Anne Archibald for identifying and fixing the problem.

4.46.0 - 2019-11-22¶

This release changes the behaviour of floats() when excluding signed zeros - floats(max_value=0.0, exclude_max=True) can no longer generate -0.0 nor the much rarer floats(min_value=-0.0, exclude_min=True) generate +0.0.

The correct interaction between signed zeros and exclusive endpoints was unclear; we now enforce the invariant that floats() will never generate a value equal to an excluded endpoint (issue #2201).

If you prefer the old behaviour, you can pass floats(max_value=-0.0) or floats(min_value=0.0) which is exactly equivalent and has not changed. If you had two endpoints equal to zero, we recommend clarifying your tests by using just() or sampled_from() instead of floats().

4.45.1 - 2019-11-20¶

This patch improves the error message when invalid arguments are passed to rule() or invariant() (issue #2149).

Thanks to Benjamin Palmer for this bugfix!

4.45.0 - 2019-11-20¶

This release supports python:typing.Final and python:typing.TypedDict in from_type().

4.44.5 - 2019-11-20¶

This patch disables our pytest plugin when running on versions of pytest before 4.3, the oldest our plugin supports. Note that at time of writing the Pytest developers only support 4.6 and later!

Hypothesis tests using @given() work on any test runner, but our integrations to e.g. avoid example database collisions when combined with @pytest.mark.parametrize eventually drop support for obsolete versions.

4.44.4 - 2019-11-20¶

This patch adds some internal comments and clarifications to the Hypothesis implementation. There is no user-visible change.

4.44.3 - 2019-11-20¶

This patch avoids importing test runners such as pytest, unittest2, or nose solely to access their special “skip test” exception types - if the module is not in sys.modules, the exception can’t be raised anyway.

This fixes a problem where importing an otherwise unused module could cause spurious errors due to import-time side effects (and possibly -Werror).

4.44.2 - 2019-11-12¶

This release fixes @given to only complain about missing keyword-only arguments if the associated test function is actually called.

This matches the behaviour of other InvalidArgument errors produced by @given.

4.44.1 - 2019-11-11¶

This patch allows Hypothesis to run in environments that do not specify a __file__, such as a python:zipapp (issue #2196).

4.44.0 - 2019-11-11¶

This release adds a signature argument to mutually_broadcastable_shapes() (issue #2174), which allows us to generate shapes which are valid for functions like np.matmul() that require shapes which are not simply broadcastable.

Thanks to everyone who has contributed to this feature over the last year, and a particular shout-out to Zac Hatfield-Dodds and Ryan Soklaski for mutually_broadcastable_shapes() and to Ryan Turner for the downstream hypothesis-gufunc project.

4.43.9 - 2019-11-11¶

This patch fixes issue #2108, where the first test using data() to draw from characters() or text() would be flaky due to unreliable test timings.

Time taken by lazy instantiation of strategies is now counted towards drawing from the strategy, rather than towards the deadline for the test function.

4.43.8 - 2019-11-08¶

This release ensures that the strategies passed to @given are properly validated when applied to a test method inside a test class.

This should result in clearer error messages when some of those strategies are invalid.

4.43.7 - 2019-11-08¶

This release changes how Hypothesis manages its search space in cases where it generates redundant data. This should cause it to generate significantly fewer duplicated examples (especially with short integer ranges), and may cause it to produce more useful examples in some cases (especially ones where there is a significant amount of filtering).

4.43.6 - 2019-11-07¶

This patch refactors width handling in floats(); you may notice small performance improvements but the main purpose is to enable work on issue #1704 (improving shrinking of bounded floats).

4.43.5 - 2019-11-06¶

This patch removes an unused internal flag. There is no user-visible change.

4.43.4 - 2019-11-05¶

This patch corrects the exception type and error message you get if you attempt to use data() to draw from something which is not a strategy. This never worked, but the error is more helpful now.

4.43.3 - 2019-11-05¶

We’ve adopted flake8-bugbear to check for a few more style issues, and this patch implements the minor internal cleanups it suggested. There is no user-visible change.

4.43.2 - 2019-11-05¶

This patch fixes the formatting of some documentation, but there is no change to any executed code.

4.43.1 - 2019-11-04¶

Python 3.8’s new python:typing.Literal type - see PEP 586 for details - is now supported in from_type().

4.43.0 - 2019-11-04¶

This release adds the strategy mutually_broadcastable_shapes(), which generates multiple array shapes that are mutually broadcast-compatible with an optional user-specified base-shape.

This is a generalisation of broadcastable_shapes(). It relies heavily on non-public internals for performance when generating and shrinking examples. We intend to support generating shapes matching a ufunc signature in a future version (issue #2174).

Thanks to Ryan Soklaski, Zac Hatfield-Dodds, and @rdturnermtl who contributed to this new feature.

4.42.10 - 2019-11-03¶

This release fixes from_type() when used with bounded or constrained python:typing.TypeVar objects (issue #2094).

Previously, distinct typevars with the same constraints would be treated as all single typevar, and in cases where a typevar bound was resolved to a union of subclasses this could result in mixed types being generated for that typevar.

4.42.9 - 2019-11-03¶

This patch ensures that the default value broadcastable_shapes() chooses for max_dims is always valid (at most 32), even if you pass min_dims=32.

4.42.8 - 2019-11-02¶

This patch ensures that we only add profile information to the pytest header if running either pytest or Hypothesis in verbose mode, matching the builtin cache plugin (issue #2155).

4.42.7 - 2019-11-02¶

This patch makes stateful step printing expand the result of a step into multiple variables when you return multiple() (issue #2139). Thanks to Joseph Weston for reporting and fixing this bug!

4.42.6 - 2019-11-02¶

This release fixes a bug (issue #2166) where a Unicode character info cache file was generated but never used on subsequent test runs, causing tests to run more slowly than they should have.

Thanks to Robert Knight for this bugfix!

4.42.5 - 2019-11-01¶

This patch corrects some internal documentation. There is no user-visible change.

4.42.4 - 2019-11-01¶

This release fixes a bug (issue #2160) where decorators applied after @settings and before @given were ignored.

Thanks to Tom Milligan for this bugfix!

4.42.3 - 2019-10-30¶

This release updates Hypothesis’s formatting to the new version of black, and has absolutely no user visible effect.

4.42.2 - 2019-10-30¶

This release fixes a bug in recursive() which would have meant that in practice max_leaves was treated as if it was lower than it actually is - specifically it would be capped at the largest power of two smaller than it. It is now handled correctly.

4.42.1 - 2019-10-30¶

Python 3.8’s new python:typing.SupportsIndex type - see PEP 357 for details - is now supported in from_type().

Thanks to Grigorios Giannakopoulos for the patch!

4.42.0 - 2019-10-27¶

This release significantly simplifies Hypothesis’s internal logic for data generation, by removing a number of heuristics of questionable or unproven value.

The results of this change will vary significantly from test to test. Most test suites will see significantly faster data generation and lower memory usage. The “quality” of the generated data may go up or down depending on your particular test suites.

If you see any significant regressions in Hypothesis’s ability to find bugs in your code as a result of this release, please file an issue to let us know.

Users of the new targeted property-based testing functionality are reasonably likely to see improvements in data generation, as this release changes the search algorithm for targeted property based testing to one that is more likely to be productive than the existing approach.

4.41.3 - 2019-10-21¶

This patch is to ensure that our internals remain comprehensible to mypy 0.740 - there is no user-visible change.

4.41.2 - 2019-10-17¶

This patch changes some internal hashes to SHA384, to better support users subject to FIPS-140. There is no user-visible API change.

Thanks to Paul Kehrer for this contribution!

4.41.1 - 2019-10-16¶

This release makes --hypothesis-show-statistics much more useful for tests using a RuleBasedStateMachine, by simplifying the reprs so that events are aggregated correctly.

4.41.0 - 2019-10-16¶

This release upgrades the fixed_dictionaries() strategy to support optional keys (issue #1913).

4.40.2 - 2019-10-16¶

This release makes some minor internal changes in support of improving the Hypothesis test suite. It should not have any user visible impact.

4.40.1 - 2019-10-14¶

This release changes how Hypothesis checks if a parameter to a test function is a mock object. It is unlikely to have any noticeable effect, but may result in a small performance improvement, especially for test functions where a mock object is being passed as the first argument.

4.40.0 - 2019-10-09¶

This release fixes a bug where our example database logic did not distinguish between failing examples based on arguments from a @pytest.mark.parametrize(...). This could in theory cause data loss if a common failure overwrote a rare one, and in practice caused occasional file-access collisions in highly concurrent workloads (e.g. during a 300-way parametrize on 16 cores).

For internal reasons this also involves bumping the minimum supported version of pytest to 4.3

Thanks to Peter C Kroon for the Hacktoberfest patch!

4.39.3 - 2019-10-09¶

This patch improves our type hints on the emails(), functions(), integers(), iterables(), and slices() strategies, as well as the .filter() method.

There is no runtime change, but if you use mypy or a similar type-checker on your tests the results will be a bit more precise.

4.39.2 - 2019-10-09¶

This patch improves the performance of unique collections such as sets() of just() or booleans() strategies. They were already pretty good though, so you’re unlikely to notice much!

4.39.1 - 2019-10-09¶

If a value in a dict passed to fixed_dictionaries() is not a strategy, Hypothesis now tells you which one.

4.39.0 - 2019-10-07¶

This release adds the basic_indices() strategy, to generate basic indexes for arrays of the specified shape (issue #1930).

It generates tuples containing some mix of integers, python:slice objects, ... (Ellipsis), and numpy:numpy.newaxis; which when used to index an array of the specified shape produce either a scalar or a shared-memory view of the array. Note that the index tuple may be longer or shorter than the array shape, and may produce a view with another dimensionality again!

Thanks to Lampros Mountrakis, Ryan Soklaski, and Zac Hatfield-Dodds for their collaboration on this surprisingly subtle strategy!

4.38.3 - 2019-10-04¶

This patch defers creation of the .hypothesis directory until we have something to store in it, meaning that it will appear when Hypothesis is used rather than simply installed.

Thanks to Peter C Kroon for the Hacktoberfest patch!

4.38.2 - 2019-10-02¶

This patch bumps our dependency on attrs to >=19.2.0; but there are no user-visible changes to Hypothesis.

4.38.1 - 2019-10-01¶

This is a comment-only patch which tells mypy 0.730 to ignore some internal compatibility shims we use to support older Pythons.

4.38.0 - 2019-10-01¶

This release adds the hypothesis.target() function, which implements targeted property-based testing (issue #1779).

By calling target() in your test function, Hypothesis can do a hill-climbing search for bugs. If you can calculate a suitable metric such as the load factor or length of a queue, this can help you find bugs with inputs that are highly improbably from unguided generation - however good our heuristics, example diversity, and deduplication logic might be. After all, those features are at work in targeted PBT too!

4.37.0 - 2019-09-28¶

This release emits a warning if you use the .example() method of a strategy in a non-interactive context.

given() is a much better choice for writing tests, whether you care about performance, minimal examples, reproducing failures, or even just the variety of inputs that will be tested!

4.36.2 - 2019-09-20¶

This patch disables part of the typing-based inference for the attrs package under Python 3.5.0, which has some incompatible internal details (issue #2095).

4.36.1 - 2019-09-17¶

This patch fixes a bug in strategy inference for attrs classes where Hypothesis would fail to infer a strategy for attributes of a generic type such as Union[int, str] or List[bool] (issue #2091).

Thanks to Jonathan Gayvallet for the bug report and this patch!

4.36.0 - 2019-09-09¶

This patch deprecates min_len or max_len of 0 in byte_string_dtypes() and unicode_string_dtypes(). The lower limit is now 1.

Numpy uses a length of 0 in these dtypes to indicate an undetermined size, chosen from the data at array creation. However, as the arrays() strategy creates arrays before filling them, strings were truncated to 1 byte.

4.35.1 - 2019-09-09¶

This patch improves the messaging that comes from invalid size arguments to collection strategies such as lists().

4.35.0 - 2019-09-04¶

This release improves the from_lark() strategy, tightening argument validation and adding the explicit argument to allow use with terminals that use @declare instead of a string or regular expression.

This feature is required to handle features such as indent and dedent tokens in Python code, which can be generated with the hypothesmith package.

4.34.0 - 2019-08-23¶

The from_type() strategy now knows to look up the subclasses of abstract types, which cannot be instantiated directly.

This is very useful for hypothesmith to support libCST.

4.33.1 - 2019-08-21¶

This patch works around a crash when an incompatible version of Numpy is installed under PyPy 5.10 (Python 2.7).

If you are still using Python 2, please upgrade to Python 3 as soon as possible - it will be unsupported at the end of this year.

4.33.0 - 2019-08-20¶

This release improves the domains() strategy, as well as the urls() and the emails() strategies which use it. These strategies now use the full IANA list of Top Level Domains and are correct as per RFC 1035.

Passing tests using these strategies may now fail.

Thanks to TechDragon for this improvement.

4.32.3 - 2019-08-05¶

This patch tidies up the repr of several settings-related objects, at runtime and in the documentation, and deprecates the undocumented edge case that phases=None was treated like phases=tuple(Phase).

It also fixes from_lark() with lark 0.7.2 and later.

4.32.2 - 2019-07-30¶

This patch updates some internal comments for mypy 0.720. There is no user-visible impact.

4.32.1 - 2019-07-29¶

This release changes how the shrinker represents its progress internally. For large generated test cases this should result in significantly less memory usage and possibly faster shrinking. Small generated test cases may be slightly slower to shrink but this shouldn’t be very noticeable.

4.32.0 - 2019-07-28¶

This release makes arrays() more pedantic about elements strategies that cannot be exactly represented as array elements.

In practice, you will see new warnings if you were using a float16 or float32 dtype without passing floats() the width=16 or width=32 arguments respectively.

The previous behaviour could lead to silent truncation, and thus some elements being equal to an explicitly excluded bound (issue #1899).

4.31.1 - 2019-07-28¶

This patch changes an internal use of MD5 to SHA hashes, to better support users subject to FIPS-140. There is no user-visible or API change.

Thanks to Alex Gaynor for this patch.

4.31.0 - 2019-07-24¶

This release simplifies the logic of the print_blob setting by removing the option to set it to PrintSettings.INFER. As a result the print_blob setting now takes a single boolean value, and the use of PrintSettings is deprecated.

4.28.2 - 2019-07-14¶

This patch improves the docstrings of several Hypothesis strategies, by clarifying markup and adding cross-references. There is no runtime change.

Thanks to Elizabeth Williams and Serah Njambi Rono for their contributions at the SciPy 2019 sprints!

4.28.1 - 2019-07-12¶

This patch improves the behaviour of the text() strategy when passed an alphabet which is not a strategy. The value is now interpreted as whitelist_characters to characters() instead of a sequence for sampled_from(), which standardises the distribution of examples and the shrinking behaviour.

You can get the previous behaviour by using lists(sampled_from(alphabet)).map("".map) instead.

4.28.0 - 2019-07-11¶

This release deprecates find(). The .example() method is a better replacement if you want an example, and for the rare occasions where you want the minimal example you can get it from @given.

@given has steadily outstripped find() in both features and performance over recent years, and as we do not have the resources to maintain and test both we think it is better to focus on just one.

4.27.0 - 2019-07-08¶

This release refactors the implementation of the .example() method, to more accurately represent the data which will be generated by @given.

As a result, calling s.example() on an empty strategy s (such as nothing()) now raises Unsatisfiable instead of the old NoExamples exception.

4.26.4 - 2019-07-07¶

This patch ensures that the Pandas extra will keep working when Python 3.8 removes abstract base classes from the top-level python:collections namespace. This also fixes the relevant warning in Python 3.7, but there is no other difference in behaviour and you do not need to do anything.

4.26.3 - 2019-07-05¶

This release fixes issue #2027, by changing the way Hypothesis tries to generate distinct examples to be more efficient.

This may result in slightly different data distribution, and should improve generation performance in general, but should otherwise have minimal user impact.

4.26.2 - 2019-07-04¶

This release fixes issue #1864, where some simple tests would perform very slowly, because they would run many times with each subsequent run being progressively slower. They will now stop after a more reasonable number of runs without hitting this problem.

Unless you are hitting exactly this issue, it is unlikely that this release will have any effect, but certain classes of custom generators that are currently very slow may become a bit faster, or start to trigger health check failures.

4.26.1 - 2019-07-04¶

This release adds the strategy integer_array_indices(), which generates tuples of Numpy arrays that can be used for advanced indexing to select an array of a specified shape.

4.26.0 - 2019-07-04¶

This release significantly improves the performance of drawing unique collections whose elements are drawn from sampled_from() strategies.

As a side effect, this detects an error condition that would previously have passed silently: When the min_size argument on a collection with distinct elements is greater than the number of elements being sampled, this will now raise an error.

4.25.1 - 2019-07-03¶

This release removes some defunct internal functionality that was only being used for testing. It should have no user visible impact.

4.25.0 - 2019-07-03¶

This release deprecates and disables the buffer_size setting, which should have been treated as a private implementation detail all along. We recommend simply deleting this settings argument.

4.24.6 - 2019-06-26¶

This patch makes datetimes() more efficient, as it now handles short months correctly by construction instead of filtering.

4.24.5 - 2019-06-23¶

This patch improves the development experience by simplifying the tracebacks you will see when e.g. you have used the .map(...) method of a strategy and the mapped function raises an exception.

No new exceptions can be raised, nor existing exceptions change anything but their traceback. We’re simply using if-statements rather than exceptions for control flow in a certain part of the internals!

4.24.4 - 2019-06-21¶

This patch fixes issue #2014, where our compatibility layer broke with version 3.7.4 of the typing module backport on PyPI.

This issue only affects Python 2. We remind users that Hypothesis, like many other packages, will drop Python 2 support on 2020-01-01 and already has several features that are only available on Python 3.

4.24.3 - 2019-06-07¶

This patch improves the implementation of an internal wrapper on Python 3.8 beta1 (and will break on the alphas; but they’re not meant to be stable). On other versions, there is no change at all.

Thanks to Daniel Hahler for the patch, and Victor Stinner for his work on bpo-37032 that made it possible.

4.24.2 - 2019-06-06¶

Deprecation messages for functions in hypothesis.extra.django.models now explicitly name the deprecated function to make it easier to track down usages. Thanks to Kristian Glass for this contribution!

4.24.1 - 2019-06-04¶

This patch fixes issue #1999, a spurious bug raised when a @st.composite function was passed a keyword-only argument.

Thanks to Jim Nicholls for his fantastic bug report.

4.24.0 - 2019-05-29¶

This release deprecates GenericStateMachine, in favor of RuleBasedStateMachine. Rule-based stateful testing is significantly faster, especially during shrinking.

If your use-case truly does not fit rule-based stateful testing, we recommend writing a custom test function which drives your specific control-flow using data().

4.23.9 - 2019-05-28¶

This patch fixes a very rare example database issue with file permissions.

When running a test that uses both @given and pytest.mark.parametrize, using pytest-xdist on Windows, with failing examples in the database, two attempts to read a file could overlap and we caught FileNotFound but not other OSErrors.

4.23.8 - 2019-05-26¶

This patch has a minor cleanup of the internal engine. There is no user-visible impact.

4.23.7 - 2019-05-26¶

This patch clarifies some error messages when the test function signature is incompatible with the arguments to @given, especially when the @settings() decorator is also used (issue #1978).

4.23.6 - 2019-05-19¶

This release adds the pyupgrade fixer to our code style, for consistent use of dict and set literals and comprehensions.

4.23.5 - 2019-05-16¶

This release slightly simplifies a small part of the core engine. There is no user-visible change.

4.23.4 - 2019-05-09¶

Fixes a minor formatting issue the docstring of from_type()

4.23.3 - 2019-05-09¶

Adds a recipe to the docstring of from_type() that describes a means for drawing values for “everything except” a specified type. This recipe is especially useful for writing tests that perform input-type validation.

4.23.2 - 2019-05-08¶

This patch uses autoflake to remove some pointless pass statements, which improves our workflow but has no user-visible impact.

4.23.1 - 2019-05-08¶

This patch fixes an OverflowError in from_type(xrange) on Python 2.

It turns out that not only do the start and stop values have to fit in a C long, but so does stop - start. We now handle this even on 32bit platforms, but remind users that Python2 will not be supported after 2019 without specific funding.

4.23.0 - 2019-05-08¶

This release implements the slices() strategy, to generate slices of a length-size sequence.

Thanks to Daniel J. West for writing this patch at the PyCon 2019 sprints!

4.22.3 - 2019-05-07¶

This patch exposes DataObject, solely to support more precise type hints. Objects of this type are provided by data(), and can be used to draw examples from strategies intermixed with your test code.

4.22.2 - 2019-05-07¶

This patch fixes the very rare issue #1798 in array_dtypes(), which caused an internal error in our tests.

4.22.1 - 2019-05-07¶

This patch fixes a rare bug in from_type(range).

Thanks to Zebulun Arendsee for fixing the bug at the PyCon 2019 Sprints.

4.22.0 - 2019-05-07¶

The unique_by argument to lists now accepts a tuple of callables such that every element of the generated list will be unique with respect to each callable in the tuple (issue #1916).

Thanks to Marco Sirabella for this feature at the PyCon 2019 sprints!

4.21.1 - 2019-05-06¶

This patch cleans up the internals of one_of(). You may see a slight change to the distribution of examples from this strategy but there is no change to the public API.

Thanks to Marco Sirabella for writing this patch at the PyCon 2019 sprints!

4.21.0 - 2019-05-05¶

The from_type() strategy now supports python:slice objects.

Thanks to Charlie El. Awbery for writing this feature at the PyCon 2019 Mentored Sprints.

4.20.0 - 2019-05-05¶

This release improves the array_shapes() strategy, to choose an appropriate default for max_side based on the min_side, and max_dims based on the min_dims. An explicit error is raised for dimensions greater than 32, which are not supported by Numpy, as for other invalid combinations of arguments.

Thanks to Jenny Rouleau for writing this feature at the PyCon 2019 Mentored Sprints.

4.19.0 - 2019-05-05¶

The from_type() strategy now supports python:range objects (or xrange on Python 2).

Thanks to Katrina Durance for writing this feature at the PyCon 2019 Mentored Sprints.

4.18.3 - 2019-04-30¶

This release fixes a very rare edge case in the test-case mutator, which could cause an internal error with certain unusual tests.

4.18.2 - 2019-04-30¶

This patch makes Hypothesis compatible with the Python 3.8 alpha, which changed the representation of code objects to support positional-only arguments. Note however that Hypothesis does not (yet) support such functions as e.g. arguments to builds() or inputs to @given.

Thanks to Paul Ganssle for identifying and fixing this bug.

4.18.1 - 2019-04-29¶

This patch improves the performance of unique collections such as sets() when the elements are drawn from a sampled_from() strategy (issue #1115).

4.18.0 - 2019-04-24¶

This release adds the functions() strategy, which can be used to imitate your ‘real’ function for callbacks.

4.17.2 - 2019-04-19¶

This release refactors stateful rule selection to share the new machinery with sampled_from() instead of using the original independent implementation.

4.17.1 - 2019-04-16¶

This patch allows Hypothesis to try a few more examples after finding the first bug, in hopes of reporting multiple distinct bugs. The heuristics described in issue #847 ensure that we avoid wasting time on fruitless searches, while still surfacing each bug as soon as possible.

4.17.0 - 2019-04-16¶

This release adds the strategy broadcastable_shapes(), which generates array shapes that are broadcast-compatible with a provided shape.

4.16.0 - 2019-04-12¶

This release allows register_type_strategy() to be used with python:typing.NewType instances. This may be useful to e.g. provide only positive integers for from_type(UserId) with a UserId = NewType('UserId', int) type.

Thanks to PJCampi for suggesting and writing the patch!

4.15.0 - 2019-04-09¶

This release supports passing a timedelta as the deadline setting, so you no longer have to remember that the number is in milliseconds (issue #1900).

Thanks to Damon Francisco for this change!

4.14.7 - 2019-04-09¶

This patch makes the type annotations on hypothesis.extra.dateutil compatible with mypy 0.700.

4.14.6 - 2019-04-07¶

This release fixes a bug introduced in Hypothesis 4.14.3 that would sometimes cause sampled_from(...).filter(...) to encounter an internal assertion failure when there are three or fewer elements, and every element is rejected by the filter.

4.14.5 - 2019-04-05¶

This patch takes the previous efficiency improvements to sampled_from(...).filter(...) strategies that reject most elements, and generalises them to also apply to sampled_from(...).filter(...).filter(...) and longer chains of filters.

4.14.4 - 2019-04-05¶

This release fixes a bug that prevented random_module() from correctly restoring the previous state of the random module.

The random state was instead being restored to a temporary deterministic state, which accidentally caused subsequent tests to see the same random values across multiple test runs.

4.14.3 - 2019-04-03¶

This patch adds an internal special case to make sampled_from(...).filter(...) much more efficient when the filter rejects most elements (issue #1885).

4.14.2 - 2019-03-31¶

This patch improves the error message if the function f in s.flatmap(f) does not return a strategy.

Thanks to Kai Chen for this change!

4.14.1 - 2019-03-30¶

This release modifies how Hypothesis selects operations to run during shrinking, by causing it to deprioritise previously useless classes of shrink until others have reached a fixed point.

This avoids certain pathological cases where the shrinker gets very close to finishing and then takes a very long time to finish the last small changes because it tries many useless shrinks for each useful one towards the end. It also should cause a more modest improvement (probably no more than about 30%) in shrinking performance for most tests.

4.14.0 - 2019-03-19¶

This release blocks installation of Hypothesis on Python 3.4, which reached its end of life date on 2019-03-18.

This should not be of interest to anyone but downstream maintainers - if you are affected, migrate to a secure version of Python as soon as possible or at least seek commercial support.

4.13.0 - 2019-03-19¶

This release makes it an explicit error to call floats(min_value=inf, exclude_min=True) or floats(max_value=-inf, exclude_max=True), as there are no possible values that can be generated (issue #1859).

floats(min_value=0.0, max_value=-0.0) is now deprecated. While 0. == -0. and we could thus generate either if comparing by value, violating the sequence ordering of floats is a special case we don’t want or need.

4.12.1 - 2019-03-18¶

This release should significantly reduce the amount of memory that Hypothesis uses for representing large test cases, by storing information in a more compact representation and only unpacking it lazily when it is first needed.

4.12.0 - 2019-03-18¶

This update adds the report_multiple_bugs setting, which you can use to disable multi-bug reporting and only raise whichever bug had the smallest minimal example. This is occasionally useful when using a debugger or tools that annotate tracebacks via introspection.

4.11.7 - 2019-03-18¶

This change makes a tiny improvement to the core engine’s bookkeeping. There is no user-visible change.

4.11.6 - 2019-03-15¶

This release changes some of Hypothesis’s internal shrinking behaviour in order to reduce memory usage and hopefully improve performance.

4.11.5 - 2019-03-13¶

This release adds a micro-optimisation to how Hypothesis handles debug reporting internally. Hard to shrink test may see a slight performance improvement, but in most common scenarios it is unlikely to be noticeable.

4.11.4 - 2019-03-13¶

This release removes some redundant code that was no longer needed but was still running a significant amount of computation and allocation on the hot path. This should result in a modest speed improvement for most tests, especially those with large test cases.

4.11.3 - 2019-03-13¶

This release adds a micro-optimisation to how Hypothesis caches test cases. This will cause a small improvement in speed and memory usage for large test cases, but in most common scenarios it is unlikely to be noticeable.

4.11.2 - 2019-03-13¶

This release removes some internal code that populates a field that is no longer used anywhere. This should result in some modest performance and speed improvements and no other user visible effects.

4.11.1 - 2019-03-13¶

This is a formatting-only patch, enabled by a new version of isort.

4.11.0 - 2019-03-12¶

This release deprecates sampled_from() with empty sequences. This returns nothing(), which gives a clear error if used directly… but simply vanishes if combined with another strategy.

Tests that silently generate less than expected are a serious problem for anyone relying on them to find bugs, and we think reliability more important than convenience in this case.

4.10.0 - 2019-03-11¶

This release improves Hypothesis’s to detect flaky tests, by noticing when the behaviour of the test changes between runs. In particular this will notice many new cases where data generation depends on external state (e.g. external sources of randomness) and flag those as flaky sooner and more reliably.

The basis of this feature is a considerable reengineering of how Hypothesis stores its history of test cases, so on top of this its memory usage should be considerably reduced.

4.9.0 - 2019-03-09¶

This release adds the strategy valid_tuple_axes(), which generates tuples of axis-indices that can be passed to the axis argument in NumPy’s sequential functions (e.g. numpy:numpy.sum()).

Thanks to Ryan Soklaski for this strategy.

4.8.0 - 2019-03-06¶

This release significantly tightens validation in hypothesis.settings. max_examples, buffer_size, and stateful_step_count must be positive integers; deadline must be a positive number or None; and derandomize must be either True or False.

As usual, this replaces existing errors with a more helpful error and starts new validation checks as deprecation warnings.

4.7.19 - 2019-03-04¶

This release makes some micro-optimisations to certain calculations performed in the shrinker. These should particularly speed up large test cases where the shrinker makes many small changes. It will also reduce the amount allocated, but most of this is garbage that would have been immediately thrown away, so you probably won’t see much effect specifically from that.

4.7.18 - 2019-03-03¶

This patch removes some overhead from arrays() with a constant shape and dtype. The resulting performance improvement is modest, but worthwhile for small arrays.

4.7.17 - 2019-03-01¶

This release makes some micro-optimisations within Hypothesis’s internal representation of test cases. This should cause heavily nested test cases to allocate less during generation and shrinking, which should speed things up slightly.

4.7.16 - 2019-02-28¶

This changes the order in which Hypothesis runs certain operations during shrinking. This should significantly decrease memory usage and speed up shrinking of large examples.

4.7.15 - 2019-02-28¶

This release allows Hypothesis to calculate a number of attributes of generated test cases lazily. This should significantly reduce memory usage and modestly improve performance, especially for large test cases.

4.7.14 - 2019-02-28¶

This release reduces the number of operations the shrinker will try when reordering parts of a test case. This should in some circumstances significantly speed up shrinking. It may result in different final test cases, and if so usually slightly worse ones, but it should not generally have much impact on the end result as the operations removed were typically useless.

4.7.13 - 2019-02-27¶

This release changes how Hypothesis reorders examples within a test case during shrinking. This should make shrinking considerably faster.

4.7.12 - 2019-02-27¶

This release slightly improves the shrinker’s ability to replace parts of a test case with their minimal version, by allowing it to do so in bulk rather than one at a time. Where this is effective, shrinker performance should be modestly improved.

4.7.11 - 2019-02-25¶

This release makes some micro-optimisations to common operations performed during shrinking. Shrinking should now be slightly faster, especially for large examples with relatively fast test functions.

4.7.10 - 2019-02-25¶

This release is a purely internal refactoring of Hypothesis’s API for representing test cases. There should be no user visible effect.

4.7.9 - 2019-02-24¶

This release changes certain shrink passes to make them more efficient when they aren’t making progress.

4.7.8 - 2019-02-23¶

This patch removes some unused code, which makes the internals a bit easier to understand. There is no user-visible impact.

4.7.7 - 2019-02-23¶

This release reduces the number of operations the shrinker will try when reordering parts of a test case. This should in some circumstances significantly speed up shrinking. It may result in different final test cases, and if so usually slightly worse ones, but it should not generally have much impact on the end result as the operations removed were typically useless.

4.7.6 - 2019-02-23¶

This patch removes some unused code from the shrinker. There is no user-visible change.

4.7.5 - 2019-02-23¶

This release changes certain shrink passes to make them adaptive - that is, in cases where they are successfully making progress they may now do so significantly faster.

4.7.4 - 2019-02-22¶

This is a docs-only patch, noting that because the lark-parser is under active development at version 0.x, hypothesis[lark] APIs may break in minor releases if necessary to keep up with the upstream package.

4.7.3 - 2019-02-22¶

This changes Hypothesis to no longer import various test frameworks by default (if they are installed). which will speed up the initial import hypothesis call.

4.7.2 - 2019-02-22¶

This release changes Hypothesis’s internal representation of a test case to calculate some expensive structural information on demand rather than eagerly. This should reduce memory usage a fair bit, and may make generation somewhat faster.

4.7.1 - 2019-02-21¶

This release refactors the internal representation of previously run test cases. The main thing you should see as a result is that Hypothesis becomes somewhat less memory hungry.

4.7.0 - 2019-02-21¶

This patch allows array_shapes() to generate shapes with side-length or even dimension zero, though the minimum still defaults to one. These shapes are rare and have some odd behavior, but are particularly important to test for just that reason!

In a related bigfix, arrays() now supports generating zero-dimensional arrays with dtype=object and a strategy for iterable elements. Previously, the array element would incorrectly be set to the first item in the generated iterable.

Thanks to Ryan Turner for continuing to improve our Numpy support.

4.6.1 - 2019-02-19¶

This release is a trivial micro-optimisation inside Hypothesis which should result in it using significantly less memory.

4.6.0 - 2019-02-18¶

This release changes some inconsistent behavior of arrays() from the Numpy extra when asked for an array of shape=(). arrays() will now always return a Numpy ndarray, and the array will always be of the requested dtype.

Thanks to Ryan Turner for this change.

4.5.12 - 2019-02-18¶

This release fixes a minor typo in an internal comment. There is no user-visible change.

4.5.11 - 2019-02-15¶

This release fixes issue #1813, a bug introduced in 3.59.1, which caused random_module() to no longer affect the body of the test: Although Hypothesis would claim to be seeding the random module in fact tests would always run with a seed of zero.

4.5.10 - 2019-02-14¶

This patch fixes an off-by-one error in the maximum length of emails(). Thanks to Krzysztof Jurewicz for pull request #1812.

4.5.9 - 2019-02-14¶

This patch removes some unused code from the shrinker. There is no user-visible change.

4.5.8 - 2019-02-12¶

This release fixes an internal IndexError in Hypothesis that could sometimes be triggered during shrinking.

4.5.7 - 2019-02-11¶

This release modifies the shrinker to interleave different types of reduction operations, e.g. switching between deleting data and lowering scalar values rather than trying entirely deletions then entirely lowering.

This may slow things down somewhat in the typical case, but has the major advantage that many previously difficult to shrink examples should become much faster, because the shrinker will no longer tend to stall when trying some ineffective changes to the shrink target but will instead interleave it with other more effective operations.

4.5.6 - 2019-02-11¶

This release makes a number of internal changes to the implementation of hypothesis.extra.lark.from_lark(). These are primarily intended as a refactoring, but you may see some minor improvements to performance when generating large strings, and possibly to shrink quality.

4.5.5 - 2019-02-10¶

This patch prints an explanatory note when issue #1798 is triggered, because the error message from Numpy is too terse to locate the problem.

4.5.4 - 2019-02-08¶

In Python 2, long integers are not allowed in the shape argument to arrays(). Thanks to Ryan Turner for fixing this.

4.5.3 - 2019-02-08¶

This release makes a small internal refactoring to clarify how Hypothesis instructs tests to stop running when appropriate. There is no user-visible change.

4.5.2 - 2019-02-06¶

This release standardises all of the shrinker’s internal operations on running in a random order.

The main effect you will see from this that it should now be much less common for the shrinker to stall for a long time before making further progress. In some cases this will correspond to shrinking more slowly, but on average it should result in faster shrinking.

4.5.1 - 2019-02-05¶

This patch updates some docstrings, but has no runtime changes.

4.5.0 - 2019-02-03¶

This release adds exclude_min and exclude_max arguments to floats(), so that you can easily generate values from open or half-open intervals (issue #1622).

4.4.6 - 2019-02-03¶

This patch fixes a bug where from_regex() could throw an internal error if the python:re.IGNORECASE flag was used (issue #1786).

4.4.5 - 2019-02-02¶

This release removes two shrink passes that Hypothesis runs late in the process. These were very expensive when the test function was slow and often didn’t do anything useful.

Shrinking should get faster for most failing tests. If you see any regression in example quality as a result of this release, please let us know.

4.4.4 - 2019-02-02¶

This release modifies the way that Hypothesis deletes data during shrinking. It will primarily be noticeable for very large examples, which should now shrink faster.

The shrinker is now also able to perform some deletions that it could not previously, but this is unlikely to be very noticeable.

4.4.3 - 2019-01-25¶

This release fixes an open file leak that used to cause ResourceWarnings.

4.4.2 - 2019-01-24¶

This release changes Hypothesis’s internal approach to caching the results of executing test cases. The result should be that it is now significantly less memory hungry, especially when shrinking large test cases.

Some tests may get slower or faster depending on whether the new or old caching strategy was well suited to them, but any change in speed in either direction should be minor.

4.4.1 - 2019-01-24¶

This patch tightens up some of our internal heuristics to deal with shrinking floating point numbers, which will now run in fewer circumstances.

You are fairly unlikely to see much difference from this, but if you do you are likely to see shrinking become slightly faster and/or producing slightly worse results.

4.4.0 - 2019-01-24¶

This release adds the from_form() function, which allows automatic testing against Django forms. (issue #35)

Thanks to Paul Stiverson for this feature, which resolves our oldest open issue!

4.3.0 - 2019-01-24¶

This release deprecates HealthCheck.hung_test and disables the associated runtime check for tests that ran for more than five minutes. Such a check is redundant now that we enforce the deadline and max_examples setting, which can be adjusted independently.

4.2.0 - 2019-01-23¶

This release adds a new module, hypothesis.extra.lark, which you can use to generate strings matching a context-free grammar.

In this initial version, only lark-parser EBNF grammars are supported, by the new hypothesis.extra.lark.from_lark() function.

4.1.2 - 2019-01-23¶

This patch fixes a very rare overflow bug (issue #1748) which could raise an InvalidArgument error in complex_numbers() even though the arguments were valid.

4.1.1 - 2019-01-23¶

This release makes some improvements to internal code organisation and documentation and has no impact on behaviour.

4.1.0 - 2019-01-22¶

This release adds register_random(), which registers random.Random instances or compatible objects to be seeded and reset by Hypothesis to ensure that test cases are deterministic.

We still recommend explicitly passing a random.Random instance from randoms() if possible, but registering a framework-global state for Hypothesis to manage is better than flaky tests!

4.0.2 - 2019-01-22¶

This patch fixes issue #1387, where bounded integers() with a very large range would almost always generate very large numbers. Now, we usually use the same tuned distribution as unbounded integers().

4.0.1 - 2019-01-16¶

This release randomizes the order in which the shrinker tries some of its initial normalization operations. You are unlikely to see much difference as a result unless your generated examples are very large. In this case you may see some performance improvements in shrinking.

4.0.0 - 2019-01-14¶

Welcome to the next major version of Hypothesis!

There are no new features here, as we release those in minor versions. Instead, 4.0 is a chance for us to remove deprecated features (many already converted into no-ops), and turn a variety of warnings into errors.

If you were running on the last version of Hypothesis 3.x without any Hypothesis deprecation warnings (or using private APIs), this will be a very boring upgrade. In fact, nothing will change for you at all. Per our deprecation policy, warnings added in the last six months (after 2018-07-05) have not been converted to errors.

Removals¶

hypothesis.extra.datetime has been removed, replaced by the core date and time strategies.
hypothesis.extra.fakefactory has been removed, replaced by general expansion of Hypothesis’ strategies and the third-party ecosystem.
The SQLite example database backend has been removed.

Settings¶

The deadline is now enforced by default, rather than just emitting a warning when the default (200 milliseconds per test case) deadline is exceeded.
The database_file setting has been removed; use database.
The perform_health_check setting has been removed; use suppress_health_check.
The max_shrinks setting has been removed; use phases to disable shrinking.
The min_satisfying_examples, max_iterations, strict, timeout, and use_coverage settings have been removed without user-configurable replacements.

Strategies¶

The elements argument is now required for collection strategies.
The average_size argument was a no-op and has been removed.
Date and time strategies now only accept min_value and max_value for bounds.
builds() now requires that the thing to build is passed as the first positional argument.
Alphabet validation for text() raises errors, not warnings, as does category validation for characters().
The choices() strategy has been removed. Instead, you can use data() with sampled_from(), so choice(elements) becomes data.draw(sampled_from(elements)).
The streaming() strategy has been removed. Instead, you can use data() and replace iterating over the stream with data.draw() calls.
sampled_from() and permutations() raise errors instead of warnings if passed a collection that is not a sequence.

Miscellaneous¶

Applying @given to a test function multiple times was really inefficient, and now it’s also an error.
Using the .example() method of a strategy (intended for interactive exploration) within another strategy or a test function always weakened data generation and broke shrinking, and now it’s an error too.
The HYPOTHESIS_DATABASE_FILE environment variable is no longer supported, as the database_file setting has been removed.
The HYPOTHESIS_VERBOSITY_LEVEL environment variable is no longer supported. You can use the --hypothesis-verbosity pytest argument instead, or write your own setup code using the settings profile system to replace it.
Using @seed or derandomize=True now forces database=None to ensure results are in fact reproducible. If database is not None, doing so also emits a HypothesisWarning.
Unused exception types have been removed from hypothesis.errors; namely AbnormalExit, BadData, BadTemplateDraw, DefinitelyNoSuchExample, Timeout, and WrongFormat.

Hypothesis 3.x¶

3.88.3 - 2019-01-11¶

This changes the order that the shrinker tries certain operations in its “emergency” phase which runs late in the process. The new order should be better at avoiding long stalls where the shrinker is failing to make progress, which may be helpful if you have difficult to shrink test cases. However this will not be noticeable in the vast majority of use cases.

3.88.2 - 2019-01-11¶

This is a pure refactoring release that extracts some logic from the core Hypothesis engine into its own class and file. It should have no user visible impact.

3.88.1 - 2019-01-11¶

This patch fixes some markup in our documentation.

3.88.0 - 2019-01-10¶

Introduces hypothesis.stateful.multiple(), which allows rules in rule based state machines to send multiple results at once to their target Bundle, or none at all.

3.87.0 - 2019-01-10¶

This release contains a massive cleanup of the Hypothesis for Django extra:

hypothesis.extra.django.models.models() is deprecated in favor of hypothesis.extra.django.from_model().
hypothesis.extra.django.models.add_default_field_mapping() is deprecated in favor of hypothesis.extra.django.register_field_strategy().
from_model() does not infer a strategy for nullable fields or fields with a default unless passed infer, like builds(). models.models() would usually but not always infer, and a special default_value marker object was required to disable inference.

3.86.9 - 2019-01-09¶

This release improves some internal logic about when a test case in Hypothesis’s internal representation could lead to a valid test case. In some circumstances this can lead to a significant speed up during shrinking. It may have some minor negative impact on the quality of the final result due to certain shrink passes now having access to less information about test cases in some circumstances, but this should rarely matter.

3.86.8 - 2019-01-09¶

This release has no user visible changes but updates our URLs to use HTTPS.

3.86.7 - 2019-01-08¶

Hypothesis can now automatically generate values for Django models with a URLfield, thanks to a new provisional strategy for URLs (issue #1388).

3.86.6 - 2019-01-07¶

This release is a pure refactoring that extracts some internal code into its own file. It should have no user visible effect.

3.86.5 - 2019-01-06¶

This is a docs-only patch, which fixes some typos and removes a few hyperlinks for deprecated features.

3.86.4 - 2019-01-04¶

This release changes the order in which the shrinker tries to delete data. For large and slow tests this may significantly improve the performance of shrinking.

3.86.3 - 2019-01-04¶

This release fixes a bug where certain places Hypothesis internal errors could be raised during shrinking when a user exception occurred that suppressed an exception Hypothesis uses internally in its generation.

The two known ways to trigger this problem were:

Errors raised in stateful tests’ teardown function.
Errors raised in finally blocks that wrapped a call to data.draw.

These cases will now be handled correctly.

3.86.2 - 2019-01-04¶

This patch is a docs-only change to fix a broken hyperlink.

3.86.1 - 2019-01-04¶

This patch fixes issue #1732, where integers() would always return long values on Python 2.

3.86.0 - 2019-01-03¶

This release ensures that infinite numbers are never generated by floats() with allow_infinity=False, which could previously happen in some cases where one bound was also provided.

The trivially inconsistent min_value=inf, allow_infinity=False now raises an InvalidArgumentError, as does the inverse with max_value. You can still use just(inf) to generate inf without violating other constraints.

3.85.3 - 2019-01-02¶

Happy new year everyone! This release has no user visible changes but updates our copyright headers to include 2019.

3.85.2 - 2018-12-31¶

This release makes a small change to the way the shrinker works. You may see some improvements to speed of shrinking on especially large and hard to shrink examples, but most users are unlikely to see much difference.

3.85.1 - 2018-12-30¶

This patch fixes issue #1700, where a line that contained a Unicode character before a lambda definition would cause an internal exception.

3.85.0 - 2018-12-29¶

Introduces the hypothesis.stateful.consumes() function. When defining a rule in stateful testing, it can be used to mark bundles from which values should be consumed, i. e. removed after use in the rule. This has been proposed in issue #136.

Thanks to Jochen Müller for this long-awaited feature.

3.84.6 - 2018-12-28¶

This patch makes a small internal change to fix an issue in Hypothesis’s own coverage tests (issue #1718).

There is no user-visible change.

3.84.5 - 2018-12-21¶

This patch refactors the hypothesis.strategies module, so that private names should no longer appear in tab-completion lists. We previously relied on __all__ for this, but not all editors respect it.

3.84.4 - 2018-12-21¶

This is a follow-up patch to ensure that the deprecation date is automatically recorded for any new deprecations. There is no user-visible effect.

3.84.3 - 2018-12-20¶

This patch updates the Hypothesis pytest plugin to avoid a recently deprecated hook interface. There is no user-visible change.

3.84.2 - 2018-12-19¶

This patch fixes the internals for integers() with one bound. Values from this strategy now always shrink towards zero instead of towards the bound, and should shrink much more efficiently too. On Python 2, providing a bound incorrectly excluded long integers, which can now be generated.

3.84.1 - 2018-12-18¶

This patch adds information about when features were deprecated, but this is only recorded internally and has no user-visible effect.

3.84.0 - 2018-12-18¶

This release changes the stateful testing backend from find() to use @given (issue #1300). This doesn’t change how you create stateful tests, but does make them run more like other Hypothesis tests.

@reproduce_failure and @seed now work for stateful tests.

Stateful tests now respect the deadline and suppress_health_check settings, though they are disabled by default. You can enable them by using @settings(...) as a class decorator with whatever arguments you prefer.

3.83.2 - 2018-12-17¶

Hypothesis has adopted Black as our code formatter (issue #1686). There are no functional changes to the source, but it’s prettier!

3.83.1 - 2018-12-13¶

This patch increases the variety of examples generated by from_type().

3.83.0 - 2018-12-12¶

Our pytest plugin now warns you when strategy functions have been collected as tests, which may happen when e.g. using the @composite decorator when you should be using @given(st.data()) for inline draws. Such functions always pass when treated as tests, because the lazy creation of strategies mean that the function body is never actually executed!

3.82.6 - 2018-12-11¶

Hypothesis can now show statistics when running under pytest-xdist. Previously, statistics were only reported when all tests were run in a single process (issue #700).

3.82.5 - 2018-12-08¶

This patch fixes issue #1667, where passing bounds of Numpy dtype int64 to integers() could cause errors on Python 3 due to internal rounding.

3.82.4 - 2018-12-08¶

Hypothesis now seeds and resets the global state of np.random for each test case, to ensure that tests are reproducible.

This matches and complements the existing handling of the python:random module - Numpy simply maintains an independent PRNG for performance reasons.

3.82.3 - 2018-12-08¶

This is a no-op release to add the new Framework :: Hypothesis trove classifier to hypothesis on PyPI.

You can use it as a filter to find Hypothesis-related packages such as extensions as they add the tag over the coming weeks, or simply visit our curated list.

3.82.2 - 2018-12-08¶

The Hypothesis for Pandas extension is now listed in setup.py, so you can pip install hypothesis[pandas]. Thanks to jmshi for this contribution.

3.82.1 - 2018-10-29¶

This patch fixes from_type() on Python 2 for classes where cls.__init__ is object.__init__. Thanks to ccxcz for reporting issue #1656.

3.82.0 - 2018-10-29¶

The alphabet argument for text() now uses its default value of characters(blacklist_categories=('Cs',)) directly, instead of hiding that behind alphabet=None and replacing it within the function. Passing None is therefore deprecated.

3.81.0 - 2018-10-27¶

GenericStateMachine and RuleBasedStateMachine now raise an explicit error when instances of settings are assigned to the classes’ settings attribute, which is a no-op (issue #1643). Instead assign to SomeStateMachine.TestCase.settings, or use @settings(...) as a class decorator to handle this automatically.

3.80.0 - 2018-10-25¶

Since version 3.68.0, arrays() checks that values drawn from the elements and fill strategies can be safely cast to the dtype of the array, and emits a warning otherwise.

This release expands the checks to cover overflow for finite complex64 elements and string truncation caused by too-long elements or trailing null characters (issue #1591).

3.79.4 - 2018-10-25¶

Tests using @given now shrink errors raised from pytest helper functions, instead of reporting the first example found.

This was previously fixed in version 3.56.0, but only for stateful testing.

3.79.3 - 2018-10-23¶

Traceback elision is now disabled on Python 2, to avoid an import-time python:SyntaxError under Python < 2.7.9 (Python: bpo-21591, Hypothesis 3.79.2: issue #1648).

We encourage all users to upgrade to Python 3 before the end of 2019.

3.79.2 - 2018-10-23¶

This patch shortens tracebacks from Hypothesis, so you can see exactly happened in your code without having to skip over irrelevant details about our internals (issue #848).

In the example test (see pull request #1582), this reduces tracebacks from nine frames to just three - and for a test with multiple errors, from seven frames per error to just one!

If you do want to see the internal details, you can disable frame elision by setting verbosity to debug.

3.79.1 - 2018-10-22¶

The abstract number classes Number, Complex, Real, Rational, and Integral are now supported by the from_type() strategy. Previously, you would have to use register_type_strategy() before they could be resolved (issue #1636)

3.79.0 - 2018-10-18¶

This release adds a CLI flag for verbosity --hypothesis-verbosity to the Hypothesis pytest plugin, applied after loading the profile specified by --hypothesis-profile. Valid options are the names of verbosity settings, quiet, normal, verbose or debug.

Thanks to Bex Dunn for writing this patch at the PyCon Australia sprints!

The pytest header now correctly reports the current profile if --hypothesis-profile has been used.

Thanks to Mathieu Paturel for the contribution at the Canberra Python Hacktoberfest.

3.78.0 - 2018-10-16¶

This release has deprecated the generation of integers, floats and fractions when the conversion of the upper and/ or lower bound is not 100% exact, e.g. when an integer gets passed a bound that is not a whole number. (issue #1625)

Thanks to Felix Grünewald for this patch during Hacktoberfest 2018.

3.77.0 - 2018-10-16¶

This minor release adds functionality to settings allowing it to be used as a decorator on RuleBasedStateMachine and GenericStateMachine.

Thanks to Tyler Nickerson for this feature in #hacktoberfest!

3.76.1 - 2018-10-16¶

This patch fixes some warnings added by recent releases of pydocstyle and mypy.

3.76.0 - 2018-10-11¶

This release deprecates using floats for min_size and max_size.

The type hint for average_size arguments has been changed from Optional[int] to None, because non-None values are always ignored and deprecated.

3.75.4 - 2018-10-10¶

This patch adds more internal comments to the core engine’s sequence-length shrinker. There should be no user-visible change.

3.75.3 - 2018-10-09¶

This patch adds additional comments to some of the core engine’s internal data structures. There is no user-visible change.

3.75.2 - 2018-10-09¶

This patch avoids caching a trivial case, fixing issue #493.

3.75.1 - 2018-10-09¶

This patch fixes a broken link in a docstring. Thanks to Benjamin Lee for this contribution!

3.75.0 - 2018-10-08¶

This release deprecates the use of min_size=None, setting the default min_size to 0 (issue #1618).

3.74.3 - 2018-10-08¶

This patch makes some small internal changes to comply with a new lint setting in the build. There should be no user-visible change.

3.74.2 - 2018-10-03¶

This patch fixes issue #1153, where time spent reifying a strategy was also counted in the time spent generating the first example. Strategies are now fully constructed and validated before the timer is started.

3.74.1 - 2018-10-03¶

This patch fixes some broken formatting and links in the documentation.

3.74.0 - 2018-10-01¶

This release checks that the value of the print_blob setting is a PrintSettings instance.

Being able to specify a boolean value was not intended, and is now deprecated. In addition, specifying True will now cause the blob to always be printed, instead of causing it to be suppressed.

Specifying any value that is not a PrintSettings or a boolean is now an error.

3.73.5 - 2018-10-01¶

Changes the documentation for hypothesis.strategies.datetimes, hypothesis.strategies.dates, hypothesis.strategies.times to use the new parameter names min_value and max_value instead of the deprecated names

3.73.4 - 2018-09-30¶

This patch ensures that Hypothesis deprecation warnings display the code that emitted them when you’re not running in -Werror mode (issue #652).

3.73.3 - 2018-09-27¶

Tracebacks involving @composite are now slightly shorter due to some internal refactoring.

3.73.2 - 2018-09-26¶

This patch fixes errors in the internal comments for one of the shrinker passes. There is no user-visible change.

3.73.1 - 2018-09-25¶

This patch substantially improves the distribution of data generated with recursive(), and fixes a rare internal error (issue #1502).

3.73.0 - 2018-09-24¶

This release adds the fulfill() function, which is designed for testing code that uses dpcontracts 0.4 or later for input validation. This provides some syntactic sugar around use of assume(), to automatically filter out and retry calls that cause a precondition check to fail (issue #1474).

3.72.0 - 2018-09-24¶

This release makes setting attributes of the hypothesis.settings class an explicit error. This has never had any effect, but could mislead users who confused it with the current settings instance hypothesis.settings.default (which is also immutable). You can change the global settings with settings profiles.

3.71.11 - 2018-09-24¶

This patch factors out some common code in the shrinker for iterating over pairs of data blocks. There should be no user-visible change.

3.71.10 - 2018-09-18¶

This patch allows from_type() to handle the empty tuple type, typing.Tuple[()].

3.71.9 - 2018-09-17¶

This patch updates some internal comments for mypy. There is no user-visible effect, even for Mypy users.

3.71.8 - 2018-09-17¶

This patch fixes a rare bug that would cause a particular shrinker pass to raise an IndexError, if a shrink improvement changed the underlying data in an unexpected way.

3.71.7 - 2018-09-17¶

This release fixes the broken cross-references in our docs, and adds a CI check so we don’t add new ones.

3.71.6 - 2018-09-16¶

This patch fixes two bugs (issue #944 and issue #1521), where messages about @seed did not check the current verbosity setting, and the wrong settings were active while executing explicit examples.

3.71.5 - 2018-09-15¶

This patch fixes a DeprecationWarning added in Python 3.8 (issue #1576).

Thanks to tirkarthi for this contribution!

3.71.4 - 2018-09-14¶

This is a no-op release, which implements automatic DOI minting and code archival of Hypothesis via Zenodo. Thanks to CERN and the EU Horizon 2020 programme for providing this service!

Check our CITATION.cff file for details, or head right on over to doi.org/10.5281/zenodo.1412597

3.71.3 - 2018-09-10¶

This release adds the test name to some deprecation warnings, for easier debugging.

Thanks to Sanyam Khurana for the patch!

3.71.2 - 2018-09-10¶

This release makes Hypothesis’s memory usage substantially smaller for tests with many examples, by bounding the number of past examples it keeps around.

You will not see much difference unless you are running tests with max_examples set to well over 1000, but if you do have such tests then you should see memory usage mostly plateau where previously it would have grown linearly with time.

3.71.1 - 2018-09-09¶

This patch adds internal comments to some tree traversals in the core engine. There is no user-visible change.

3.71.0 - 2018-09-08¶

This release deprecates the coverage-guided testing functionality, as it has proven brittle and does not really pull its weight.

We intend to replace it with something more useful in the future, but the feature in its current form does not seem to be worth the cost of using, and whatever replaces it will likely look very different.

3.70.4 - 2018-09-08¶

This patch changes the behaviour of reproduce_failure() so that blobs are only printed in quiet mode when the print_blob setting is set to ALWAYS.

Thanks to Cameron McGill for writing this patch at the PyCon Australia sprints!

3.70.3 - 2018-09-03¶

This patch removes some unnecessary code from the internals. There is no user-visible change.

3.70.2 - 2018-09-03¶

This patch fixes an internal bug where a corrupted argument to @reproduce_failure could raise the wrong type of error. Thanks again to Paweł T. Jochym, who maintains Hypothesis on conda-forge and consistently provides excellent bug reports including issue #1558.

3.70.1 - 2018-09-03¶

This patch updates hypothesis to report its version and settings when run with pytest. (issue #1223).

Thanks to Jack Massey for this feature.

3.70.0 - 2018-09-01¶

This release adds a fullmatch argument to from_regex(). When fullmatch=True, the whole example will match the regex pattern as for python:re.fullmatch().

Thanks to Jakub Nabaglo for writing this patch at the PyCon Australia sprints!

3.69.12 - 2018-08-30¶

This release reverts the changes to logging handling in 3.69.11, which broke test that use the pytest caplog fixture internally because all logging was disabled (issue #1546).

3.69.11 - 2018-08-29¶

This patch will hide all logging messages produced by test cases before the final, minimal, failing test case (issue #356).

Thanks to Gary Donovan for writing this patch at the PyCon Australia sprints!

3.69.10 - 2018-08-29¶

This patch fixes a bug that prevents coverage from reporting unexecuted Python files (issue #1085).

Thanks to Gary Donovan for writing this patch at the PyCon Australia sprints!

3.69.9 - 2018-08-28¶

This patch improves the packaging of the Python package by adding LICENSE.txt to the sdist (issue #1311), clarifying the minimum supported versions of pytz and dateutil (issue #1383), and adds keywords to the metadata (issue #1520).

Thanks to Graham Williamson for writing this patch at the PyCon Australia sprints!

3.69.8 - 2018-08-28¶

This is an internal change which replaces pickle with json to prevent possible security issues.

Thanks to Vidya Rani D G for writing this patch at the PyCon Australia sprints!

3.69.7 - 2018-08-28¶

This patch ensures that note() prints the note for every test case when the verbosity setting is Verbosity.verbose. At normal verbosity it only prints from the final test case.

Thanks to Tom McDermott for writing this patch at the PyCon Australia sprints!

3.69.6 - 2018-08-27¶

This patch improves the testing of some internal caching. It should have no user-visible effect.

3.69.5 - 2018-08-27¶

This change performs a small rename and refactoring in the core engine. There is no user-visible change.

3.69.4 - 2018-08-27¶

This change improves the core engine’s ability to avoid unnecessary work, by consulting its cache of previously-tried inputs in more cases.

3.69.3 - 2018-08-27¶

This patch handles passing an empty python:enum.Enum to from_type() by returning nothing(), instead of raising an internal python:AssertionError.

Thanks to Paul Amazona for writing this patch at the PyCon Australia sprints!

3.69.2 - 2018-08-23¶

This patch fixes a small mistake in an internal comment. There is no user-visible change.

3.69.1 - 2018-08-21¶

This change fixes a small bug in how the core engine consults its cache of previously-tried inputs. There is unlikely to be any user-visible change.

3.69.0 - 2018-08-20¶

This release improves argument validation for stateful testing.

If the target or targets of a rule() are invalid, we now raise a useful validation error rather than an internal exception.
Passing both the target and targets arguments is deprecated - append the target bundle to the targets tuple of bundles instead.
Passing the name of a Bundle rather than the Bundle itself is also deprecated.

3.68.3 - 2018-08-20¶

This is a docs-only patch, fixing some typos and formatting issues.

3.68.2 - 2018-08-19¶

This change fixes a small bug in how the core engine caches the results of previously-tried inputs. The effect is unlikely to be noticeable, but it might avoid unnecessary work in some cases.

3.68.1 - 2018-08-18¶

This patch documents the from_dtype() function, which infers a strategy for numpy:numpy.dtypes. This is used in arrays(), but can also be used directly when creating e.g. Pandas objects.

3.68.0 - 2018-08-15¶

arrays() now checks that integer and float values drawn from elements and fill strategies can be safely cast to the dtype of the array, and emits a warning otherwise (issue #1385).

Elements in the resulting array could previously violate constraints on the elements strategy due to floating-point overflow or truncation of integers to fit smaller types.

3.67.1 - 2018-08-14¶

This release contains a tiny refactoring of the internals. There is no user-visible change.

3.67.0 - 2018-08-10¶

This release adds a width argument to floats(), to generate lower-precision floating point numbers for e.g. Numpy arrays.

The generated examples are always instances of Python’s native float type, which is 64bit, but passing width=32 will ensure that all values can be exactly represented as 32bit floats. This can be useful to avoid overflow (to +/- infinity), and for efficiency of generation and shrinking.

Half-precision floats (width=16) are also supported, but require Numpy if you are running Python 3.5 or earlier.

3.66.33 - 2018-08-10¶

This release fixes a bug in floats(), where setting allow_infinity=False and exactly one of min_value and max_value would allow infinite values to be generated.

3.66.32 - 2018-08-09¶

This release adds type hints to the @example() and seed() decorators, and fixes the type hint on register_type_strategy(). The second argument to register_type_strategy() must either be a SearchStrategy, or a callable which takes a type and returns a SearchStrategy.

3.66.31 - 2018-08-08¶

Another set of changes designed to improve the performance of shrinking on large examples. In particular the shrinker should now spend considerably less time running useless shrinks.

3.66.30 - 2018-08-06¶

“Bug fixes and performance improvements”.

This release is a fairly major overhaul of the shrinker designed to improve its behaviour on large examples, especially around stateful testing. You should hopefully see shrinking become much faster, with little to no quality degradation (in some cases quality may even improve).

3.66.29 - 2018-08-05¶

This release fixes two very minor bugs in the core engine:

it fixes a corner case that was missing in 3.66.28, which should cause shrinking to work slightly better.
it fixes some logic for how shrinking interacts with the database that was causing Hypothesis to be insufficiently aggressive about clearing out old keys.

3.66.28 - 2018-08-05¶

This release improves how Hypothesis handles reducing the size of integers’ representation. This change should mostly be invisible as it’s purely about the underlying representation and not the generated value, but it may result in some improvements to shrink performance.

3.66.27 - 2018-08-05¶

This release changes the order in which Hypothesis chooses parts of the test case to shrink. For typical usage this should be a significant performance improvement on large examples. It is unlikely to have a major impact on example quality, but where it does change the result it should usually be an improvement.

3.66.26 - 2018-08-05¶

This release improves the debugging information that the shrinker emits about the operations it performs, giving better summary statistics about which passes resulted in test executions and whether they were successful.

3.66.25 - 2018-08-05¶

This release fixes several bugs that were introduced to the shrinker in 3.66.24 which would have caused it to behave significantly less well than advertised. With any luck you should actually see the promised benefits now.

3.66.24 - 2018-08-03¶

This release changes how Hypothesis deletes data when shrinking in order to better handle deletion of large numbers of contiguous sequences. Most tests should see little change, but this will hopefully provide a significant speed up for stateful testing.

3.66.23 - 2018-08-02¶

This release makes some internal changes to enable further improvements to the shrinker. You may see some changes in the final shrunk examples, but they are unlikely to be significant.

3.66.22 - 2018-08-01¶

This release adds some more internal caching to the shrinker. This should cause a significant speed up for shrinking, especially for stateful testing and large example sizes.

3.66.21 - 2018-08-01¶

This patch is for downstream packagers - our tests now pass under pytest 3.7.0 (released 2018-07-30). There are no changes to the source of Hypothesis itself.

3.66.20 - 2018-08-01¶

This release removes some functionality from the shrinker that was taking a considerable amount of time and does not appear to be useful any more due to a number of quality improvements in the shrinker.

You may see some degradation in shrink quality as a result of this, but mostly shrinking should just get much faster.

3.66.19 - 2018-08-01¶

This release slightly changes the format of some debugging information emitted during shrinking, and refactors some of the internal interfaces around that.

3.66.18 - 2018-07-31¶

This release is a very small internal refactoring which should have no user visible impact.

3.66.17 - 2018-07-31¶

This release fixes a bug that could cause an IndexError to be raised from inside Hypothesis during shrinking. It is likely that it was impossible to trigger this bug in practice - it was only made visible by some currently unreleased work.

3.66.16 - 2018-07-31¶

This release is a very small internal refactoring which should have no user visible impact.

3.66.15 - 2018-07-31¶

This release makes Hypothesis’s shrinking faster by removing some redundant work that it does when minimizing values in its internal representation.

3.66.14 - 2018-07-30¶

This release expands the deprecation of timeout from 3.16.0 to also emit the deprecation warning in find or stateful testing.

3.66.13 - 2018-07-30¶

This release adds an additional shrink pass that is able to reduce the size of examples in some cases where the transformation is non-obvious. In particular this will improve the quality of some examples which would have regressed in 3.66.12.

3.66.12 - 2018-07-28¶

This release changes how we group data together for shrinking. It should result in improved shrinker performance, especially in stateful testing.

3.66.11 - 2018-07-28¶

This patch modifies how which rule to run is selected during rule based stateful testing. This should result in a slight performance increase during generation and a significant performance and quality improvement when shrinking.

As a result of this change, some state machines which would previously have thrown an InvalidDefinition are no longer detected as invalid.

3.66.10 - 2018-07-28¶

This release weakens some minor functionality in the shrinker that had only modest benefit and made its behaviour much harder to reason about.

This is unlikely to have much user visible effect, but it is possible that in some cases shrinking may get slightly slower. It is primarily to make it easier to work on the shrinker and pave the way for future work.

3.66.9 - 2018-07-26¶

This release improves the information that Hypothesis emits about its shrinking when verbosity is set to debug.

3.66.8 - 2018-07-24¶

This patch includes some minor fixes in the documentation, and updates the minimum version of pytest to 3.0 (released August 2016).

3.66.7 - 2018-07-24¶

This release fixes a bug where difficult to shrink tests could sometimes trigger an internal assertion error inside the shrinker.

3.66.6 - 2018-07-23¶

This patch ensures that Hypothesis fully supports Python 3.7, by upgrading from_type() (issue #1264) and fixing some minor issues in our test suite (issue #1148).

3.66.5 - 2018-07-22¶

This patch fixes the online docs for various extras, by ensuring that their dependencies are installed on readthedocs.io (issue #1326).

3.66.4 - 2018-07-20¶

This release improves the shrinker’s ability to reorder examples.

For example, consider the following test:

import hypothesis.strategies as st
from hypothesis import given


@given(st.text(), st.text())
def test_non_equal(x, y):
    assert x != y

Previously this could have failed with either of x="", y="0" or x="0", y="". Now it should always fail with x="", y="0".

This will allow the shrinker to produce more consistent results, especially in cases where test cases contain some ordered collection whose actual order does not matter.

3.66.3 - 2018-07-20¶

This patch fixes inference in the builds() strategy with subtypes of python:typing.NamedTuple, where the __init__ method is not useful for introspection. We now use the field types instead - thanks to James Uther for identifying this bug.

3.66.2 - 2018-07-19¶

This release improves the shrinker’s ability to handle situations where there is an additive constraint between two values.

For example, consider the following test:

import hypothesis.strategies as st
from hypothesis import given


@given(st.integers(), st.integers())
def test_does_not_exceed_100(m, n):
    assert m + n < 100

Previously this could have failed with almost any pair (m, n) with 0 <= m <= n and m + n == 100. Now it should almost always fail with m=0, n=100.

This is a relatively niche specialisation, but can be useful in situations where e.g. a bug is triggered by an integer overflow.

3.66.1 - 2018-07-09¶

This patch fixes a rare bug where an incorrect percentage drawtime could be displayed for a test, when the system clock was changed during a test running under Python 2 (we use python:time.monotonic() where it is available to avoid such problems). It also fixes a possible zero-division error that can occur when the underlying C library double-rounds an intermediate value in python:math.fsum() and gets the least significant bit wrong.

3.66.0 - 2018-07-05¶

This release improves validation of the alphabet argument to the text() strategy. The following misuses are now deprecated, and will be an error in a future version:

passing an unordered collection (such as set('abc')), which violates invariants about shrinking and reproducibility
passing an alphabet sequence with elements that are not strings
passing an alphabet sequence with elements that are not of length one, which violates any size constraints that may apply

Thanks to Sushobhit for adding these warnings (issue #1329).

3.65.3 - 2018-07-04¶

This release fixes a mostly theoretical bug where certain usage of the internal API could trigger an assertion error inside Hypothesis. It is unlikely that this problem is even possible to trigger through the public API.

3.65.2 - 2018-07-04¶

This release fixes dependency information for coverage. Previously Hypothesis would allow installing coverage with any version, but it only works with coverage 4.0 or later.

We now specify the correct metadata in our setup.py, so Hypothesis will only allow installation with compatible versions of coverage.

3.65.1 - 2018-07-03¶

This patch ensures that stateful tests which raise an error from a pytest helper still print the sequence of steps taken to reach that point (issue #1372). This reporting was previously broken because the helpers inherit directly from python:BaseException, and therefore require special handling to catch without breaking e.g. the use of ctrl-C to quit the test.

3.65.0 - 2018-06-30¶

This release deprecates the max_shrinks setting in favor of an internal heuristic. If you need to avoid shrinking examples, use the phases setting instead. (issue #1235)

3.64.2 - 2018-06-27¶

This release fixes a bug where an internal assertion error could sometimes be triggered while shrinking a failing test.

3.64.1 - 2018-06-27¶

This patch fixes type-checking errors in our vendored pretty-printer, which were ignored by our mypy config but visible for anyone else (whoops). Thanks to Pi Delport for reporting issue #1359 so promptly.

3.64.0 - 2018-06-26¶

This release adds an interface which can be used to insert a wrapper between the original test function and @given (issue #1257). This will be particularly useful for test runner extensions such as pytest-trio, but is not recommended for direct use by other users of Hypothesis.

3.63.0 - 2018-06-26¶

This release adds a new mechanism to infer strategies for classes defined using attrs, based on the the type, converter, or validator of each attribute. This inference is now built in to builds() and from_type().

On Python 2, from_type() no longer generates instances of int when passed long, or vice-versa.

3.62.0 - 2018-06-26¶

This release adds PEP 484 type hints to Hypothesis on a provisional basis, using the comment-based syntax for Python 2 compatibility. You can read more about our type hints here.

It also adds the py.typed marker specified in PEP 561. After you pip install hypothesis, mypy 0.590 or later will therefore type-check your use of our public interface!

3.61.0 - 2018-06-24¶

This release deprecates the use of settings as a context manager, the use of which is somewhat ambiguous.

Users should define settings with global state or with the @settings(...) decorator.

3.60.1 - 2018-06-20¶

Fixed a bug in generating an instance of a Django model from a strategy where the primary key is generated as part of the strategy. See details here.

Thanks to Tim Martin for this contribution.

3.60.0 - 2018-06-20¶

This release adds the @initialize decorator for stateful testing (originally discussed in issue #1216). All @initialize rules will be called once each in an arbitrary order before any normal rule is called.

3.59.3 - 2018-06-19¶

This is a no-op release to take into account some changes to the release process. It should have no user visible effect.

3.59.2 - 2018-06-18¶

This adds support for partially sorting examples which cannot be fully sorted. For example, [5, 4, 3, 2, 1, 0] with a constraint that the first element needs to be larger than the last becomes [1, 2, 3, 4, 5, 0].

Thanks to Luke for contributing.

3.59.1 - 2018-06-16¶

This patch uses python:random.getstate() and python:random.setstate() to restore the PRNG state after @given runs deterministic tests. Without restoring state, you might have noticed problems such as issue #1266. The fix also applies to stateful testing (issue #702).

3.59.0 - 2018-06-14¶

This release adds the emails() strategy, which generates unicode strings representing an email address.

Thanks to Sushobhit for moving this to the public API (issue #162).

3.58.1 - 2018-06-13¶

This improves the shrinker. It can now reorder examples: 3 1 2 becomes 1 2 3.

Thanks to Luke for contributing.

3.58.0 - 2018-06-13¶

This adds a new extra timezones() strategy that generates dateutil timezones.

Thanks to Conrad for contributing.

3.57.0 - 2018-05-20¶

Using an unordered collection with the permutations() strategy has been deprecated because the order in which e.g. a set shrinks is arbitrary. This may cause different results between runs.

3.56.10 - 2018-05-16¶

This release makes hypothesis.settings.define_setting a private method, which has the effect of hiding it from the documentation.

3.56.9 - 2018-05-11¶

This is another release with no functionality changes as part of changes to Hypothesis’s new release tagging scheme.

3.56.8 - 2018-05-10¶

This is a release with no functionality changes that moves Hypothesis over to a new release tagging scheme.

3.56.7 - 2018-05-10¶

This release provides a performance improvement for most tests, but in particular users of sampled_from() who don’t have numpy installed should see a significant performance improvement.

3.56.6 - 2018-05-09¶

This patch contains further internal work to support Mypy. There are no user-visible changes… yet.

3.56.5 - 2018-04-22¶

This patch contains some internal refactoring to run mypy in CI. There are no user-visible changes.

3.56.4 - 2018-04-21¶

This release involves some very minor internal clean up and should have no user visible effect at all.

3.56.3 - 2018-04-20¶

This release fixes a problem introduced in 3.56.0 where setting the hypothesis home directory (through currently undocumented means) would no longer result in the default database location living in the new home directory.

3.56.2 - 2018-04-20¶

This release fixes a problem introduced in 3.56.0 where setting max_examples to 1 would result in tests failing with Unsatisfiable. This problem could also occur in other harder to trigger circumstances (e.g. by setting it to a low value, having a hard to satisfy assumption, and disabling health checks).

3.56.1 - 2018-04-20¶

This release fixes a problem that was introduced in 3.56.0: Use of the HYPOTHESIS_VERBOSITY_LEVEL environment variable was, rather than deprecated, actually broken due to being read before various setup the deprecation path needed was done. It now works correctly (and emits a deprecation warning).

3.56.0 - 2018-04-17¶

This release deprecates several redundant or internally oriented settings, working towards an orthogonal set of configuration options that are widely useful without requiring any knowledge of our internals (issue #535).

Deprecated settings that no longer have any effect are no longer shown in the __repr__ unless set to a non-default value.
hypothesis.settings.perform_health_check is deprecated, as it duplicates suppress_health_check.
hypothesis.settings.max_iterations is deprecated and disabled, because we can usually get better behaviour from an internal heuristic than a user-controlled setting.
hypothesis.settings.min_satisfying_examples is deprecated and disabled, due to overlap with the filter_too_much healthcheck and poor interaction with max_examples.
HYPOTHESIS_VERBOSITY_LEVEL is now deprecated. Set verbosity through the profile system instead.
Examples tried by find() are now reported at debug verbosity level (as well as verbose level).

3.55.6 - 2018-04-14¶

This release fixes a somewhat obscure condition (issue #1230) under which you could occasionally see a failing test trigger an assertion error inside Hypothesis instead of failing normally.

3.55.5 - 2018-04-14¶

This patch fixes one possible cause of issue #966. When running Python 2 with hash randomisation, passing a python:bytes object to python:random.seed() would use version=1, which broke derandomize (because the seed depended on a randomised hash). If derandomize is still nondeterministic for you, please open an issue.

3.55.4 - 2018-04-13¶

This patch makes a variety of minor improvements to the documentation, and improves a few validation messages for invalid inputs.

3.55.3 - 2018-04-12¶

This release updates the URL metadata associated with the PyPI package (again). It has no other user visible effects.

3.55.2 - 2018-04-11¶

This release updates the URL metadata associated with the PyPI package. It has no other user visible effects.

3.55.1 - 2018-04-06¶

This patch relaxes constraints in our tests on the expected values returned by the standard library function hypot() and the internal helper function cathetus, to fix near-exact test failures on some 32-bit systems used by downstream packagers.

3.55.0 - 2018-04-05¶

This release includes several improvements to the handling of the database setting.

The database_file setting was a historical artefact, and you should just use database directly.
The HYPOTHESIS_DATABASE_FILE environment variable is deprecated, in favor of load_profile() and the database setting.
If you have not configured the example database at all and the default location is not usable (due to e.g. permissions issues), Hypothesis will fall back to an in-memory database. This is not persisted between sessions, but means that the defaults work on read-only filesystems.

3.54.0 - 2018-04-04¶

This release improves the complex_numbers() strategy, which now supports min_magnitude and max_magnitude arguments, along with allow_nan and allow_infinity like for floats().

Thanks to J.J. Green for this feature.

3.53.0 - 2018-04-01¶

This release removes support for Django 1.8, which reached end of life on 2018-04-01. You can see Django’s release and support schedule on the Django Project website.

3.52.3 - 2018-04-01¶

This patch fixes the min_satisfying_examples settings documentation, by explaining that example shrinking is tracked at the level of the underlying bytestream rather than the output value.

The output from find() in verbose mode has also been adjusted - see the example session - to avoid duplicating lines when the example repr is constant, even if the underlying representation has been shrunken.

3.52.2 - 2018-03-30¶

This release improves the output of failures with rule based stateful testing in two ways:

The output from it is now usually valid Python code.
When the same value has two different names because it belongs to two different bundles, it will now display with the name associated with the correct bundle for a rule argument where it is used.

3.52.1 - 2018-03-29¶

This release improves the behaviour of stateful testing in two ways:

Previously some runs would run no steps (issue #376). This should no longer happen.
RuleBasedStateMachine tests which used bundles extensively would often shrink terribly. This should now be significantly improved, though there is likely a lot more room for improvement.

This release also involves a low level change to how ranges of integers are handles which may result in other improvements to shrink quality in some cases.

3.52.0 - 2018-03-24¶

This release deprecates use of @settings(...) as a decorator, on functions or methods that are not also decorated with @given. You can still apply these decorators in any order, though you should only do so once each.

Applying @given twice was already deprecated, and applying @settings(...) twice is deprecated in this release and will become an error in a future version. Neither could ever be used twice to good effect.

Using @settings(...) as the sole decorator on a test is completely pointless, so this common usage error will become an error in a future version of Hypothesis.

3.51.0 - 2018-03-24¶

This release deprecates the average_size argument to lists() and other collection strategies. You should simply delete it wherever it was used in your tests, as it no longer has any effect.

In early versions of Hypothesis, the average_size argument was treated as a hint about the distribution of examples from a strategy. Subsequent improvements to the conceptual model and the engine for generating and shrinking examples mean it is more effective to simply describe what constitutes a valid example, and let our internals handle the distribution.

3.50.3 - 2018-03-24¶

This patch contains some internal refactoring so that we can run with warnings as errors in CI.

3.50.2 - 2018-03-20¶

This has no user-visible changes except one slight formatting change to one docstring, to avoid a deprecation warning.

3.50.1 - 2018-03-20¶

This patch fixes an internal error introduced in 3.48.0, where a check for the Django test runner would expose import-time errors in Django configuration (issue #1167).

3.50.0 - 2018-03-19¶

This release improves validation of numeric bounds for some strategies.

integers() and floats() now raise InvalidArgument if passed a min_value or max_value which is not an instance of Real, instead of various internal errors.
floats() now converts its bounding values to the nearest float above or below the min or max bound respectively, instead of just casting to float. The old behaviour was incorrect in that you could generate float(min_value), even when this was less than min_value itself (possible with eg. fractions).
When both bounds are provided to floats() but there are no floats in the interval, such as [(2**54)+1 .. (2**55)-1], InvalidArgument is raised.
decimals() gives a more useful error message if passed a string that cannot be converted to Decimal in a context where this error is not trapped.

Code that previously seemed to work may be explicitly broken if there were no floats between min_value and max_value (only possible with non-float bounds), or if a bound was not a Real number but still allowed in python:math.isnan (some custom classes with a __float__ method).

3.49.1 - 2018-03-15¶

This patch fixes our tests for Numpy dtype strategies on big-endian platforms, where the strategy behaved correctly but the test assumed that the native byte order was little-endian.

There is no user impact unless you are running our test suite on big-endian platforms. Thanks to Graham Inggs for reporting issue #1164.

3.49.0 - 2018-03-12¶

This release deprecates passing elements=None to collection strategies, such as lists().

Requiring lists(nothing()) or builds(list) instead of lists() means slightly more typing, but also improves the consistency and discoverability of our API - as well as showing how to compose or construct strategies in ways that still work in more complex situations.

Passing a nonzero max_size to a collection strategy where the elements strategy contains no values is now deprecated, and will be an error in a future version. The equivalent with elements=None is already an error.

3.48.1 - 2018-03-05¶

This patch will minimize examples that would come out non-minimal in previous versions. Thanks to Kyle Reeve for this patch.

3.48.0 - 2018-03-05¶

This release improves some “unhappy paths” when using Hypothesis with the standard library python:unittest module:

Applying @given to a non-test method which is overridden from python:unittest.TestCase, such as setUp, raises a new health check. (issue #991)
Using subTest() within a test decorated with @given would leak intermediate results when tests were run under the python:unittest test runner. Individual reporting of failing subtests is now disabled during a test using @given. (issue #1071)
@given is still not a class decorator, but the error message if you try using it on a class has been improved.

As a related improvement, using django:django.test.TestCase with @given instead of hypothesis.extra.django.TestCase raises an explicit error instead of running all examples in a single database transaction.

3.47.0 - 2018-03-02¶

register_profile now accepts keyword arguments for specific settings, and the parent settings object is now optional. Using a name for a registered profile which is not a string was never suggested, but it is now also deprecated and will eventually be an error.

3.46.2 - 2018-03-01¶

This release removes an unnecessary branch from the code, and has no user-visible impact.

3.46.1 - 2018-03-01¶

This changes only the formatting of our docstrings and should have no user-visible effects.

3.46.0 - 2018-02-26¶

characters() has improved docs about what arguments are valid, and additional validation logic to raise a clear error early (instead of e.g. silently ignoring a bad argument). Categories may be specified as the Unicode ‘general category’ (eg u'Nd'), or as the ‘major category’ (eg [u'N', u'Lu'] is equivalent to [u'Nd', u'Nl', u'No', u'Lu']).

In previous versions, general categories were supported and all other input was silently ignored. Now, major categories are supported in addition to general categories (which may change the behaviour of some existing code), and all other input is deprecated.

3.45.5 - 2018-02-26¶

This patch improves strategy inference in hypothesis.extra.django to account for some validators in addition to field type - see issue #1116 for ongoing work in this space.

Specifically, if a CharField or TextField has an attached RegexValidator, we now use from_regex() instead of text() as the underlying strategy. This allows us to generate examples of the default User model, closing issue #1112.

3.45.4 - 2018-02-25¶

This patch improves some internal debugging information, fixes a typo in a validation error message, and expands the documentation for new contributors.

3.45.3 - 2018-02-23¶

This patch may improve example shrinking slightly for some strategies.

3.45.2 - 2018-02-18¶

This release makes our docstring style more consistent, thanks to flake8-docstrings. There are no user-visible changes.

3.45.1 - 2018-02-17¶

This fixes an indentation issue in docstrings for datetimes(), dates(), times(), and timedeltas().

3.45.0 - 2018-02-13¶

This release fixes builds() so that target can be used as a keyword argument for passing values to the target. The target itself can still be specified as a keyword argument, but that behavior is now deprecated. The target should be provided as the first positional argument.

3.44.26 - 2018-02-06¶

This release fixes some formatting issues in the Hypothesis source code. It should have no externally visible effects.

3.44.25 - 2018-02-05¶

This release changes the way in which Hypothesis tries to shrink the size of examples. It probably won’t have much impact, but might make shrinking faster in some cases. It is unlikely but not impossible that it will change the resulting examples.

3.44.24 - 2018-01-27¶

This release fixes dependency information when installing Hypothesis from a binary “wheel” distribution.

The install_requires for enum34 is resolved at install time, rather than at build time (with potentially different results).
Django has fixed their python_requires for versions 2.0.0 onward, simplifying Python2-compatible constraints for downstream projects.

3.44.23 - 2018-01-24¶

This release improves shrinking in a class of pathological examples that you are probably never hitting in practice. If you are hitting them in practice this should be a significant speed up in shrinking. If you are not, you are very unlikely to notice any difference. You might see a slight slow down and/or slightly better falsifying examples.

3.44.22 - 2018-01-23¶

This release fixes a dependency problem. It was possible to install Hypothesis with an old version of attrs, which would throw a TypeError as soon as you tried to import hypothesis. Specifically, you need attrs 16.0.0 or newer.

Hypothesis will now require the correct version of attrs when installing.

3.44.21 - 2018-01-22¶

This change adds some additional structural information that Hypothesis will use to guide its search.

You mostly shouldn’t see much difference from this. The two most likely effects you would notice are:

Hypothesis stores slightly more examples in its database for passing tests.
Hypothesis may find new bugs that it was previously missing, but it probably won’t (this is a basic implementation of the feature that is intended to support future work. Although it is useful on its own, it’s not very useful on its own).

3.44.20 - 2018-01-21¶

This is a small refactoring release that changes how Hypothesis tracks some information about the boundary of examples in its internal representation.

You are unlikely to see much difference in behaviour, but memory usage and run time may both go down slightly during normal test execution, and when failing Hypothesis might print its failing example slightly sooner.

3.44.19 - 2018-01-21¶

This changes how we compute the default average_size for all collection strategies. Previously setting a max_size without setting an average_size would have the seemingly paradoxical effect of making data generation slower, because it would raise the average size from its default. Now setting max_size will either leave the default unchanged or lower it from its default.

If you are currently experiencing this problem, this may make your tests substantially faster. If you are not, this will likely have no effect on you.

3.44.18 - 2018-01-20¶

This is a small refactoring release that changes how Hypothesis detects when the structure of data generation depends on earlier values generated (e.g. when using flatmap or composite()). It should not have any observable effect on behaviour.

3.44.17 - 2018-01-15¶

This release fixes a typo in internal documentation, and has no user-visible impact.

3.44.16 - 2018-01-13¶

This release improves test case reduction for recursive data structures. Hypothesis now guarantees that whenever a strategy calls itself recursively (usually this will happen because you are using deferred()), any recursive call may replace the top level value. e.g. given a tree structure, Hypothesis will always try replacing it with a subtree.

Additionally this introduces a new heuristic that may in some circumstances significantly speed up test case reduction - Hypothesis should be better at immediately replacing elements drawn inside another strategy with their minimal possible value.

3.44.15 - 2018-01-13¶

from_type() can now resolve recursive types such as binary trees (issue #1004). Detection of non-type arguments has also improved, leading to better error messages in many cases involving forward references.

3.44.14 - 2018-01-08¶

This release fixes a bug in the shrinker that prevented the optimisations in 3.44.6 from working in some cases. It would not have worked correctly when filtered examples were nested (e.g. with a set of integers in some range).

This would not have resulted in any correctness problems, but shrinking may have been slower than it otherwise could be.

3.44.13 - 2018-01-08¶

This release changes the average bit length of values drawn from integers() to be much smaller. Additionally it changes the shrinking order so that now size is considered before sign - e.g. -1 will be preferred to +10.

The new internal format for integers required some changes to the minimizer to make work well, so you may also see some improvements to example quality in unrelated areas.

3.44.12 - 2018-01-07¶

This changes Hypothesis’s internal implementation of weighted sampling. This will affect example distribution and quality, but you shouldn’t see any other effects.

3.44.11 - 2018-01-06¶

This is a change to some internals around how Hypothesis handles avoiding generating duplicate examples and seeking out novel regions of the search space.

You are unlikely to see much difference as a result of it, but it fixes a bug where an internal assertion could theoretically be triggered and has some minor effects on the distribution of examples so could potentially find bugs that have previously been missed.

3.44.10 - 2018-01-06¶

This patch avoids creating debug statements when debugging is disabled. Profiling suggests this is a 5-10% performance improvement (issue #1040).

3.44.9 - 2018-01-06¶

This patch blacklists null characters ('\x00') in automatically created strategies for Django CharField and TextField, due to a database issue which was recently fixed upstream (Hypothesis issue #1045).

3.44.8 - 2018-01-06¶

This release makes the Hypothesis shrinker slightly less greedy in order to avoid local minima - when it gets stuck, it makes a small attempt to search around the final example it would previously have returned to find a new starting point to shrink from. This should improve example quality in some cases, especially ones where the test data has dependencies among parts of it that make it difficult for Hypothesis to proceed.

3.44.7 - 2018-01-04¶

This release adds support for Django 2 in the hypothesis-django extra.

This release drops support for Django 1.10, as it is no longer supported by the Django team.

3.44.6 - 2018-01-02¶

This release speeds up test case reduction in many examples by being better at detecting large shrinks it can use to discard redundant parts of its input. This will be particularly noticeable in examples that make use of filtering and for some integer ranges.

3.44.5 - 2018-01-02¶

Happy new year!

This is a no-op release that updates the year range on all of the copyright headers in our source to include 2018.

3.44.4 - 2017-12-23¶

This release fixes issue #1041, which slowed tests by up to 6% due to broken caching.

3.44.3 - 2017-12-21¶

This release improves the shrinker in cases where examples drawn earlier can affect how much data is drawn later (e.g. when you draw a length parameter in a composite and then draw that many elements). Examples found in cases like this should now be much closer to minimal.

3.44.2 - 2017-12-20¶

This is a pure refactoring release which changes how Hypothesis manages its set of examples internally. It should have no externally visible effects.

3.44.1 - 2017-12-18¶

This release fixes issue #997, in which under some circumstances the body of tests run under Hypothesis would not show up when run under coverage even though the tests were run and the code they called outside of the test file would show up normally.

3.44.0 - 2017-12-17¶

This release adds a new feature: The @reproduce_failure decorator, designed to make it easy to use Hypothesis’s binary format for examples to reproduce a problem locally without having to share your example database between machines.

This also changes when seeds are printed:

They will no longer be printed for normal falsifying examples, as there are now adequate ways of reproducing those for all cases, so it just contributes noise.
They will once again be printed when reusing examples from the database, as health check failures should now be more reliable in this scenario so it will almost always work in this case.

This work was funded by Smarkets.

3.43.1 - 2017-12-17¶

This release fixes a bug with Hypothesis’s database management - examples that were found in the course of shrinking were saved in a way that indicated that they had distinct causes, and so they would all be retried on the start of the next test. The intended behaviour, which is now what is implemented, is that only a bounded subset of these examples would be retried.

3.43.0 - 2017-12-17¶

HypothesisDeprecationWarning now inherits from python:FutureWarning instead of python:DeprecationWarning, as recommended by PEP 565 for user-facing warnings (issue #618). If you have not changed the default warnings settings, you will now see each distinct HypothesisDeprecationWarning instead of only the first.

3.42.2 - 2017-12-12¶

This patch fixes issue #1017, where instances of a list or tuple subtype used as an argument to a strategy would be coerced to tuple.

3.42.1 - 2017-12-10¶

This release has some internal cleanup, which makes reading the code more pleasant and may shrink large examples slightly faster.

3.42.0 - 2017-12-09¶

This release deprecates faker-extra, which was designed as a transition strategy but does not support example shrinking or coverage-guided discovery.

3.41.0 - 2017-12-06¶

sampled_from() can now sample from one-dimensional numpy ndarrays. Sampling from multi-dimensional ndarrays still results in a deprecation warning. Thanks to Charlie Tanksley for this patch.

3.40.1 - 2017-12-04¶

This release makes two changes:

It makes the calculation of some of the metadata that Hypothesis uses for shrinking occur lazily. This should speed up performance of test case generation a bit because it no longer calculates information it doesn’t need.
It improves the shrinker for certain classes of nested examples. e.g. when shrinking lists of lists, the shrinker is now able to concatenate two adjacent lists together into a single list. As a result of this change, shrinking may get somewhat slower when the minimal example found is large.

3.40.0 - 2017-12-02¶

This release improves how various ways of seeding Hypothesis interact with the example database:

Using the example database with seed() is now deprecated. You should set database=None if you are doing that. This will only warn if you actually load examples from the database while using @seed.
The derandomize will behave the same way as @seed.
Using --hypothesis-seed will disable use of the database.
If a test used examples from the database, it will not suggest using a seed to reproduce it, because that won’t work.

This work was funded by Smarkets.

3.39.0 - 2017-12-01¶

This release adds a new health check that checks if the smallest “natural” possible example of your test case is very large - this will tend to cause Hypothesis to generate bad examples and be quite slow.

This work was funded by Smarkets.

3.38.9 - 2017-11-29¶

This is a documentation release to improve the documentation of shrinking behaviour for Hypothesis’s strategies.

3.38.8 - 2017-11-29¶

This release improves the performance of characters() when using blacklist_characters and from_regex() when using negative character classes.

The problems this fixes were found in the course of work funded by Smarkets.

3.38.7 - 2017-11-29¶

This is a patch release for from_regex(), which had a bug in handling of the python:re.VERBOSE flag (issue #992). Flags are now handled correctly when parsing regex.

3.38.6 - 2017-11-28¶

This patch changes a few byte-string literals from double to single quotes, thanks to an update in unify. There are no user-visible changes.

3.38.5 - 2017-11-23¶

This fixes the repr of strategies using lambda that are defined inside decorators to include the lambda source.

This would mostly have been visible when using the statistics functionality - lambdas used for e.g. filtering would have shown up with a <unknown> as their body. This can still happen, but it should happen less often now.

3.38.4 - 2017-11-22¶

This release updates the reported statistics so that they show approximately what fraction of your test run time is spent in data generation (as opposed to test execution).

This work was funded by Smarkets.

3.38.3 - 2017-11-21¶

This is a documentation release, which ensures code examples are up to date by running them as doctests in CI (issue #711).

3.38.2 - 2017-11-21¶

This release changes the behaviour of the deadline setting when used with data(): Time spent inside calls to data.draw will no longer be counted towards the deadline time.

As a side effect of some refactoring required for this work, the way flaky tests are handled has changed slightly. You are unlikely to see much difference from this, but some error messages will have changed.

This work was funded by Smarkets.

3.38.1 - 2017-11-21¶

This patch has a variety of non-user-visible refactorings, removing various minor warts ranging from indirect imports to typos in comments.

3.38.0 - 2017-11-18¶

This release overhauls the health check system in a variety of small ways. It adds no new features, but is nevertheless a minor release because it changes which tests are likely to fail health checks.

The most noticeable effect is that some tests that used to fail health checks will now pass, and some that used to pass will fail. These should all be improvements in accuracy. In particular:

New failures will usually be because they are now taking into account things like use of data() and assume() inside the test body.
New failures may also be because for some classes of example the way data generation performance was measured was artificially faster than real data generation (for most examples that are hitting performance health checks the opposite should be the case).
Tests that used to fail health checks and now pass do so because the health check system used to run in a way that was subtly different than the main Hypothesis data generation and lacked some of its support for e.g. large examples.

If your data generation is especially slow, you may also see your tests get somewhat faster, as there is no longer a separate health check phase. This will be particularly noticeable when rerunning test failures.

This work was funded by Smarkets.

3.37.0 - 2017-11-12¶

This is a deprecation release for some health check related features.

The following are now deprecated:

Passing HealthCheck.exception_in_generation to suppress_health_check. This no longer does anything even when passed - All errors that occur during data generation will now be immediately reraised rather than going through the health check mechanism.
Passing HealthCheck.random_module to suppress_health_check. This hasn’t done anything for a long time, but was never explicitly deprecated. Hypothesis always seeds the random module when running @given tests, so this is no longer an error and suppressing it doesn’t do anything.
Passing non-HealthCheck values in suppress_health_check. This was previously allowed but never did anything useful.

In addition, passing a non-iterable value as suppress_health_check will now raise an error immediately (it would never have worked correctly, but it would previously have failed later). Some validation error messages have also been updated.

This work was funded by Smarkets.

3.36.1 - 2017-11-10¶

This is a yak shaving release, mostly concerned with our own tests.

While getfullargspec() was documented as deprecated in Python 3.5, it never actually emitted a warning. Our code to silence this (nonexistent) warning has therefore been removed.

We now run our tests with DeprecationWarning as an error, and made some minor changes to our own tests as a result. This required similar upstream updates to coverage and execnet (a test-time dependency via pytest-xdist).

There is no user-visible change in Hypothesis itself, but we encourage you to consider enabling deprecations as errors in your own tests.

3.36.0 - 2017-11-06¶

This release adds a setting to the public API, and does some internal cleanup:

The derandomize setting is now documented (issue #890)
Removed - and disallowed - all ‘bare excepts’ in Hypothesis (issue #953)
Documented the strict setting as deprecated, and updated the build so our docs always match deprecations in the code.

3.35.0 - 2017-11-06¶

This minor release supports constraining uuids() to generate a particular version of UUID (issue #721).

Thanks to Dion Misic for this feature.

3.34.1 - 2017-11-02¶

This patch updates the documentation to suggest builds(callable) instead of just(callable()).

3.34.0 - 2017-11-02¶

Hypothesis now emits deprecation warnings if you apply @given more than once to a target.

Applying @given repeatedly wraps the target multiple times. Each wrapper will search the space of of possible parameters separately. This is equivalent but will be much more inefficient than doing it with a single call to @given.

For example, instead of @given(booleans()) @given(integers()), you could write @given(booleans(), integers())

3.33.1 - 2017-11-02¶

This is a bugfix release:

builds() would try to infer a strategy for required positional arguments of the target from type hints, even if they had been given to builds() as positional arguments (issue #946). Now it only infers missing required arguments.
An internal introspection function wrongly reported self as a required argument for bound methods, which might also have affected builds(). Now it knows better.

3.33.0 - 2017-10-16¶

This release supports strategy inference for more Django field types - you can now omit an argument for Date, Time, Duration, Slug, IP Address, and UUID fields. (issue #642)

Strategy generation for fields with grouped choices now selects choices from each group, instead of selecting from the group names.

3.32.2 - 2017-10-15¶

This patch removes the mergedb tool, introduced in Hypothesis 1.7.1 on an experimental basis. It has never actually worked, and the new Hypothesis example database is designed to make such a tool unnecessary.

3.32.1 - 2017-10-13¶

This patch has two improvements for strategies based on enumerations.

from_type() now handles enumerations correctly, delegating to sampled_from(). Previously it noted that Enum.__init__ has no required arguments and therefore delegated to builds(), which would subsequently fail.
When sampling from an python:enum.Flag, we also generate combinations of members. Eg for Flag('Permissions', 'READ, WRITE, EXECUTE') we can now generate, Permissions.READ, Permissions.READ|WRITE, and so on.

3.32.0 - 2017-10-09¶

This changes the default value of the use_coverage setting to True when running on pypy (it was already True on CPython).

It was previously set to False because we expected it to be too slow, but recent benchmarking shows that actually performance of the feature on pypy is fairly acceptable - sometimes it’s slower than on CPython, sometimes it’s faster, but it’s generally within a factor of two either way.

3.31.6 - 2017-10-08¶

This patch improves the quality of strategies inferred from Numpy dtypes:

Integer dtypes generated examples with the upper half of their (non-sign) bits set to zero. The inferred strategies can now produce any representable integer.
Fixed-width unicode- and byte-string dtypes now cap the internal example length, which should improve example and shrink quality.
Numpy arrays can only store fixed-size strings internally, and allow shorter strings by right-padding them with null bytes. Inferred string strategies no longer generate such values, as they can never be retrieved from an array. This improves shrinking performance by skipping useless values.

This has already been useful in Hypothesis - we found an overflow bug in our Pandas support, and as a result indexes() and range_indexes() now check that min_size and max_size are at least zero.

3.31.5 - 2017-10-08¶

This release fixes a performance problem in tests where the use_coverage setting is True.

Tests experience a slow-down proportionate to the amount of code they cover. This is still the case, but the factor is now low enough that it should be unnoticeable. Previously it was large and became much larger in 3.30.4.

3.31.4 - 2017-10-08¶

from_type() failed with a very confusing error if passed a NewType (issue #901). These pseudo-types are now unwrapped correctly, and strategy inference works as expected.

3.31.3 - 2017-10-06¶

This release makes some small optimisations to our use of coverage that should reduce constant per-example overhead. This is probably only noticeable on examples where the test itself is quite fast. On no-op tests that don’t test anything you may see up to a fourfold speed increase (which is still significantly slower than without coverage). On more realistic tests the speed up is likely to be less than that.

3.31.2 - 2017-09-30¶

This release fixes some formatting and small typos/grammar issues in the documentation, specifically the page docs/settings.rst, and the inline docs for the various settings.

3.31.1 - 2017-09-30¶

This release improves the handling of deadlines so that they act better with the shrinking process. This fixes issue #892.

This involves two changes:

The deadline is raised during the initial generation and shrinking, and then lowered to the set value for final replay. This restricts our attention to examples which exceed the deadline by a more significant margin, which increases their reliability.
When despite the above a test still becomes flaky because it is significantly faster on rerun than it was on its first run, the error message is now more explicit about the nature of this problem, and includes both the initial test run time and the new test run time.

In addition, this release also clarifies the documentation of the deadline setting slightly to be more explicit about where it applies.

This work was funded by Smarkets.

3.31.0 - 2017-09-29¶

This release blocks installation of Hypothesis on Python 3.3, which reached its end of life date on 2017-09-29.

This should not be of interest to anyone but downstream maintainers - if you are affected, migrate to a secure version of Python as soon as possible or at least seek commercial support.

3.30.4 - 2017-09-27¶

This release makes several changes:

It significantly improves Hypothesis’s ability to use coverage information to find interesting examples.
It reduces the default max_examples setting from 200 to 100. This takes advantage of the improved algorithm meaning fewer examples are typically needed to get the same testing and is sufficiently better at covering interesting behaviour, and offsets some of the performance problems of running under coverage.
Hypothesis will always try to start its testing with an example that is near minimized.

The new algorithm for 1 also makes some changes to Hypothesis’s low level data generation which apply even with coverage turned off. They generally reduce the total amount of data generated, which should improve test performance somewhat. Between this and 3 you should see a noticeable reduction in test runtime (how much so depends on your tests and how much example size affects their performance. On our benchmarks, where data generation dominates, we saw up to a factor of two performance improvement, but it’s unlikely to be that large.

3.30.3 - 2017-09-25¶

This release fixes some formatting and small typos/grammar issues in the documentation, specifically the page docs/details.rst, and some inline docs linked from there.

3.30.2 - 2017-09-24¶

This release changes Hypothesis’s caching approach for functions in hypothesis.strategies. Previously it would have cached extremely aggressively and cache entries would never be evicted. Now it adopts a least-frequently used, least recently used key invalidation policy, and is somewhat more conservative about which strategies it caches.

Workloads which create strategies based on dynamic values, e.g. by using flatmap or composite(), will use significantly less memory.

3.30.1 - 2017-09-22¶

This release fixes a bug where when running with the use_coverage=True setting inside an existing running instance of coverage, Hypothesis would frequently put files that the coveragerc excluded in the report for the enclosing coverage.

3.30.0 - 2017-09-20¶

This release introduces two new features:

When a test fails, either with a health check failure or a falsifying example, Hypothesis will print out a seed that led to that failure, if the test is not already running with a fixed seed. You can then recreate that failure using either the @seed decorator or (if you are running pytest) with --hypothesis-seed.
pytest users can specify a seed to use for @given based tests by passing the --hypothesis-seed command line argument.

This work was funded by Smarkets.

3.29.0 - 2017-09-19¶

This release makes Hypothesis coverage aware. Hypothesis now runs all test bodies under coverage, and uses this information to guide its testing.

The use_coverage setting can be used to disable this behaviour if you want to test code that is sensitive to coverage being enabled (either because of performance or interaction with the trace function).

The main benefits of this feature are:

Hypothesis now observes when examples it discovers cover particular lines or branches and stores them in the database for later.
Hypothesis will make some use of this information to guide its exploration of the search space and improve the examples it finds (this is currently used only very lightly and will likely improve significantly in future releases).

This also has the following side-effects:

Hypothesis now has an install time dependency on the coverage package.
Tests that are already running Hypothesis under coverage will likely get faster.
Tests that are not running under coverage now run their test bodies under coverage by default.

This feature is only partially supported under pypy. It is significantly slower than on CPython and is turned off by default as a result, but it should still work correctly if you want to use it.

3.28.3 - 2017-09-18¶

This release is an internal change that affects how Hypothesis handles calculating certain properties of strategies.

The primary effect of this is that it fixes a bug where use of deferred() could sometimes trigger an internal assertion error. However the fix for this bug involved some moderately deep changes to how Hypothesis handles certain constructs so you may notice some additional knock-on effects.

In particular the way Hypothesis handles drawing data from strategies that cannot generate any values has changed to bail out sooner than it previously did. This may speed up certain tests, but it is unlikely to make much of a difference in practice for tests that were not already failing with Unsatisfiable.

3.28.2 - 2017-09-18¶

This is a patch release that fixes a bug in the hypothesis.extra.pandas documentation where it incorrectly referred to column() instead of columns().

3.28.1 - 2017-09-16¶

This is a refactoring release. It moves a number of internal uses of namedtuple() over to using attrs based classes, and removes a couple of internal namedtuple classes that were no longer in use.

It should have no user visible impact.

3.28.0 - 2017-09-15¶

This release adds support for testing pandas via the hypothesis.extra.pandas module.

It also adds a dependency on attrs.

This work was funded by Stripe.

3.27.1 - 2017-09-14¶

This release fixes some formatting and broken cross-references in the documentation, which includes editing docstrings - and thus a patch release.

3.27.0 - 2017-09-13¶

This release introduces a deadline setting to Hypothesis.

When set this turns slow tests into errors. By default it is unset but will warn if you exceed 200ms, which will become the default value in a future release.

This work was funded by Smarkets.

3.26.0 - 2017-09-12¶

Hypothesis now emits deprecation warnings if you are using the legacy SQLite example database format, or the tool for merging them. These were already documented as deprecated, so this doesn’t change their deprecation status, only that we warn about it.

3.25.1 - 2017-09-12¶

This release fixes a bug with generating numpy datetime and timedelta types: When inferring the strategy from the dtype, datetime and timedelta dtypes with sub-second precision would always produce examples with one second resolution. Inferring a strategy from a time dtype will now always produce example with the same precision.

3.25.0 - 2017-09-12¶

This release changes how Hypothesis shrinks and replays examples to take into account that it can encounter new bugs while shrinking the bug it originally found. Previously it would end up replacing the originally found bug with the new bug and show you only that one. Now it is (often) able to recognise when two bugs are distinct and when it finds more than one will show both.

3.24.2 - 2017-09-11¶

This release removes the (purely internal and no longer useful) strategy_test_suite function and the corresponding strategytests module.

3.24.1 - 2017-09-06¶

This release improves the reduction of examples involving floating point numbers to produce more human readable examples.

It also has some general purpose changes to the way the minimizer works internally, which may see some improvement in quality and slow down of test case reduction in cases that have nothing to do with floating point numbers.

3.24.0 - 2017-09-05¶

Hypothesis now emits deprecation warnings if you use some_strategy.example() inside a test function or strategy definition (this was never intended to be supported, but is sufficiently widespread that it warrants a deprecation path).

3.23.3 - 2017-09-05¶

This is a bugfix release for decimals() with the places argument.

No longer fails health checks (issue #725, due to internal filtering)
Specifying a min_value and max_value without any decimals with places places between them gives a more useful error message.
Works for any valid arguments, regardless of the decimal precision context.

3.23.2 - 2017-09-01¶

This is a small refactoring release that removes a now-unused parameter to an internal API. It shouldn’t have any user visible effect.

3.23.1 - 2017-09-01¶

Hypothesis no longer propagates the dynamic scope of settings into strategy definitions.

This release is a small change to something that was never part of the public API and you will almost certainly not notice any effect unless you’re doing something surprising, but for example the following code will now give a different answer in some circumstances:

import hypothesis.strategies as st
from hypothesis import settings

CURRENT_SETTINGS = st.builds(lambda: settings.default)

(We don’t actually encourage you writing code like this)

Previously this would have generated the settings that were in effect at the point of definition of CURRENT_SETTINGS. Now it will generate the settings that are used for the current test.

It is very unlikely to be significant enough to be visible, but you may also notice a small performance improvement.

3.23.0 - 2017-08-31¶

This release adds a unique argument to arrays() which behaves the same ways as the corresponding one for lists(), requiring all of the elements in the generated array to be distinct.

3.22.2 - 2017-08-29¶

This release fixes an issue where Hypothesis would raise a TypeError when using the datetime-related strategies if running with PYTHONOPTIMIZE=2. This bug was introduced in 3.20.0. (See issue #822)

3.22.1 - 2017-08-28¶

Hypothesis now transparently handles problems with an internal unicode cache, including file truncation or read-only filesystems (issue #767). Thanks to Sam Hames for the patch.

3.22.0 - 2017-08-26¶

This release provides what should be a substantial performance improvement to numpy arrays generated using provided numpy support, and adds a new fill_value argument to arrays() to control this behaviour.

This work was funded by Stripe.

3.21.3 - 2017-08-26¶

This release fixes some extremely specific circumstances that probably have never occurred in the wild where users of deferred() might have seen a python:RuntimeError from too much recursion, usually in cases where no valid example could have been generated anyway.

3.21.2 - 2017-08-25¶

This release fixes some minor bugs in argument validation:

hypothesis.extra.numpy dtype strategies would raise an internal error instead of an InvalidArgument exception when passed an invalid endianness specification.

fractions() would raise an internal error instead of an InvalidArgument if passed float("nan") as one of its bounds.

The error message for passing float("nan") as a bound to various strategies has been improved.

Various bound arguments will now raise InvalidArgument in cases where they would previously have raised an internal TypeError or ValueError from the relevant conversion function.

streaming() would not have emitted a deprecation warning when called with an invalid argument.

3.21.1 - 2017-08-24¶

This release fixes a bug where test failures that were the result of an @example would print an extra stack trace before re-raising the exception.

3.21.0 - 2017-08-23¶

This release deprecates Hypothesis’s strict mode, which turned Hypothesis’s deprecation warnings into errors. Similar functionality can be achieved by using simplefilter('error', HypothesisDeprecationWarning).

3.20.0 - 2017-08-22¶

This release renames the relevant arguments on the datetimes(), dates(), times(), and timedeltas() strategies to min_value and max_value, to make them consistent with the other strategies in the module.

The old argument names are still supported but will emit a deprecation warning when used explicitly as keyword arguments. Arguments passed positionally will go to the new argument names and are not deprecated.

3.19.3 - 2017-08-22¶

This release provides a major overhaul to the internals of how Hypothesis handles shrinking.

This should mostly be visible in terms of getting better examples for tests which make heavy use of composite(), data() or flatmap where the data drawn depends a lot on previous choices, especially where size parameters are affected. Previously Hypothesis would have struggled to reliably produce good examples here. Now it should do much better. Performance should also be better for examples with a non-zero min_size.

You may see slight changes to example generation (e.g. improved example diversity) as a result of related changes to internals, but they are unlikely to be significant enough to notice.

3.19.2 - 2017-08-21¶

This release fixes two bugs in hypothesis.extra.numpy:

unicode_string_dtypes() didn’t work at all due to an incorrect dtype specifier. Now it does.
Various impossible conditions would have been accepted but would error when they fail to produced any example. Now they raise an explicit InvalidArgument error.

3.19.1 - 2017-08-21¶

This is a bugfix release for issue #739, where bounds for fractions() or floating-point decimals() were not properly converted to integers before passing them to the integers strategy. This excluded some values that should have been possible, and could trigger internal errors if the bounds lay between adjacent integers.

You can now bound fractions() with two arbitrarily close fractions.

It is now an explicit error to supply a min_value, max_value, and max_denominator to fractions() where the value bounds do not include a fraction with denominator at most max_denominator.

3.19.0 - 2017-08-20¶

This release adds the from_regex() strategy, which generates strings that contain a match of a regular expression.

Thanks to Maxim Kulkin for creating the hypothesis-regex package and then helping to upstream it! (issue #662)

3.18.5 - 2017-08-18¶

This is a bugfix release for integers(). Previously the strategy would hit an internal assertion if passed non-integer bounds for min_value and max_value that had no integers between them. The strategy now raises InvalidArgument instead.

3.18.4 - 2017-08-18¶

Release to fix a bug where mocks can be used as test runners under certain conditions. Specifically, if a mock is injected into a test via pytest fixtures or patch decorators, and that mock is the first argument in the list, hypothesis will think it represents self and turns the mock into a test runner. If this happens, the affected test always passes because the mock is executed instead of the test body. Sometimes, it will also fail health checks.

Fixes issue #491 and a section of issue #198. Thanks to Ben Peterson for this bug fix.

3.18.3 - 2017-08-17¶

This release should improve the performance of some tests which experienced a slow down as a result of the 3.13.0 release.

Tests most likely to benefit from this are ones that make extensive use of min_size parameters, but others may see some improvement as well.

3.18.2 - 2017-08-16¶

This release fixes a bug introduced in 3.18.0. If the arguments whitelist_characters and blacklist_characters to characters() contained overlapping elements, then an InvalidArgument exception would be raised.

Thanks to Zac Hatfield-Dodds for reporting and fixing this.

3.18.1 - 2017-08-14¶

This is a bug fix release to fix issue #780, where sets() and similar would trigger health check errors if their element strategy could only produce one element (e.g. if it was just()).

3.18.0 - 2017-08-13¶

This is a feature release:

characters() now accepts whitelist_characters, particular characters which will be added to those it produces. (issue #668)
A bug fix for the internal function _union_interval_lists(), and a rename to _union_intervals(). It now correctly handles all cases where intervals overlap, and it always returns the result as a tuple for tuples.

Thanks to Alex Willmer for these.

3.17.0 - 2017-08-07¶

This release documents the previously undocumented phases feature, making it part of the public API. It also updates how the example database is used. Principally:

The reuse phase will now correctly control whether examples from the database are run (it previously did exactly the wrong thing and controlled whether examples would be saved).
Hypothesis will no longer try to rerun all previously failing examples. Instead it will replay the smallest previously failing example and a selection of other examples that are likely to trigger any other bugs that will found. This prevents a previous failure from dominating your tests unnecessarily.
As a result of the previous change, Hypothesis will be slower about clearing out old examples from the database that are no longer failing (because it can only clear out ones that it actually runs).

3.16.1 - 2017-08-07¶

This release makes an implementation change to how Hypothesis handles certain internal constructs.

The main effect you should see is improvement to the behaviour and performance of collection types, especially ones with a min_size parameter. Many cases that would previously fail due to being unable to generate enough valid examples will now succeed, and other cases should run slightly faster.

3.16.0 - 2017-08-04¶

This release introduces a deprecation of the timeout feature. This results in the following changes:

Creating a settings object with an explicit timeout will emit a deprecation warning.
If your test stops because it hits the timeout (and has not found a bug) then it will emit a deprecation warning.
There is a new value unlimited which you can import from hypothesis. settings(timeout=unlimited) will not cause a deprecation warning.
There is a new health check, hung_test, which will trigger after a test has been running for five minutes if it is not suppressed.

3.15.0 - 2017-08-04¶

This release deprecates two strategies, choices() and streaming().

Both of these are somewhat confusing to use and are entirely redundant since the introduction of the data() strategy for interactive drawing in tests, and their use should be replaced with direct use of data() instead.

3.14.2 - 2017-08-03¶

This fixes a bug where Hypothesis would not work correctly on Python 2.7 if you had the python:typing module backport installed.

3.14.1 - 2017-08-02¶

This raises the maximum depth at which Hypothesis starts cutting off data generation to a more reasonable value which it is harder to hit by accident.

This resolves (issue #751), in which some examples which previously worked would start timing out, but it will also likely improve the data generation quality for complex data types.

3.14.0 - 2017-07-23¶

Hypothesis now understands inline type annotations (issue #293):

If the target of builds() has type annotations, a default strategy for missing required arguments is selected based on the type. Type-based strategy selection will only override a default if you pass hypothesis.infer as a keyword argument.
If @given wraps a function with type annotations, you can pass infer as a keyword argument and the appropriate strategy will be substituted.
You can check what strategy will be inferred for a type with the new from_type() function.
register_type_strategy() teaches Hypothesis which strategy to infer for custom or unknown types. You can provide a strategy, or for more complex cases a function which takes the type and returns a strategy.

3.13.1 - 2017-07-20¶

This is a bug fix release for issue #514 - Hypothesis would continue running examples after a SkipTest exception was raised, including printing a falsifying example. Skip exceptions from the standard python:unittest module, and pytest, nose, or unittest2 modules now abort the test immediately without printing output.

3.13.0 - 2017-07-16¶

This release has two major aspects to it: The first is the introduction of deferred(), which allows more natural definition of recursive (including mutually recursive) strategies.

The second is a number of engine changes designed to support this sort of strategy better. These should have a knock-on effect of also improving the performance of any existing strategies that currently generate a lot of data or involve heavy nesting by reducing their typical example size.

3.12.0 - 2017-07-07¶

This release makes some major internal changes to how Hypothesis represents data internally, as a prelude to some major engine changes that should improve data quality. There are no API changes, but it’s a significant enough internal change that a minor version bump seemed warranted.

User facing impact should be fairly mild, but includes:

All existing examples in the database will probably be invalidated. Hypothesis handles this automatically, so you don’t need to do anything, but if you see all your examples disappear that’s why.
Almost all data distributions have changed significantly. Possibly for the better, possibly for the worse. This may result in new bugs being found, but it may also result in Hypothesis being unable to find bugs it previously did.
Data generation may be somewhat faster if your existing bottleneck was in draw_bytes (which is often the case for large examples).
Shrinking will probably be slower, possibly significantly.

If you notice any effects you consider to be a significant regression, please open an issue about them.

3.11.6 - 2017-06-19¶

This release involves no functionality changes, but is the first to ship wheels as well as an sdist.

3.11.5 - 2017-06-18¶

This release provides a performance improvement to shrinking. For cases where there is some non-trivial “boundary” value (e.g. the bug happens for all values greater than some other value), shrinking should now be substantially faster. Other types of bug will likely see improvements too.

This may also result in some changes to the quality of the final examples - it may sometimes be better, but is more likely to get slightly worse in some edge cases. If you see any examples where this happens in practice, please report them.

3.11.4 - 2017-06-17¶

This is a bugfix release: Hypothesis now prints explicit examples when running in verbose mode. (issue #313)

3.11.3 - 2017-06-11¶

This is a bugfix release: Hypothesis no longer emits a warning if you try to use sampled_from() with python:collections.OrderedDict. (issue #688)

3.11.2 - 2017-06-10¶

This is a documentation release. Several outdated snippets have been updated or removed, and many cross-references are now hyperlinks.

3.11.1 - 2017-05-28¶

This is a minor ergonomics release. Tracebacks shown by pytest no longer include Hypothesis internals for test functions decorated with @given.

3.11.0 - 2017-05-23¶

This is a feature release, adding datetime-related strategies to the core strategies.

timezones() allows you to sample pytz timezones from the Olsen database. Use directly in a recipe for tz-aware datetimes, or compose with none() to allow a mix of aware and naive output.

The new dates(), times(), datetimes(), and timedeltas() strategies are all constrained by objects of their type. This means that you can generate dates bounded by a single day (i.e. a single date), or datetimes constrained to the microsecond.

times() and datetimes() take an optional timezones= argument, which defaults to none() for naive times. You can use our extra strategy based on pytz, or roll your own timezones strategy with dateutil or even the standard library.

The old dates, times, and datetimes strategies in hypothesis.extra.datetimes are deprecated in favor of the new core strategies, which are more flexible and have no dependencies.

3.10.0 - 2017-05-22¶

Hypothesis now uses python:inspect.getfullargspec() internally. On Python 2, there are no visible changes.

On Python 3 @given and @composite now preserve PEP 3107 annotations on the decorated function. Keyword-only arguments are now either handled correctly (e.g. @composite), or caught in validation instead of silently discarded or raising an unrelated error later (e.g. @given).

3.9.1 - 2017-05-22¶

This is a bugfix release: the default field mapping for a DateTimeField in the Django extra now respects the USE_TZ setting when choosing a strategy.

3.9.0 - 2017-05-19¶

This is feature release, expanding the capabilities of the decimals() strategy.

The new (optional) places argument allows you to generate decimals with a certain number of places (e.g. cents, thousandths, satoshis).
If allow_infinity is None, setting min_bound no longer excludes positive infinity and setting max_value no longer excludes negative infinity.
All of NaN, -Nan, sNaN, and -sNaN may now be drawn if allow_nan is True, or if allow_nan is None and min_value or max_value is None.
min_value and max_value may be given as decimal strings, e.g. "1.234".

3.8.5 - 2017-05-16¶

Hypothesis now imports python:sqlite3 when a SQLite database is used, rather than at module load, improving compatibility with Python implementations compiled without SQLite support (such as BSD or Jython).

3.8.4 - 2017-05-16¶

This is a compatibility bugfix release. sampled_from() no longer raises a deprecation warning when sampling from an python:enum.Enum, as all enums have a reliable iteration order.

3.8.3 - 2017-05-09¶

This release removes a version check for older versions of pytest when using the Hypothesis pytest plugin. The pytest plugin will now run unconditionally on all versions of pytest. This breaks compatibility with any version of pytest prior to 2.7.0 (which is more than two years old).

The primary reason for this change is that the version check was a frequent source of breakage when pytest change their versioning scheme. If you are not working on pytest itself and are not running a very old version of it, this release probably doesn’t affect you.

3.8.2 - 2017-04-26¶

This is a code reorganisation release that moves some internal test helpers out of the main source tree so as to not have changes to them trigger releases in future.

3.8.1 - 2017-04-26¶

This is a documentation release. Almost all code examples are now doctests checked in CI, eliminating stale examples.

3.8.0 - 2017-04-23¶

This is a feature release, adding the iterables() strategy, equivalent to lists(...).map(iter) but with a much more useful repr. You can use this strategy to check that code doesn’t accidentally depend on sequence properties such as indexing support or repeated iteration.

3.7.4 - 2017-04-22¶

This patch fixes a bug in 3.7.3, where using @example and a pytest fixture in the same test could cause the test to fail to fill the arguments, and throw a TypeError.

3.7.3 - 2017-04-21¶

This release should include no user visible changes and is purely a refactoring release. This modularises the behaviour of the core given() function, breaking it up into smaller and more accessible parts, but its actual behaviour should remain unchanged.

3.7.2 - 2017-04-21¶

This reverts an undocumented change in 3.7.1 which broke installation on debian stable: The specifier for the hypothesis[django] extra_requires had introduced a wild card, which was not supported on the default version of pip.

3.7.1 - 2017-04-21¶

This is a bug fix and internal improvements release.

In particular Hypothesis now tracks a tree of where it has already explored. This allows it to avoid some classes of duplicate examples, and significantly improves the performance of shrinking failing examples by allowing it to skip some shrinks that it can determine can’t possibly work.
Hypothesis will no longer seed the global random arbitrarily unless you have asked it to using random_module()
Shrinking would previously have not worked correctly in some special cases on Python 2, and would have resulted in suboptimal examples.

3.7.0 - 2017-03-20¶

This is a feature release.

New features:

Rule based stateful testing now has an @invariant decorator that specifies methods that are run after init and after every step, allowing you to encode properties that should be true at all times. Thanks to Tom Prince for this feature.
The decimals() strategy now supports allow_nan and allow_infinity flags.
There are significantly more strategies available for numpy, including for generating arbitrary data types. Thanks to Zac Hatfield Dodds for this feature.
When using the data() strategy you can now add a label as an argument to draw(), which will be printed along with the value when an example fails. Thanks to Peter Inglesby for this feature.

Bug fixes:

Bug fix: composite() now preserves functions’ docstrings.
The build is now reproducible and doesn’t depend on the path you build it from. Thanks to Chris Lamb for this feature.
numpy strategies for the void data type did not work correctly. Thanks to Zac Hatfield Dodds for this fix.

There have also been a number of performance optimizations:

The permutations() strategy is now significantly faster to use for large lists (the underlying algorithm has gone from O(n^2) to O(n)).
Shrinking of failing test cases should have got significantly faster in some circumstances where it was previously struggling for a long time.
Example generation now involves less indirection, which results in a small speedup in some cases (small enough that you won’t really notice it except in pathological cases).

3.6.1 - 2016-12-20¶

This release fixes a dependency problem and makes some small behind the scenes improvements.

The fake-factory dependency was renamed to faker. If you were depending on it through hypothesis[django] or hypothesis[fake-factory] without pinning it yourself then it would have failed to install properly. This release changes it so that hypothesis[fakefactory] (which can now also be installed as hypothesis[faker]) will install the renamed faker package instead.
This release also removed the dependency of hypothesis[django] on hypothesis[fakefactory] - it was only being used for emails. These now use a custom strategy that isn’t from fakefactory. As a result you should also see performance improvements of tests which generated User objects or other things with email fields, as well as better shrinking of email addresses.
The distribution of code using nested calls to one_of() or the | operator for combining strategies has been improved, as branches are now flattened to give a more uniform distribution.
Examples using composite() or .flatmap should now shrink better. In particular this will affect things which work by first generating a length and then generating that many items, which have historically not shrunk very well.

3.6.0 - 2016-10-31¶

This release reverts Hypothesis to its old pretty printing of lambda functions based on attempting to extract the source code rather than decompile the bytecode. This is unfortunately slightly inferior in some cases and may result in you occasionally seeing things like lambda x: <unknown> in statistics reports and strategy reprs.

This removes the dependencies on uncompyle6, xdis and spark-parser.

The reason for this is that the new functionality was based on uncompyle6, which turns out to introduce a hidden GPLed dependency - it in turn depended on xdis, and although the library was licensed under the MIT license, it contained some GPL licensed source code and thus should have been released under the GPL.

My interpretation is that Hypothesis itself was never in violation of the GPL (because the license it is under, the Mozilla Public License v2, is fully compatible with being included in a GPL licensed work), but I have not consulted a lawyer on the subject. Regardless of the answer to this question, adding a GPLed dependency will likely cause a lot of users of Hypothesis to inadvertently be in violation of the GPL.

As a result, if you are running Hypothesis 3.5.x you really should upgrade to this release immediately.

3.5.3 - 2016-10-05¶

This is a bug fix release.

Bugs fixed:

If the same test was running concurrently in two processes and there were examples already in the test database which no longer failed, Hypothesis would sometimes fail with a FileNotFoundError (IOError on Python 2) because an example it was trying to read was deleted before it was read. (issue #372).
Drawing from an integers() strategy with both a min_value and a max_value would reject too many examples needlessly. Now it repeatedly redraws until satisfied. (pull request #366. Thanks to Calen Pennington for the contribution).

3.5.2 - 2016-09-24¶

This is a bug fix release.

The Hypothesis pytest plugin broke pytest support for doctests. Now it doesn’t.

3.5.1 - 2016-09-23¶

This is a bug fix release.

Hypothesis now runs cleanly in -B and -BB modes, avoiding mixing bytes and unicode.
python:unittest.TestCase tests would not have shown up in the new statistics mode. Now they do.
Similarly, stateful tests would not have shown up in statistics and now they do.
Statistics now print with pytest node IDs (the names you’d get in pytest verbose mode).

3.5.0 - 2016-09-22¶

This is a feature release.

fractions() and decimals() strategies now support min_value and max_value parameters. Thanks go to Anne Mulhern for the development of this feature.
The Hypothesis pytest plugin now supports a --hypothesis-show-statistics parameter that gives detailed statistics about the tests that were run. Huge thanks to Jean-Louis Fuchs and Adfinis-SyGroup for funding the development of this feature.
There is a new event() function that can be used to add custom statistics.

Additionally there have been some minor bug fixes:

In some cases Hypothesis should produce fewer duplicate examples (this will mostly only affect cases with a single parameter).
pytest command line parameters are now under an option group for Hypothesis (thanks to David Keijser for fixing this)
Hypothesis would previously error if you used PEP 3107 function annotations on your tests under Python 3.4.
The repr of many strategies using lambdas has been improved to include the lambda body (this was previously supported in many but not all cases).

3.4.2 - 2016-07-13¶

This is a bug fix release, fixing a number of problems with the settings system:

Test functions defined using @given can now be called from other threads (issue #337)
Attempting to delete a settings property would previously have silently done the wrong thing. Now it raises an AttributeError.
Creating a settings object with a custom database_file parameter was silently getting ignored and the default was being used instead. Now it’s not.

3.4.1 - 2016-07-07¶

This is a bug fix release for a single bug:

On Windows when running two Hypothesis processes in parallel (e.g. using pytest-xdist) they could race with each other and one would raise an exception due to the non-atomic nature of file renaming on Windows and the fact that you can’t rename over an existing file. This is now fixed.

3.4.0 - 2016-05-27¶

This release is entirely provided by Lucas Wiman:

Strategies constructed by the Django extra will now respect much more of Django’s validations out of the box. Wherever possible, full_clean() should succeed.

In particular:

The max_length, blank and choices kwargs are now respected.
Add support for DecimalField.
If a field includes validators, the list of validators are used to filter the field strategy.

3.3.0 - 2016-05-27¶

This release went wrong and is functionally equivalent to 3.2.0. Ignore it.

3.2.0 - 2016-05-19¶

This is a small single-feature release:

All tests using @given now fix the global random seed. This removes the health check for that. If a non-zero seed is required for the final falsifying example, it will be reported. Otherwise Hypothesis will assume randomization was not a significant factor for the test and be silent on the subject. If you use random_module() this will continue to work and will always display the seed.

3.1.3 - 2016-05-01¶

Single bug fix release

Another charmap problem. In 3.1.2 text() and characters() would break on systems which had /tmp mounted on a different partition than the Hypothesis storage directory (usually in home). This fixes that.

3.1.2 - 2016-04-30¶

Single bug fix release:

Anything which used a text() or characters() strategy was broken on Windows and I hadn’t updated appveyor to use the new repository location so I didn’t notice. This is now fixed and windows support should work correctly.

3.1.1 - 2016-04-29¶

Minor bug fix release.

Fix concurrency issue when running tests that use text() from multiple processes at once (issue #302, thanks to Alex Chan).
Improve performance of code using lists() with max_size (thanks to Cristi Cobzarenco).
Fix install on Python 2 with ancient versions of pip so that it installs the enum34 backport (thanks to Donald Stufft for telling me how to do this).
Remove duplicated __all__ exports from hypothesis.strategies (thanks to Piët Delport).
Update headers to point to new repository location.
Allow use of strategies that can’t be used in find() (e.g. choices()) in stateful testing.

3.1.0 - 2016-03-06¶

Add a nothing() strategy that never successfully generates values.
sampled_from() and one_of() can both now be called with an empty argument list, in which case they also never generate any values.
one_of() may now be called with a single argument that is a collection of strategies as well as as varargs.
Add a runner() strategy which returns the instance of the current test object if there is one.
‘Bundle’ for RuleBasedStateMachine is now a normal(ish) strategy and can be used as such.
Tests using RuleBasedStateMachine should now shrink significantly better.
Hypothesis now uses a pretty-printing library internally, compatible with IPython’s pretty printing protocol (actually using the same code). This may improve the quality of output in some cases.
Add a ‘phases’ setting that allows more fine grained control over which parts of the process Hypothesis runs
Add a suppress_health_check setting which allows you to turn off specific health checks in a fine grained manner.
Fix a bug where lists of non fixed size would always draw one more element than they included. This mostly didn’t matter, but if would cause problems with empty strategies or ones with side effects.
Add a mechanism to the Django model generator to allow you to explicitly request the default value (thanks to Jeremy Thurgood for this one).

3.0.5 - 2016-02-25¶

Fix a bug where Hypothesis would now error on pytest development versions.

3.0.4 - 2016-02-24¶

Fix a bug where Hypothesis would error when running on Python 2.7.3 or earlier because it was trying to pass a python:bytearray object to python:struct.unpack() (which is only supported since 2.7.4).

3.0.3 - 2016-02-23¶

Fix version parsing of pytest to work with pytest release candidates
More general handling of the health check problem where things could fail because of a cache miss - now one “free” example is generated before the start of the health check run.

3.0.2 - 2016-02-18¶

Under certain circumstances, strategies involving text() buried inside some other strategy (e.g. text().filter(...) or recursive(text(), ...)) would cause a test to fail its health checks the first time it ran. This was caused by having to compute some related data and cache it to disk. On travis or anywhere else where the .hypothesis directory was recreated this would have caused the tests to fail their health check on every run. This is now fixed for all the known cases, although there could be others lurking.

3.0.1 - 2016-02-18¶

Fix a case where it was possible to trigger an “Unreachable” assertion when running certain flaky stateful tests.
Improve shrinking of large stateful tests by eliminating a case where it was hard to delete early steps.
Improve efficiency of drawing binary(min_size=n, max_size=n) significantly by provide a custom implementation for fixed size blocks that can bypass a lot of machinery.
Set default home directory based on the current working directory at the point Hypothesis is imported, not whenever the function first happens to be called.

3.0.0 - 2016-02-17¶

Codename: This really should have been 2.1.

Externally this looks like a very small release. It has one small breaking change that probably doesn’t affect anyone at all (some behaviour that never really worked correctly is now outright forbidden) but necessitated a major version bump and one visible new feature.

Internally this is a complete rewrite. Almost nothing other than the public API is the same.

New features:

Addition of data() strategy which allows you to draw arbitrary data interactively within the test.
New “exploded” database format which allows you to more easily check the example database into a source repository while supporting merging.
Better management of how examples are saved in the database.
Health checks will now raise as errors when they fail. It was too easy to have the warnings be swallowed entirely.

New limitations:

choices() and streaming() strategies may no longer be used with find(). Neither may data() (this is the change that necessitated a major version bump).

Feature removal:

The ForkingTestCase executor has gone away. It may return in some more working form at a later date.

Performance improvements:

A new model which allows flatmap, composite strategies and stateful testing to perform much better. They should also be more reliable.
Filtering may in some circumstances have improved significantly. This will help especially in cases where you have lots of values with individual filters on them, such as lists(x.filter(…)).
Modest performance improvements to the general test runner by avoiding expensive operations

In general your tests should have got faster. If they’ve instead got significantly slower, I’m interested in hearing about it.

Data distribution:

The data distribution should have changed significantly. This may uncover bugs the previous version missed. It may also miss bugs the previous version could have uncovered. Hypothesis is now producing less strongly correlated data than it used to, but the correlations are extended over more of the structure.

Shrinking:

Shrinking quality should have improved. In particular Hypothesis can now perform simultaneous shrinking of separate examples within a single test (previously it was only able to do this for elements of a single collection). In some cases performance will have improved, in some cases it will have got worse but generally shouldn’t have by much.

Older versions¶

2.0.0 - 2016-01-10¶

Codename: A new beginning

This release cleans up all of the legacy that accrued in the course of Hypothesis 1.0. These are mostly things that were emitting deprecation warnings in 1.19.0, but there were a few additional changes.

In particular:

non-strategy values will no longer be converted to strategies when used in given or find.
FailedHealthCheck is now an error and not a warning.
Handling of non-ascii reprs in user types have been simplified by using raw strings in more places in Python 2.
given no longer allows mixing positional and keyword arguments.
given no longer works with functions with defaults.
given no longer turns provided arguments into defaults - they will not appear in the argspec at all.
the basic() strategy no longer exists.
the n_ary_tree strategy no longer exists.
the average_list_length setting no longer exists. Note: If you’re using using recursive() this will cause you a significant slow down. You should pass explicit average_size parameters to collections in recursive calls.
@rule can no longer be applied to the same method twice.
Python 2.6 and 3.3 are no longer officially supported, although in practice they still work fine.

This also includes two non-deprecation changes:

given’s keyword arguments no longer have to be the rightmost arguments and can appear anywhere in the method signature.
The max_shrinks setting would sometimes not have been respected.

1.19.0 - 2016-01-09¶

Codename: IT COMES

This release heralds the beginning of a new and terrible age of Hypothesis 2.0.

It’s primary purpose is some final deprecations prior to said release. The goal is that if your code emits no warnings under this release then it will probably run unchanged under Hypothesis 2.0 (there are some caveats to this: 2.0 will drop support for some Python versions, and if you’re using internal APIs then as usual that may break without warning).

It does have two new features:

New @seed() decorator which allows you to manually seed a test. This may be harmlessly combined with and overrides the derandomize setting.
settings objects may now be used as a decorator to fix those settings to a particular @given test.

API changes (old usage still works but is deprecated):

Settings has been renamed to settings (lower casing) in order to make the decorator usage more natural.
Functions for the storage directory that were in hypothesis.settings are now in a new hypothesis.configuration module.

Additional deprecations:

the average_list_length setting has been deprecated in favour of being explicit.
the basic() strategy has been deprecated as it is impossible to support it under a Conjecture based model, which will hopefully be implemented at some point in the 2.x series.
the n_ary_tree strategy (which was never actually part of the public API) has been deprecated.
Passing settings or random as keyword arguments to given is deprecated (use the new functionality instead)

Bug fixes:

No longer emit PendingDeprecationWarning for __iter__ and StopIteration in streaming() values.
When running in health check mode with non strict, don’t print quite so many errors for an exception in reify.
When an assumption made in a test or a filter is flaky, tests will now raise Flaky instead of UnsatisfiedAssumption.

1.18.1 - 2015-12-22¶

Two behind the scenes changes:

Hypothesis will no longer write generated code to the file system. This will improve performance on some systems (e.g. if you’re using PythonAnywhere which is running your code from NFS) and prevent some annoying interactions with auto-restarting systems.
Hypothesis will cache the creation of some strategies. This can significantly improve performance for code that uses flatmap or composite and thus has to instantiate strategies a lot.

1.18.0 - 2015-12-21¶

Features:

Tests and find are now explicitly seeded off the global random module. This means that if you nest one inside the other you will now get a health check error. It also means that you can control global randomization by seeding random.
There is a new random_module() strategy which seeds the global random module for you and handles things so that you don’t get a health check warning if you use it inside your tests.
floats() now accepts two new arguments: allow_nan and allow_infinity. These default to the old behaviour, but when set to False will do what the names suggest.

Bug fixes:

Fix a bug where tests that used text() on Python 3.4+ would not actually be deterministic even when explicitly seeded or using the derandomize mode, because generation depended on dictionary iteration order which was affected by hash randomization.
Fix a bug where with complicated strategies the timing of the initial health check could affect the seeding of the subsequent test, which would also render supposedly deterministic tests non-deterministic in some scenarios.
In some circumstances flatmap() could get confused by two structurally similar things it could generate and would produce a flaky test where the first time it produced an error but the second time it produced the other value, which was not an error. The same bug was presumably also possible in composite().
flatmap() and composite() initial generation should now be moderately faster. This will be particularly noticeable when you have many values drawn from the same strategy in a single run, e.g. constructs like lists(s.flatmap(f)). Shrinking performance may have suffered, but this didn’t actually produce an interestingly worse result in any of the standard scenarios tested.

1.17.1 - 2015-12-16¶

A small bug fix release, which fixes the fact that the ‘note’ function could not be used on tests which used the @example decorator to provide explicit examples.

1.17.0 - 2015-12-15¶

This is actually the same release as 1.16.1, but 1.16.1 has been pulled because it contains the following additional change that was not intended to be in a patch release (it’s perfectly stable, but is a larger change that should have required a minor version bump):

Hypothesis will now perform a series of “health checks” as part of running your tests. These detect and warn about some common error conditions that people often run into which wouldn’t necessarily have caused the test to fail but would cause e.g. degraded performance or confusing results.

1.16.1 - 2015-12-14¶

Note: This release has been removed.

A small bugfix release that allows bdists for Hypothesis to be built under 2.7 - the compat3.py file which had Python 3 syntax wasn’t intended to be loaded under Python 2, but when building a bdist it was. In particular this would break running setup.py test.

1.16.0 - 2015-12-08¶

There are no public API changes in this release but it includes a behaviour change that I wasn’t comfortable putting in a patch release.

Functions from hypothesis.strategies will no longer raise InvalidArgument on bad arguments. Instead the same errors will be raised when a test using such a strategy is run. This may improve startup time in some cases, but the main reason for it is so that errors in strategies won’t cause errors in loading, and it can interact correctly with things like pytest.mark.skipif.
Errors caused by accidentally invoking the legacy API are now much less confusing, although still throw NotImplementedError.
hypothesis.extra.django is 1.9 compatible.
When tests are run with max_shrinks=0 this will now still rerun the test on failure and will no longer print “Trying example:” before each run. Additionally note() will now work correctly when used with max_shrinks=0.

1.15.0 - 2015-11-24¶

A release with two new features.

A ‘characters’ strategy for more flexible generation of text with particular character ranges and types, kindly contributed by Alexander Shorin.
Add support for preconditions to the rule based stateful testing. Kindly contributed by Christopher Armstrong

1.14.0 - 2015-11-01¶

New features:

Add ‘note’ function which lets you include additional information in the final test run’s output.
Add ‘choices’ strategy which gives you a choice function that emulates random.choice.
Add ‘uuid’ strategy that generates UUIDs’
Add ‘shared’ strategy that lets you create a strategy that just generates a single shared value for each test run

Bugs:

Using strategies of the form streaming(x.flatmap(f)) with find or in stateful testing would have caused InvalidArgument errors when the resulting values were used (because code that expected to only be called within a test context would be invoked).

1.13.0 - 2015-10-29¶

This is quite a small release, but deprecates some public API functions and removes some internal API functionality so gets a minor version bump.

All calls to the ‘strategy’ function are now deprecated, even ones which pass just a SearchStrategy instance (which is still a no-op).
Never documented hypothesis.extra entry_points mechanism has now been removed ( it was previously how hypothesis.extra packages were loaded and has been deprecated and unused for some time)
Some corner cases that could previously have produced an OverflowError when simplifying failing cases using hypothesis.extra.datetimes (or dates or times) have now been fixed.
Hypothesis load time for first import has been significantly reduced - it used to be around 250ms (on my SSD laptop) and now is around 100-150ms. This almost never matters but was slightly annoying when using it in the console.
hypothesis.strategies.randoms was previously missing from __all__.

1.12.0 - 2015-10-18¶

Significantly improved performance of creating strategies using the functions from the hypothesis.strategies module by deferring the calculation of their repr until it was needed. This is unlikely to have been an performance issue for you unless you were using flatmap, composite or stateful testing, but for some cases it could be quite a significant impact.
A number of cases where the repr of strategies build from lambdas is improved
Add dates() and times() strategies to hypothesis.extra.datetimes
Add new ‘profiles’ mechanism to the settings system
Deprecates mutability of Settings, both the Settings.default top level property and individual settings.
A Settings object may now be directly initialized from a parent Settings.
@given should now give a better error message if you attempt to use it with a function that uses destructuring arguments (it still won’t work, but it will error more clearly),
A number of spelling corrections in error messages
pytest should no longer display the intermediate modules Hypothesis generates when running in verbose mode
Hypothesis should now correctly handle printing objects with non-ascii reprs on python 3 when running in a locale that cannot handle ascii printing to stdout.
Add a unique=True argument to lists(). This is equivalent to unique_by=lambda x: x, but offers a more convenient syntax.

1.11.4 - 2015-09-27¶

Hide modifications Hypothesis needs to make to sys.path by undoing them after we’ve imported the relevant modules. This is a workaround for issues cryptography experienced on windows.
Slightly improved performance of drawing from sampled_from on large lists of alternatives.
Significantly improved performance of drawing from one_of or strategies using | (note this includes a lot of strategies internally - floats() and integers() both fall into this category). There turned out to be a massive performance regression introduced in 1.10.0 affecting these which probably would have made tests using Hypothesis significantly slower than they should have been.

1.11.3 - 2015-09-23¶

Better argument validation for datetimes() strategy - previously setting max_year < datetime.MIN_YEAR or min_year > datetime.MAX_YEAR would not have raised an InvalidArgument error and instead would have behaved confusingly.
Compatibility with being run on pytest < 2.7 (achieved by disabling the plugin).

1.11.2 - 2015-09-23¶

Bug fixes:

Settings(database=my_db) would not be correctly inherited when used as a default setting, so that newly created settings would use the database_file setting and create an SQLite example database.
Settings.default.database = my_db would previously have raised an error and now works.
Timeout could sometimes be significantly exceeded if during simplification there were a lot of examples tried that didn’t trigger the bug.
When loading a heavily simplified example using a basic() strategy from the database this could cause Python to trigger a recursion error.
Remove use of deprecated API in pytest plugin so as to not emit warning

Misc:

hypothesis-pytest is now part of hypothesis core. This should have no externally visible consequences, but you should update your dependencies to remove hypothesis-pytest and depend on only Hypothesis.
Better repr for hypothesis.extra.datetimes() strategies.
Add .close() method to abstract base class for Backend (it was already present in the main implementation).

1.11.1 - 2015-09-16¶

Bug fixes:

When running Hypothesis tests in parallel (e.g. using pytest-xdist) there was a race condition caused by code generation.
Example databases are now cached per thread so as to not use sqlite connections from multiple threads. This should make Hypothesis now entirely thread safe.
floats() with only min_value or max_value set would have had a very bad distribution.
Running on 3.5, Hypothesis would have emitted deprecation warnings because of use of inspect.getargspec

1.11.0 - 2015-08-31¶

text() with a non-string alphabet would have used the repr() of the the alphabet instead of its contexts. This is obviously silly. It now works with any sequence of things convertible to unicode strings.
@given will now work on methods whose definitions contains no explicit positional arguments, only varargs (issue #118). This may have some knock on effects because it means that @given no longer changes the argspec of functions other than by adding defaults.
Introduction of new @composite feature for more natural definition of strategies you’d previously have used flatmap for.

1.10.6 - 2015-08-26¶

Fix support for fixtures on Django 1.7.

1.10.4 - 2015-08-21¶

Tiny bug fix release:

If the database_file setting is set to None, this would have resulted in an error when running tests. Now it does the same as setting database to None.

1.10.3 - 2015-08-19¶

Another small bug fix release.

lists(elements, unique_by=some_function, min_size=n) would have raised a ValidationError if n > Settings.default.average_list_length because it would have wanted to use an average list length shorter than the minimum size of the list, which is impossible. Now it instead defaults to twice the minimum size in these circumstances.
basic() strategy would have only ever produced at most ten distinct values per run of the test (which is bad if you e.g. have it inside a list). This was obviously silly. It will now produce a much better distribution of data, both duplicated and non duplicated.

1.10.2 - 2015-08-19¶

This is a small bug fix release:

star imports from hypothesis should now work correctly.
example quality for examples using flatmap will be better, as the way it had previously been implemented was causing problems where Hypothesis was erroneously labelling some examples as being duplicates.

1.10.0 - 2015-08-04¶

This is just a bugfix and performance release, but it changes some semi-public APIs, hence the minor version bump.

Significant performance improvements for strategies which are one_of() many branches. In particular this included recursive() strategies. This should take the case where you use one recursive() strategy as the base strategy of another from unusably slow (tens of seconds per generated example) to reasonably fast.
Better handling of just() and sampled_from() for values which have an incorrect __repr__ implementation that returns non-ASCII unicode on Python 2.
Better performance for flatmap from changing the internal morpher API to be significantly less general purpose.
Introduce a new semi-public BuildContext/cleanup API. This allows strategies to register cleanup activities that should run once the example is complete. Note that this will interact somewhat weirdly with find.
Better simplification behaviour for streaming strategies.
Don’t error on lambdas which use destructuring arguments in Python 2.
Add some better reprs for a few strategies that were missing good ones.
The Random instances provided by randoms() are now copyable.
Slightly more debugging information about simplify when using a debug verbosity level.
Support using given for functions with varargs, but not passing arguments to it as positional.

1.9.0 - 2015-07-27¶

Codename: The great bundling.

This release contains two fairly major changes.

The first is the deprecation of the hypothesis-extra mechanism. From now on all the packages that were previously bundled under it other than hypothesis-pytest (which is a different beast and will remain separate). The functionality remains unchanged and you can still import them from exactly the same location, they just are no longer separate packages.

The second is that this introduces a new way of building strategies which lets you build up strategies recursively from other strategies.

It also contains the minor change that calling .example() on a strategy object will give you examples that are more representative of the actual data you’ll get. There used to be some logic in there to make the examples artificially simple but this proved to be a bad idea.

1.8.5 - 2015-07-24¶

This contains no functionality changes but fixes a mistake made with building the previous package that would have broken installation on Windows.

1.8.4 - 2015-07-20¶

Bugs fixed:

When a call to floats() had endpoints which were not floats but merely convertible to one (e.g. integers), these would be included in the generated data which would cause it to generate non-floats.
Splitting lambdas used in the definition of flatmap, map or filter over multiple lines would break the repr, which would in turn break their usage.

1.8.3 - 2015-07-20¶

“Falsifying example” would not have been printed when the failure came from an explicit example.

1.8.2 - 2015-07-18¶

Another small bugfix release:

When using ForkingTestCase you would usually not get the falsifying example printed if the process exited abnormally (e.g. due to os._exit).
Improvements to the distribution of characters when using text() with a default alphabet. In particular produces a better distribution of ascii and whitespace in the alphabet.

1.8.1 - 2015-07-17¶

This is a small release that contains a workaround for people who have bad reprs returning non ascii text on Python 2.7. This is not a bug fix for Hypothesis per se because that’s not a thing that is actually supposed to work, but Hypothesis leans more heavily on repr than is typical so it’s worth having a workaround for.

1.8.0 - 2015-07-16¶

New features:

Much more sensible reprs for strategies, especially ones that come from hypothesis.strategies. These should now have as reprs python code that would produce the same strategy.
lists() accepts a unique_by argument which forces the generated lists to be only contain elements unique according to some function key (which must return a hashable value).
Better error messages from flaky tests to help you debug things.

Mostly invisible implementation details that may result in finding new bugs in your code:

Sets and dictionary generation should now produce a better range of results.
floats with bounds now focus more on ‘critical values’, trying to produce values at edge cases.
flatmap should now have better simplification for complicated cases, as well as generally being (I hope) more reliable.

Bug fixes:

You could not previously use assume() if you were using the forking executor.

1.7.2 - 2015-07-10¶

This is purely a bug fix release:

When using floats() with stale data in the database you could sometimes get values in your tests that did not respect min_value or max_value.
When getting a Flaky error from an unreliable test it would have incorrectly displayed the example that caused it.
2.6 dependency on backports was incorrectly specified. This would only have caused you problems if you were building a universal wheel from Hypothesis, which is not how Hypothesis ships, so unless you’re explicitly building wheels for your dependencies and support Python 2.6 plus a later version of Python this probably would never have affected you.
If you use flatmap in a way that the strategy on the right hand side depends sensitively on the left hand side you may have occasionally seen Flaky errors caused by producing unreliable examples when minimizing a bug. This use case may still be somewhat fraught to be honest. This code is due a major rearchitecture for 1.8, but in the meantime this release fixes the only source of this error that I’m aware of.

1.7.1 - 2015-06-29¶

Codename: There is no 1.7.0.

A slight technical hitch with a premature upload means there’s was a yanked 1.7.0 release. Oops.

The major feature of this release is Python 2.6 support. Thanks to Jeff Meadows for doing most of the work there.

Other minor features

strategies now has a permutations() function which returns a strategy yielding permutations of values from a given collection.
if you have a flaky test it will print the exception that it last saw before failing with Flaky, even if you do not have verbose reporting on.
Slightly experimental git merge script available as “python -m hypothesis.tools.mergedbs”. Instructions on how to use it in the docstring of that file.

Bug fixes:

Better performance from use of filter. In particular tests which involve large numbers of heavily filtered strategies should perform a lot better.
floats() with a negative min_value would not have worked correctly (worryingly, it would have just silently failed to run any examples). This is now fixed.
tests using sampled_from would error if the number of sampled elements was smaller than min_satisfying_examples.

1.6.2 - 2015-06-08¶

This is just a few small bug fixes:

Size bounds were not validated for values for a binary() strategy when reading examples from the database.
sampled_from is now in __all__ in hypothesis.strategies
floats no longer consider negative integers to be simpler than positive non-integers
Small floating point intervals now correctly count members, so if you have a floating point interval so narrow there are only a handful of values in it, this will no longer cause an error when Hypothesis runs out of values.

1.6.1 - 2015-05-21¶

This is a small patch release that fixes a bug where 1.6.0 broke the use of flatmap with the deprecated API and assumed the passed in function returned a SearchStrategy instance rather than converting it to a strategy.

1.6.0 - 2015-05-21¶

This is a smallish release designed to fix a number of bugs and smooth out some weird behaviours.

Fix a critical bug in flatmap where it would reuse old strategies. If all your flatmap code was pure you’re fine. If it’s not, I’m surprised it’s working at all. In particular if you want to use flatmap with django models, you desperately need to upgrade to this version.
flatmap simplification performance should now be better in some cases where it previously had to redo work.
Fix for a bug where invalid unicode data with surrogates could be generated during simplification (it was already filtered out during actual generation).
The Hypothesis database is now keyed off the name of the test instead of the type of data. This makes much more sense now with the new strategies API and is generally more robust. This means you will lose old examples on upgrade.
The database will now not delete values which fail to deserialize correctly, just skip them. This is to handle cases where multiple incompatible strategies share the same key.
find now also saves and loads values from the database, keyed off a hash of the function you’re finding from.
Stateful tests now serialize and load values from the database. They should have before, really. This was a bug.
Passing a different verbosity level into a test would not have worked entirely correctly, leaving off some messages. This is now fixed.
Fix a bug where derandomized tests with unicode characters in the function body would error on Python 2.7.

1.5.0 - 2015-05-14¶

Codename: Strategic withdrawal.

The purpose of this release is a radical simplification of the API for building strategies. Instead of the old approach of @strategy.extend and things that get converted to strategies, you just build strategies directly.

The old method of defining strategies will still work until Hypothesis 2.0, because it’s a major breaking change, but will now emit deprecation warnings.

The new API is also a lot more powerful as the functions for defining strategies give you a lot of dials to turn. See the updated data section for details.

Other changes:

Mixing keyword and positional arguments in a call to @given is deprecated as well.

There is a new setting called ‘strict’. When set to True, Hypothesis will raise warnings instead of merely printing them. Turning it on by default is inadvisable because it means that Hypothesis minor releases can break your code, but it may be useful for making sure you catch all uses of deprecated APIs.

max_examples in settings is now interpreted as meaning the maximum number of unique (ish) examples satisfying assumptions. A new setting max_iterations which defaults to a larger value has the old interpretation.

Example generation should be significantly faster due to a new faster parameter selection algorithm. This will mostly show up for simple data types - for complex ones the parameter selection is almost certainly dominated.

Simplification has some new heuristics that will tend to cut down on cases where it could previously take a very long time.

timeout would previously not have been respected in cases where there were a lot of duplicate examples. You probably wouldn’t have previously noticed this because max_examples counted duplicates, so this was very hard to hit in a way that mattered.

A number of internal simplifications to the SearchStrategy API.

You can now access the current Hypothesis version as hypothesis.__version__.

A top level function is provided for running the stateful tests without the TestCase infrastructure.

1.4.0 - 2015-05-04¶

Codename: What a state.

The big feature of this release is the new and slightly experimental stateful testing API. You can read more about that in the appropriate section.

Two minor features the were driven out in the course of developing this:

You can now set settings.max_shrinks to limit the number of times Hypothesis will try to shrink arguments to your test. If this is set to <= 0 then Hypothesis will not rerun your test and will just raise the failure directly. Note that due to technical limitations if max_shrinks is <= 0 then Hypothesis will print every example it calls your test with rather than just the failing one. Note also that I don’t consider settings max_shrinks to zero a sensible way to run your tests and it should really be considered a debug feature.
There is a new debug level of verbosity which is even more verbose than verbose. You probably don’t want this.

Breakage of semi-public SearchStrategy API:

It is now a required invariant of SearchStrategy that if u simplifies to v then it is not the case that strictly_simpler(u, v). i.e. simplifying should not increase the complexity even though it is not required to decrease it. Enforcing this invariant lead to finding some bugs where simplifying of integers, floats and sets was suboptimal.
Integers in basic data are now required to fit into 64 bits. As a result python integer types are now serialized as strings, and some types have stopped using quite so needlessly large random seeds.

Hypothesis Stateful testing was then turned upon Hypothesis itself, which lead to an amazing number of minor bugs being found in Hypothesis itself.

Bugs fixed (most but not all from the result of stateful testing) include:

Serialization of streaming examples was flaky in a way that you would probably never notice: If you generate a template, simplify it, serialize it, deserialize it, serialize it again and then deserialize it you would get the original stream instead of the simplified one.
If you reduced max_examples below the number of examples already saved in the database, you would have got a ValueError. Additionally, if you had more than max_examples in the database all of them would have been considered.
@given will no longer count duplicate examples (which it never called your function with) towards max_examples. This may result in your tests running slower, but that’s probably just because they’re trying more examples.
General improvements to example search which should result in better performance and higher quality examples. In particular parameters which have a history of producing useless results will be more aggressively culled. This is useful both because it decreases the chance of useless examples and also because it’s much faster to not check parameters which we were unlikely to ever pick!
integers_from and lists of types with only one value (e.g. [None]) would previously have had a very high duplication rate so you were probably only getting a handful of examples. They now have a much lower duplication rate, as well as the improvements to search making this less of a problem in the first place.
You would sometimes see simplification taking significantly longer than your defined timeout. This would happen because timeout was only being checked after each successful simplification, so if Hypothesis was spending a lot of time unsuccessfully simplifying things it wouldn’t stop in time. The timeout is now applied for unsuccessful simplifications too.
In Python 2.7, integers_from strategies would have failed during simplification with an OverflowError if their starting point was at or near to the maximum size of a 64-bit integer.
flatmap and map would have failed if called with a function without a __name__ attribute.
If max_examples was less than min_satisfying_examples this would always error. Now min_satisfying_examples is capped to max_examples. Note that if you have assumptions to satisfy here this will still cause an error.

Some minor quality improvements:

Lists of streams, flatmapped strategies and basic strategies should now now have slightly better simplification.

1.3.0 - 2015-05-22¶

New features:

New verbosity level API for printing intermediate results and exceptions.
New specifier for strings generated from a specified alphabet.
Better error messages for tests that are failing because of a lack of enough examples.

Bug fixes:

Fix error where use of ForkingTestCase would sometimes result in too many open files.
Fix error where saving a failing example that used flatmap could error.
Implement simplification for sampled_from, which apparently never supported it previously. Oops.

General improvements:

Better range of examples when using one_of or sampled_from.
Fix some pathological performance issues when simplifying lists of complex values.
Fix some pathological performance issues when simplifying examples that require unicode strings with high codepoints.
Random will now simplify to more readable examples.

1.2.1 - 2015-04-16¶

A small patch release for a bug in the new executors feature. Tests which require doing something to their result in order to fail would have instead reported as flaky.

1.2.0 - 2015-04-15¶

Codename: Finders keepers.

A bunch of new features and improvements.

Provide a mechanism for customizing how your tests are executed.
Provide a test runner that forks before running each example. This allows better support for testing native code which might trigger a segfault or a C level assertion failure.
Support for using Hypothesis to find examples directly rather than as just as a test runner.
New streaming type which lets you generate infinite lazily loaded streams of data - perfect for if you need a number of examples but don’t know how many.
Better support for large integer ranges. You can now use integers_in_range with ranges of basically any size. Previously large ranges would have eaten up all your memory and taken forever.
Integers produce a wider range of data than before - previously they would only rarely produce integers which didn’t fit into a machine word. Now it’s much more common. This percolates to other numeric types which build on integers.
Better validation of arguments to @given. Some situations that would previously have caused silently wrong behaviour will now raise an error.
Include +/- sys.float_info.max in the set of floating point edge cases that Hypothesis specifically tries.
Fix some bugs in floating point ranges which happen when given +/- sys.float_info.max as one of the endpoints… (really any two floats that are sufficiently far apart so that x, y are finite but y - x is infinite). This would have resulted in generating infinite values instead of ones inside the range.

1.1.1 - 2015-04-07¶

Codename: Nothing to see here

This is just a patch release put out because it fixed some internal bugs that would block the Django integration release but did not actually affect anything anyone could previously have been using. It also contained a minor quality fix for floats that I’d happened to have finished in time.

Fix some internal bugs with object lifecycle management that were impossible to hit with the previously released versions but broke hypothesis-django.
Bias floating point numbers somewhat less aggressively towards very small numbers

1.1.0 - 2015-04-06¶

Codename: No-one mention the M word.

Unicode strings are more strongly biased towards ascii characters. Previously they would generate all over the space. This is mostly so that people who try to shape their unicode strings with assume() have less of a bad time.
A number of fixes to data deserialization code that could theoretically have caused mysterious bugs when using an old version of a Hypothesis example database with a newer version. To the best of my knowledge a change that could have triggered this bug has never actually been seen in the wild. Certainly no-one ever reported a bug of this nature.
Out of the box support for Decimal and Fraction.
new dictionary specifier for dictionaries with variable keys.
Significantly faster and higher quality simplification, especially for collections of data.
New filter() and flatmap() methods on Strategy for better ways of building strategies out of other strategies.
New BasicStrategy class which allows you to define your own strategies from scratch without needing an existing matching strategy or being exposed to the full horror or non-public nature of the SearchStrategy interface.

1.0.0 - 2015-03-27¶

Codename: Blast-off!

There are no code changes in this release. This is precisely the 0.9.2 release with some updated documentation.

0.9.2 - 2015-03-26¶

Codename: T-1 days.

floats_in_range would not actually have produced floats_in_range unless that range happened to be (0, 1). Fix this.

0.9.1 - 2015-03-25¶

Codename: T-2 days.

Fix a bug where if you defined a strategy using map on a lambda then the results would not be saved in the database.
Significant performance improvements when simplifying examples using lists, strings or bounded integer ranges.

0.9.0 - 2015-03-23¶

Codename: The final countdown

This release could also be called 1.0-RC1.

It contains a teeny tiny bugfix, but the real point of this release is to declare feature freeze. There will be zero functionality changes between 0.9.0 and 1.0 unless something goes really really wrong. No new features will be added, no breaking API changes will occur, etc. This is the final shakedown before I declare Hypothesis stable and ready to use and throw a party to celebrate.

Bug bounty for any bugs found between now and 1.0: I will buy you a drink (alcoholic, caffeinated, or otherwise) and shake your hand should we ever find ourselves in the same city at the same time.

The one tiny bugfix:

Under pypy, databases would fail to close correctly when garbage collected, leading to a memory leak and a confusing error message if you were repeatedly creating databases and not closing them. It is very unlikely you were doing this and the chances of you ever having noticed this bug are very low.

0.7.2 - 2015-03-22¶

Codename: Hygienic macros or bust

You can now name an argument to @given ‘f’ and it won’t break (issue #38)
strategy_test_suite is now named strategy_test_suite as the documentation claims and not in fact strategy_test_suitee
Settings objects can now be used as a context manager to temporarily override the default values inside their context.

0.7.1 - 2015-03-21¶

Codename: Point releases go faster

Better string generation by parametrizing by a limited alphabet
Faster string simplification - previously if simplifying a string with high range unicode characters it would try every unicode character smaller than that. This was pretty pointless. Now it stops after it’s a short range (it can still reach smaller ones through recursive calls because of other simplifying operations).
Faster list simplification by first trying a binary chop down the middle
Simultaneous simplification of identical elements in a list. So if a bug only triggers when you have duplicates but you drew e.g. [-17, -17], this will now simplify to [0, 0].

0.7.0, - 2015-03-20¶

Codename: Starting to look suspiciously real

This is probably the last minor release prior to 1.0. It consists of stability improvements, a few usability things designed to make Hypothesis easier to try out, and filing off some final rough edges from the API.

Significant speed and memory usage improvements
Add an example() method to strategy objects to give an example of the sort of data that the strategy generates.
Remove .descriptor attribute of strategies
Rename descriptor_test_suite to strategy_test_suite
Rename the few remaining uses of descriptor to specifier (descriptor already has a defined meaning in Python)

0.6.0 - 2015-03-13¶

Codename: I’m sorry, were you using that API?

This is primarily a “simplify all the weird bits of the API” release. As a result there are a lot of breaking changes. If you just use @given with core types then you’re probably fine.

In particular:

Stateful testing has been removed from the API
The way the database is used has been rendered less useful (sorry). The feature for reassembling values saved from other tests doesn’t currently work. This will probably be brought back in post 1.0.
SpecificationMapper is no longer a thing. Instead there is an ExtMethod called strategy which you extend to specify how to convert other types to strategies.
Settings are now extensible so you can add your own for configuring a strategy
MappedSearchStrategy no longer needs an unpack method
Basically all the SearchStrategy internals have changed massively. If you implemented SearchStrategy directly rather than using MappedSearchStrategy talk to me about fixing it.
Change to the way extra packages work. You now specify the package. This must have a load() method. Additionally any modules in the package will be loaded in under hypothesis.extra

Bug fixes:

Fix for a bug where calling falsify on a lambda with a non-ascii character in its body would error.

Hypothesis Extra:

hypothesis-fakefactory: An extension for using faker data in hypothesis. Depends: on fake-factory.

0.5.0 - 2015-02-10¶

Codename: Read all about it.

Core hypothesis:

Add support back in for pypy and python 3.2
@given functions can now be invoked with some arguments explicitly provided. If all arguments that hypothesis would have provided are passed in then no falsification is run.
Related to the above, this means that you can now use pytest fixtures and mark.parametrize with Hypothesis without either interfering with the other.
Breaking change: @given no longer works for functions with varargs (varkwargs are fine). This might be added back in at a later date.
Windows is now fully supported. A limited version (just the tests with none of the extras) of the test suite is run on windows with each commit so it is now a first class citizen of the Hypothesis world.
Fix a bug for fuzzy equality of equal complex numbers with different reprs (this can happen when one coordinate is zero). This shouldn’t affect users - that feature isn’t used anywhere public facing.
Fix generation of floats on windows and 32-bit builds of python. I was using some struct.pack logic that only worked on certain word sizes.
When a test times out and hasn’t produced enough examples this now raises a Timeout subclass of Unfalsifiable.
Small search spaces are better supported. Previously something like a @given(bool, bool) would have failed because it couldn’t find enough examples. Hypothesis is now aware of the fact that these are small search spaces and will not error in this case.
Improvements to parameter search in the case of hard to satisfy assume. Hypothesis will now spend less time exploring parameters that are unlikely to provide anything useful.
Increase chance of generating “nasty” floats
Fix a bug that would have caused unicode warnings if you had a sampled_from that was mixing unicode and byte strings.
Added a standard test suite that you can use to validate a custom strategy you’ve defined is working correctly.

Hypothesis extra:

First off, introducing Hypothesis extra packages!

These are packages that are separated out from core Hypothesis because they have one or more dependencies. Every hypothesis-extra package is pinned to a specific point release of Hypothesis and will have some version requirements on its dependency. They use entry_points so you will usually not need to explicitly import them, just have them installed on the path.

This release introduces two of them:

hypothesis-datetime:

Does what it says on the tin: Generates datetimes for Hypothesis. Just install the package and datetime support will start working.

Depends on pytz for timezone support

hypothesis-pytest:

A very rudimentary pytest plugin. All it does right now is hook the display of falsifying examples into pytest reporting.

Depends on pytest.

0.4.3 - 2015-02-05¶

Codename: TIL narrow Python builds are a thing

This just fixes the one bug.

Apparently there is such a thing as a “narrow python build” and OS X ships with these by default for python 2.7. These are builds where you only have two bytes worth of unicode. As a result, generating unicode was completely broken on OS X. Fix this by only generating unicode codepoints in the range supported by the system.

0.4.2 - 2015-02-04¶

Codename: O(dear)

This is purely a bugfix release:

Provide sensible external hashing for all core types. This will significantly improve performance of tracking seen examples which happens in literally every falsification run. For Hypothesis fixing this cut 40% off the runtime of the test suite. The behaviour is quadratic in the number of examples so if you’re running the default configuration this will be less extreme (Hypothesis’s test suite runs at a higher number of examples than default), but you should still see a significant improvement.
Fix a bug in formatting of complex numbers where the string could get incorrectly truncated.

0.4.1 - 2015-02-03¶

Codename: Cruel and unusual edge cases

This release is mostly about better test case generation.

Enhancements:

Has a cool release name
text_type (str in python 3, unicode in python 2) example generation now actually produces interesting unicode instead of boring ascii strings.
floating point numbers are generated over a much wider range, with particular attention paid to generating nasty numbers - nan, infinity, large and small values, etc.
examples can be generated using pieces of examples previously saved in the database. This allows interesting behaviour that has previously been discovered to be propagated to other examples.
improved parameter exploration algorithm which should allow it to more reliably hit interesting edge cases.
Timeout can now be disabled entirely by setting it to any value <= 0.

Bug fixes:

The descriptor on a OneOfStrategy could be wrong if you had descriptors which were equal but should not be coalesced. e.g. a strategy for one_of((frozenset({int}), {int})) would have reported its descriptor as {int}. This is unlikely to have caused you any problems
If you had strategies that could produce NaN (which float previously couldn’t but e.g. a Just(float(‘nan’)) could) then this would have sent hypothesis into an infinite loop that would have only been terminated when it hit the timeout.
Given elements that can take a long time to minimize, minimization of floats or tuples could be quadratic or worse in the that value. You should now see much better performance for simplification, albeit at some cost in quality.

Other:

A lot of internals have been been rewritten. This shouldn’t affect you at all, but it opens the way for certain of hypothesis’s oddities to be a lot more extensible by users. Whether this is a good thing may be up for debate…

0.4.0 - 2015-01-21¶

FLAGSHIP FEATURE: Hypothesis now persists examples for later use. It stores data in a local SQLite database and will reuse it for all tests of the same type.

LICENSING CHANGE: Hypothesis is now released under the Mozilla Public License 2.0. This applies to all versions from 0.4.0 onwards until further notice. The previous license remains applicable to all code prior to 0.4.0.

Enhancements:

Printing of failing examples. I was finding that the pytest runner was not doing a good job of displaying these, and that Hypothesis itself could do much better.
Drop dependency on six for cross-version compatibility. It was easy enough to write the shim for the small set of features that we care about and this lets us avoid a moderately complex dependency.
Some improvements to statistical distribution of selecting from small (<= 3 elements)
Improvements to parameter selection for finding examples.

Bugs fixed:

could_have_produced for lists, dicts and other collections would not have examined the elements and thus when using a union of different types of list this could result in Hypothesis getting confused and passing a value to the wrong strategy. This could potentially result in exceptions being thrown from within simplification.
sampled_from would not work correctly on a single element list.
Hypothesis could get very confused by values which are equal despite having different types being used in descriptors. Hypothesis now has its own more specific version of equality it uses for descriptors and tracking. It is always more fine grained than Python equality: Things considered != are not considered equal by hypothesis, but some things that are considered == are distinguished. If your test suite uses both frozenset and set tests this bug is probably affecting you.

0.3.2 - 2015-01-16¶

Fix a bug where if you specified floats_in_range with integer arguments Hypothesis would error in example simplification.
Improve the statistical distribution of the floats you get for the floats_in_range strategy. I’m not sure whether this will affect users in practice but it took my tests for various conditions from flaky to rock solid so it at the very least improves discovery of the artificial cases I’m looking for.
Improved repr() for strategies and RandomWithSeed instances.
Add detection for flaky test cases where hypothesis managed to find an example which breaks it but on the final invocation of the test it does not raise an error. This will typically happen with too much recursion errors but could conceivably happen in other circumstances too.
Provide a “derandomized” mode. This allows you to run hypothesis with zero real randomization, making your build nice and deterministic. The tests run with a seed calculated from the function they’re testing so you should still get a good distribution of test cases.
Add a mechanism for more conveniently defining tests which just sample from some collection.
Fix for a really subtle bug deep in the internals of the strategy table. In some circumstances if you were to define instance strategies for both a parent class and one or more of its subclasses you would under some circumstances get the strategy for the wrong superclass of an instance. It is very unlikely anyone has ever encountered this in the wild, but it is conceivably possible given that a mix of namedtuple and tuple are used fairly extensively inside hypothesis which do exhibit this pattern of strategy.

0.3.1 - 2015-01-13¶

Support for generation of frozenset and Random values
Correct handling of the case where a called function mutates it argument. This involved introducing a notion of a strategies knowing how to copy their argument. The default method should be entirely acceptable and the worst case is that it will continue to have the old behaviour if you don’t mark your strategy as mutable, so this shouldn’t break anything.
Fix for a bug where some strategies did not correctly implement could_have_produced. It is very unlikely that any of these would have been seen in the wild, and the consequences if they had been would have been minor.
Re-export the @given decorator from the main hypothesis namespace. It’s still available at the old location too.
Minor performance optimisation for simplifying long lists.

0.3.0 - 2015-01-12¶

Complete redesign of the data generation system. Extreme breaking change for anyone who was previously writing their own SearchStrategy implementations. These will not work any more and you’ll need to modify them.
New settings system allowing more global and modular control of Verifier behaviour.
Decouple SearchStrategy from the StrategyTable. This leads to much more composable code which is a lot easier to understand.
A significant amount of internal API renaming and moving. This may also break your code.
Expanded available descriptors, allowing for generating integers or floats in a specific range.
Significantly more robust. A very large number of small bug fixes, none of which anyone is likely to have ever noticed.
Deprecation of support for pypy and python 3 prior to 3.3. 3.3 and 3.4. Supported versions are 2.7.x, 3.3.x, 3.4.x. I expect all of these to remain officially supported for a very long time. I would not be surprised to add pypy support back in later but I’m not going to do so until I know someone cares about it. In the meantime it will probably still work.

0.2.2 - 2015-01-08¶

Fix an embarrassing complete failure of the installer caused by my being bad at version control

0.2.1 - 2015-01-07¶

Fix a bug in the new stateful testing feature where you could make __init__ a @requires method. Simplification would not always work if the prune method was able to successfully shrink the test.

0.2.0 - 2015-01-07¶

It’s aliiive.
Improve python 3 support using six.
Distinguish between byte and unicode types.
Fix issues where FloatStrategy could raise.
Allow stateful testing to request constructor args.
Fix for issue where test annotations would timeout based on when the module was loaded instead of when the test started

0.1.4 - 2013-12-14¶

Make verification runs time bounded with a configurable timeout

0.1.3 - 2013-05-03¶

Bugfix: Stateful testing behaved incorrectly with subclassing.
Complex number support
support for recursive strategies
different error for hypotheses with unsatisfiable assumptions

0.1.2 - 2013-03-24¶

Bugfix: Stateful testing was not minimizing correctly and could throw exceptions.
Better support for recursive strategies.
Support for named tuples.
Much faster integer generation.

0.1.1 - 2013-03-24¶

Python 3.x support via 2to3.
Use new style classes (oops).

0.1.0 - 2013-03-23¶

Introduce stateful testing.
Massive rewrite of internals to add flags and strategies.

0.0.5 - 2013-03-13¶

No changes except trying to fix packaging

0.0.4 - 2013-03-13¶

No changes except that I checked in a failing test case for 0.0.3 so had to replace the release. Doh

0.0.3 - 2013-03-13¶

Improved a few internals.
Opened up creating generators from instances as a general API.
Test integration.

0.0.2 - 2013-03-12¶

Starting to tighten up on the internals.
Change API to allow more flexibility in configuration.
More testing.

0.0.1 - 2013-03-10¶

Initial release.
Basic working prototype. Demonstrates idea, probably shouldn’t be used.