rename to add_observability_callback

Author: tybug

hypothesis-python/docs/prolog.rst

@@ -117,7 +117,7 @@
 .. |PrimitiveProvider.draw_bytes| replace:: :func:`~hypothesis.internal.conjecture.providers.PrimitiveProvider.draw_bytes`
 .. |PrimitiveProvider.on_observation| replace:: :func:`~hypothesis.internal.conjecture.providers.PrimitiveProvider.on_observation`
 .. |PrimitiveProvider.per_test_case_context_manager| replace:: :func:`~hypothesis.internal.conjecture.providers.PrimitiveProvider.per_test_case_context_manager`
-.. |PrimitiveProvider.add_observation_callback| replace:: :data:`~hypothesis.internal.conjecture.providers.PrimitiveProvider.add_observation_callback`
+.. |PrimitiveProvider.add_observability_callback| replace:: :data:`~hypothesis.internal.conjecture.providers.PrimitiveProvider.add_observability_callback`
 
 .. |AVAILABLE_PROVIDERS| replace:: :data:`~hypothesis.internal.conjecture.providers.AVAILABLE_PROVIDERS`
 .. |TESTCASE_CALLBACKS| replace:: :data:`~hypothesis.internal.observability.TESTCASE_CALLBACKS`

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

@@ -833,6 +833,7 @@ def debug_data(self, data: Union[ConjectureData, ConjectureResult]) -> None:
 
     def observe_for_provider(self) -> AbstractContextManager:
         def on_observation(observation: Observation) -> None:
+            assert observation.type == "test_case"
             # because lifetime == "test_function"
             assert isinstance(self.provider, PrimitiveProvider)
             # only fire if we actually used that provider to generate this observation
@@ -849,7 +850,7 @@ def on_observation(observation: Observation) -> None:
                 # by this isinstance check)
                 and isinstance(self.provider, PrimitiveProvider)
                 # and the provider opted-in to observations
-                and self.provider.add_observation_callback
+                and self.provider.add_observability_callback
             )
             else nullcontext()
         )

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

@@ -63,7 +63,7 @@
     next_up,
 )
 from hypothesis.internal.intervalsets import IntervalSet
-from hypothesis.internal.observability import InfoObservationType, Observation
+from hypothesis.internal.observability import InfoObservationType, TestCaseObservation
 
 if TYPE_CHECKING:
     from typing import TypeAlias
@@ -364,7 +364,7 @@ class PrimitiveProvider(abc.ABC):
     #:
     #: The opt-in behavior of observability is because enabling observability
     #: might increase runtime or memory usage.
-    add_observation_callback: ClassVar[bool] = False
+    add_observability_callback: ClassVar[bool] = False
 
     def __init__(self, conjecturedata: Optional["ConjectureData"], /) -> None:
         self._cd = conjecturedata
@@ -554,7 +554,7 @@ def observe_information_messages(
         assert lifetime in ("test_case", "test_function")
         yield from []
 
-    def on_observation(self, observation: Observation) -> None:  # noqa: B027
+    def on_observation(self, observation: TestCaseObservation) -> None:  # noqa: B027
         """
         Called at the end of each test case which uses this provider, with the same
         ``observation["type"] == "test_case"`` observation that is passed to
@@ -564,7 +564,7 @@ def on_observation(self, observation: Observation) -> None:  # noqa: B027
         .. important::
 
             For |PrimitiveProvider.on_observation| to be called by Hypothesis,
-            |PrimitiveProvider.add_observation_callback| must be set to ``True``,
+            |PrimitiveProvider.add_observability_callback| must be set to ``True``,
 
             |PrimitiveProvider.on_observation| is explicitly opt-in, as enabling
             observability might increase runtime or memory usage.

hypothesis-python/tests/conjecture/test_alt_backend.py

@@ -722,7 +722,7 @@ def test_replay_choices():
 
 
 class ObservationProvider(TrivialProvider):
-    add_observation_callback = True
+    add_observability_callback = True
 
     def __init__(self, conjecturedata: "ConjectureData", /) -> None:
         super().__init__(conjecturedata)