Make timeout setting a no-op

Author: Zac-HD

hypothesis-python/docs/settings.rst

@@ -216,46 +216,3 @@ by your conftest you can load one with the command line option ``--hypothesis-pr
 .. code:: bash
 
     $ pytest tests --hypothesis-profile <profile-name>
-
-
-~~~~~~~~
-Timeouts
-~~~~~~~~
-
-The timeout functionality of Hypothesis is being deprecated, and will
-eventually be removed. For the moment, the timeout setting can still be set
-and the old default timeout of one minute remains.
-
-If you want to future proof your code you can get
-the future behaviour by setting it to the value ``hypothesis.unlimited``.
-
-.. code:: python
-
-    from hypothesis import given, settings, unlimited
-    from hypothesis import strategies as st
-
-    @settings(timeout=unlimited)
-    @given(st.integers())
-    def test_something_slow(i):
-        ...
-
-This will cause your code to run until it hits the normal Hypothesis example
-limits, regardless of how long it takes. ``timeout=unlimited`` will remain a
-valid setting after the timeout functionality has been deprecated (but will
-then have its own deprecation cycle).
-
-There is however now a timing related health check which is designed to catch
-tests that run for ages by accident. If you really want your test to run
-forever, the following code will enable that:
-
-.. code:: python
-
-    from hypothesis import given, settings, unlimited, HealthCheck
-    from hypothesis import strategies as st
-
-    @settings(timeout=unlimited, suppress_health_check=[
-        HealthCheck.hung_test
-    ])
-    @given(st.integers())
-    def test_something_slow(i):
-        ...

hypothesis-python/scripts/unicodechecker.py

@@ -25,7 +25,6 @@
 
 import unicodenazi
 
-from hypothesis import settings, unlimited
 from hypothesis.configuration import set_hypothesis_home_dir
 from hypothesis.errors import HypothesisDeprecationWarning
 
@@ -36,12 +35,6 @@
 
 set_hypothesis_home_dir(mkdtemp())
 
-assert isinstance(settings, type)
-
-settings.register_profile("default", settings(timeout=unlimited))
-settings.load_profile("default")
-
-
 TESTS = ["test_testdecorators"]
 
 sys.path.append(os.path.join("tests", "cover"))

hypothesis-python/src/hypothesis/_settings.py

