Merge pull request #4539 from Liam-DeVoe/next2

Improve error message for `DeadlineExceeded`

Author: Liam-DeVoe

hypothesis-python/RELEASE.rst

@@ -0,0 +1,3 @@
+RELEASE_TYPE: patch
+
+Improved error message for |DeadlineExceeded|.

hypothesis-python/docs/index.rst

@@ -56,7 +56,7 @@ Hypothesis is the property-based testing library for Python. With Hypothesis, yo
 
     test_sort_correct()
 
-You should start with the :doc:`tutorial <tutorial/index>`, or the more condensed :doc:`quickstart <quickstart>`.
+You should start with the :doc:`tutorial <tutorial/index>`, or alternatively the more condensed :doc:`quickstart <quickstart>`.
 
 .. rst-class:: row
 

hypothesis-python/src/hypothesis/errors.py

@@ -243,7 +243,9 @@ class DeadlineExceeded(_Trimmable):
     def __init__(self, runtime: timedelta, deadline: timedelta) -> None:
         super().__init__(
             f"Test took {runtime.total_seconds() * 1000:.2f}ms, which exceeds "
-            f"the deadline of {deadline.total_seconds() * 1000:.2f}ms"
+            f"the deadline of {deadline.total_seconds() * 1000:.2f}ms. If you "
+            "expect test cases to take this long, you can use @settings(deadline=...) "
+            "to either set a higher deadline, or to disable it with deadline=None."
         )
         self.runtime = runtime
         self.deadline = deadline

hypothesis-python/tests/nocover/test_stateful.py

@@ -63,10 +63,10 @@ def split(self, left, right):
     def test_is_balanced(self, tree):
         if isinstance(tree, Leaf):
             return
-        else:
-            assert abs(self.size(tree.left) - self.size(tree.right)) <= 1
-            self.test_is_balanced(tree.left)
-            self.test_is_balanced(tree.right)
+
+        assert abs(self.size(tree.left) - self.size(tree.right)) <= 1
+        self.test_is_balanced(tree.left)
+        self.test_is_balanced(tree.right)
 
     def size(self, tree):
         if isinstance(tree, Leaf):
@@ -108,13 +108,10 @@ def bunch(self, source):
 
     @rule(source=nodes)
     def shallow(self, source):
-        def d(ls):
-            if not ls:
-                return 0
-            else:
-                return 1 + max(map(d, ls))
+        def depth(ls):
+            return 0 if not ls else 1 + max(map(depth, ls))
 
-        assert d(source) <= 5
+        assert depth(source) <= 5
 
 
 class NotTheLastMachine(RuleBasedStateMachine):
@@ -166,11 +163,7 @@ def __init__(self):
         super().__init__()
         self.seen = set()
 
-    # The reason this rule takes a parameter is that it ensures that we do not
-    # achieve "swarming" by by just restricting the alphabet for single byte
-    # decisions, which is a thing the underlying conjecture engine  will
-    # happily do on its own without knowledge of the rule structure.
-    @rule(move=st.integers(0, 255))
+    @rule(move=st.integers())
     def ladder(self, move):
         self.seen.add(move)
         assert len(self.seen) <= 15
@@ -190,16 +183,12 @@ def snake(self):
 )
 
 for m in bad_machines:
-    m.TestCase.settings = Settings(m.TestCase.settings, max_examples=1000)
-
-
-cheap_bad_machines = list(bad_machines)
-cheap_bad_machines.remove(BalancedTrees)
-
-
-with_cheap_bad_machines = pytest.mark.parametrize(
-    "machine", cheap_bad_machines, ids=[t.__name__ for t in cheap_bad_machines]
-)
+    m.TestCase.settings = Settings(
+        m.TestCase.settings,
+        max_examples=1000,
+        database=None,
+        phases=set(Phase) - {Phase.shrink},
+    )
 
 
 @pytest.mark.parametrize(
@@ -213,14 +202,8 @@ def test_bad_machines_fail(machine):
         # and also takes 10/6 minutes respectively, on top of not finding the failure
         pytest.xfail(reason=str(Why.undiscovered))
 
-    test_class = machine.TestCase
-    try:
-        test_class().runTest()
-        raise RuntimeError("Expected an assertion error")
-    except AssertionError as err:
-        notes = err.__notes__
-    steps = [l for l in notes if "Step " in l or "state." in l]
-    assert 1 <= len(steps) <= 50
+    with pytest.raises(AssertionError):
+        machine.TestCase().runTest()
 
 
 class MyStatefulMachine(RuleBasedStateMachine):

hypothesis-python/tests/patching/test_patching.py

@@ -190,6 +190,22 @@ def test_no_example_for_data_strategy():
     assert get_patch_for(fn, [("fn(Foo(data=data(...)))", "msg")]) is not None
 
 
+def test_patch_order_preserved():
+    (_fname, _before, after) = get_patch_for(
+        fn, [("fn(a=1)", "msg"), ("fn(b=2)", "msg")]
+    )
+    assert after.startswith(
+        '@given(st.integers())\n@example(a=1).via("msg")\n@example(b=2).via("msg")'
+    )
+
+    (_fname, _before, after) = get_patch_for(
+        fn, [("fn(b=2)", "msg"), ("fn(a=1)", "msg")]
+    )
+    assert after.startswith(
+        '@given(st.integers())\n@example(b=2).via("msg")\n@example(a=1).via("msg")'
+    )
+
+
 def test_deduplicates_examples():
     tst, example, expected = SIMPLE
     where, _, after = get_patch_for(tst, [example, example])