@@ -304,7 +304,6 @@ def _define_setting(
         future_default=not_set,
         deprecation_message=None,
         deprecated_since=None,
-        hide_repr=not_set,
     ):
         """Add a new setting.
 
@@ -326,9 +325,6 @@ def _define_setting(
         if future_default is not_set:
             future_default = default
 
-        if hide_repr is not_set:
-            hide_repr = bool(deprecation_message)
-
         all_settings[name] = Setting(
             name=name,
             description=description.strip(),
@@ -338,7 +334,6 @@ def _define_setting(
             future_default=future_default,
             deprecation_message=deprecation_message,
             deprecated_since=deprecated_since,
-            hide_repr=hide_repr,
         )
         setattr(settings, name, settingsProperty(name, show_default))
 
@@ -372,7 +367,7 @@ def __repr__(self):
             value = getattr(self, name)
             # The only settings that are not shown are those that are
             # deprecated and left at their default values.
-            if value != setting.default or not setting.hide_repr:
+            if value != setting.default or not setting.deprecation_message:
                 bits.append("%s=%r" % (name, value))
         return "settings(%s)" % ", ".join(sorted(bits))
 
@@ -473,7 +468,6 @@ class Setting(object):
     future_default = attr.ib()
     deprecation_message = attr.ib()
     deprecated_since = attr.ib()
-    hide_repr = attr.ib()
 
 
 settings._define_setting(
@@ -539,31 +533,17 @@ class Setting(object):
 
 
 def _validate_timeout(n):
-    if n is unlimited:
-        return -1
-    else:
+    if n in (not_set, unlimited):
         return n
+    raise InvalidArgument("The timeout setting has been removed.")
 
 
 settings._define_setting(
     "timeout",
-    default=60,
-    description="""
-Once this many seconds have passed, falsify will terminate even
-if it has not found many examples. This is a soft rather than a hard
-limit - Hypothesis won't e.g. interrupt execution of the called
-function to stop it. If this value is <= 0 then no timeout will be
-applied.
-""",
-    hide_repr=False,  # Still affects behaviour at runtime
-    deprecation_message="""
-The timeout setting is deprecated and will be removed in a future version of
-Hypothesis. To get the future behaviour set ``timeout=hypothesis.unlimited``
-instead (which will remain valid for a further deprecation period after this
-setting has gone away).
-""",
+    default=not_set,
+    description="The timeout setting has been deprecated and no longer does anything.",
+    deprecation_message="The timeout setting can safely be removed with no effect.",
     deprecated_since="2017-11-02",
-    future_default=unlimited,
     validator=_validate_timeout,
 )
 

hypothesis-python/src/hypothesis/core.py

@@ -55,7 +55,6 @@
     InvalidArgument,
     MultipleFailures,
     NoSuchExample,
-    Timeout,
     Unsatisfiable,
     UnsatisfiedAssumption,
 )
@@ -647,7 +646,6 @@ def run(self):
             database_key = function_digest(self.test)
         else:
             database_key = None
-        self.start_time = benchmark_time()
         runner = ConjectureRunner(
             self.evaluate_test_data,
             settings=self.settings,
@@ -659,7 +657,6 @@ def run(self):
         finally:
             self.used_examples_from_database = runner.used_examples_from_database
         note_engine_for_statistics(runner)
-        run_time = benchmark_time() - self.start_time
 
         self.used_examples_from_database = runner.used_examples_from_database
 
@@ -687,7 +684,6 @@ def run(self):
                     since="2017-11-29",
                 )
 
-        timed_out = runner.exit_reason == ExitReason.timeout
         if runner.call_count == 0:
             return
         if runner.interesting_examples:
@@ -698,23 +694,10 @@ def run(self):
             )
         else:
             if runner.valid_examples == 0:
-                if timed_out:
-                    raise Timeout(
-                        (
-                            "Ran out of time before finding a satisfying "
-                            "example for %s. Only found %d examples in %.2fs."
-                        )
-                        % (
-                            get_pretty_function_description(self.test),
-                            runner.valid_examples,
-                            run_time,
-                        )
-                    )
-                else:
-                    raise Unsatisfiable(
-                        "Unable to satisfy assumptions of hypothesis %s."
-                        % (get_pretty_function_description(self.test),)
-                    )
+                raise Unsatisfiable(
+                    "Unable to satisfy assumptions of hypothesis %s."
+                    % (get_pretty_function_description(self.test),)
+                )
 
         if not self.falsifying_examples:
             return
@@ -1142,13 +1125,11 @@ def template_condition(data):
         if success and not data.frozen:
             data.mark_interesting()
 
-    start = benchmark_time()
     runner = ConjectureRunner(
         template_condition, settings=settings, random=random, database_key=database_key
     )
     runner.run()
     note_engine_for_statistics(runner)
-    run_time = benchmark_time() - start
     if runner.interesting_examples:
         data = ConjectureData.for_buffer(
             list(runner.interesting_examples.values())[0].buffer
@@ -1157,23 +1138,9 @@ def template_condition(data):
             with deterministic_PRNG():
                 return data.draw(search)
     if runner.valid_examples == 0 and (runner.exit_reason != ExitReason.finished):
-        if settings.timeout > 0 and run_time > settings.timeout:
-            raise Timeout(
-                (  # pragma: no cover
-                    "Ran out of time before finding enough valid examples for "
-                    "%s. Only %d valid examples found in %.2f seconds."
-                )
-                % (
-                    get_pretty_function_description(condition),
-                    runner.valid_examples,
-                    run_time,
-                )
-            )
-
-        else:
-            raise Unsatisfiable(
-                "Unable to satisfy assumptions of %s."
-                % (get_pretty_function_description(condition),)
-            )
+        raise Unsatisfiable(
+            "Unable to satisfy assumptions of %s."
+            % (get_pretty_function_description(condition),)
+        )
 
     raise NoSuchExample(get_pretty_function_description(condition))

hypothesis-python/src/hypothesis/internal/conjecture/engine.py

@@ -24,7 +24,7 @@
 import attr
 
 from hypothesis import HealthCheck, Phase, Verbosity, settings as Settings
-from hypothesis._settings import local_settings, note_deprecation
+from hypothesis._settings import local_settings
 from hypothesis.internal.compat import (
     Counter,
     benchmark_time,
@@ -70,7 +70,6 @@ class HealthCheckState(object):
 class ExitReason(Enum):
     max_examples = 0
     max_iterations = 1
-    timeout = 2
     max_shrinks = 3
     finished = 4
     flaky = 5
@@ -213,26 +212,6 @@ def test_function(self, data):
 
             if self.shrinks >= MAX_SHRINKS:
                 self.exit_with(ExitReason.max_shrinks)
-        if (
-            self.settings.timeout > 0
-            and benchmark_time() >= self.start_time + self.settings.timeout
-        ):
-            note_deprecation(
-                (
-                    "Your tests are hitting the settings timeout (%.2fs). "
-                    "This functionality will go away in a future release "
-                    "and you should not rely on it. Instead, try setting "
-                    "max_examples to be some value lower than %d (the number "
-                    "of examples your test successfully ran here). Or, if you "
-                    "would prefer your tests to run to completion, regardless "
-                    "of how long they take, you can set the timeout value to "
-                    "hypothesis.unlimited."
-                )
-                % (self.settings.timeout, self.valid_examples),
-                since="2018-07-29",
-                verbosity=self.settings.verbosity,
-            )
-            self.exit_with(ExitReason.timeout)
 
         if not self.interesting_examples:
             if self.valid_examples >= self.settings.max_examples:

hypothesis-python/src/hypothesis/stateful.py

@@ -39,7 +39,6 @@
     Verbosity,
     note_deprecation,
     settings as Settings,
-    unlimited,
 )
 from hypothesis.control import current_build_context
 from hypothesis.core import given
@@ -83,11 +82,7 @@ def run_state_machine_as_test(state_machine_factory, settings=None):
             settings = state_machine_factory.TestCase.settings
             check_type(Settings, settings, "state_machine_factory.TestCase.settings")
         except AttributeError:
-            settings = Settings(
-                timeout=unlimited,
-                deadline=None,
-                suppress_health_check=HealthCheck.all(),
-            )
+            settings = Settings(deadline=None, suppress_health_check=HealthCheck.all())
     check_type(Settings, settings, "settings")
 
     @settings
@@ -229,11 +224,7 @@ def _to_test_case(state_machine_class):
             pass
 
         class StateMachineTestCase(TestCase):
-            settings = Settings(
-                timeout=unlimited,
-                deadline=None,
-                suppress_health_check=HealthCheck.all(),
-            )
+            settings = Settings(deadline=None, suppress_health_check=HealthCheck.all())
 
         # We define this outside of the class and assign it because you can't
         # assign attributes to instance method values in Python 2

hypothesis-python/tests/common/debug.py

@@ -17,7 +17,7 @@
 
 from __future__ import absolute_import, division, print_function
 
-from hypothesis import assume, find, given, reject, settings as Settings, unlimited
+from hypothesis import assume, find, given, reject, settings as Settings
 from hypothesis.errors import NoSuchExample, Unsatisfiable
 from tests.common.utils import no_shrink
 
@@ -29,7 +29,7 @@ class Timeout(BaseException):
 
 
 def minimal(definition, condition=None, settings=None, timeout_after=10, random=None):
-    settings = Settings(settings, max_examples=50000, database=None, timeout=unlimited)
+    settings = Settings(settings, max_examples=50000, database=None)
 
     runtime = []
 
@@ -53,9 +53,7 @@ def wrapped_condition(x):
 
 
 def find_any(definition, condition=None, settings=None, random=None):
-    settings = Settings(
-        settings, max_examples=10000, phases=no_shrink, database=None, timeout=unlimited
-    )
+    settings = Settings(settings, max_examples=10000, phases=no_shrink, database=None)
 
     if condition is None:
 

hypothesis-python/tests/common/setup.py

@@ -21,7 +21,7 @@
 from tempfile import mkdtemp
 from warnings import filterwarnings
 
-from hypothesis import Verbosity, settings, unlimited
+from hypothesis import Verbosity, settings
 from hypothesis._settings import not_set
 from hypothesis.configuration import set_hypothesis_home_dir
 from hypothesis.internal.charmap import charmap, charmap_file
@@ -84,8 +84,7 @@ def run():
             )
 
     settings.register_profile(
-        "default",
-        settings(max_examples=10 if IN_COVERAGE_TESTS else not_set, timeout=unlimited),
+        "default", settings(max_examples=10 if IN_COVERAGE_TESTS else not_set)
     )
 
     settings.register_profile("speedy", settings(max_examples=5))