Merge pull request #4799 from zhangli091011/fix/issue-4402-symbolic-data-repr

Show data(...) for symbolic data arguments

Author: Zac-HD

AUTHORS.rst

@@ -206,3 +206,4 @@ their individual contributions.
 * `Yiyang Zhan <https://www.github.com/zhanpon>`_
 * `Zac Hatfield-Dodds <https://www.github.com/Zac-HD>`_ (zac.hatfield.dodds@gmail.com)
 * `Zebulun Arendsee <https://www.github.com/arendsee>`_ (zbwrnz@gmail.com)
+* `zhangli091011 <https://github.com/zhangli091011>`_

hypothesis/RELEASE.rst

@@ -0,0 +1,6 @@
+RELEASE_TYPE: patch
+
+This release improves observability output under symbolic backends by displaying
+arguments generated by :func:`~hypothesis.strategies.data` as ``data(...)``.
+
+Thanks to zhangli091011 for this fix!

hypothesis/src/hypothesis/core.py

@@ -936,6 +936,11 @@ def __init__(
         self.print_given_args = getattr(
             wrapped_test, "_hypothesis_internal_print_given_args", True
         )
+        self.known_safe_to_repr = {
+            name
+            for name, strategy in stuff.given_kwargs.items()
+            if strategy == st.data()
+        }
 
         self.last_exception = None
         self.falsifying_examples = ()
@@ -1083,6 +1088,7 @@ def run(data: ConjectureData) -> None:
                             else None
                         ),
                         avoid_realization=data.provider.avoid_realization,
+                        known_safe_to_repr=self.known_safe_to_repr,
                     )
                 report(printer.getvalue())
 
@@ -1100,6 +1106,7 @@ def run(data: ConjectureData) -> None:
                         else None
                     ),
                     avoid_realization=data.provider.avoid_realization,
+                    known_safe_to_repr=self.known_safe_to_repr,
                 )
                 self._string_repr = printer.getvalue()
 

hypothesis/src/hypothesis/vendor/pretty.py

@@ -70,7 +70,7 @@ def _repr_pretty_(self, p, cycle):
 import types
 import warnings
 from collections import Counter, OrderedDict, defaultdict, deque
-from collections.abc import Callable, Generator, Iterable, Sequence
+from collections.abc import Callable, Collection, Generator, Iterable, Sequence
 from contextlib import contextmanager, suppress
 from enum import Enum, Flag
 from functools import partial
@@ -554,6 +554,7 @@ def repr_call(
         arg_slices: ArgLabelsT | None = None,
         leading_comment: str | None = None,
         avoid_realization: bool = False,
+        known_safe_to_repr: Collection[str] = (),
     ) -> None:
         """Helper function to represent a function call.
 
@@ -619,7 +620,7 @@ def repr_call(
                 entry = comments.get(label)
                 if entry:
                     self._commented_slices.add(entry[1])
-                if avoid_realization:
+                if avoid_realization and label not in known_safe_to_repr:
                     self.text("<symbolic>")
                 else:
                     self.pretty(v)

hypothesis/tests/conjecture/test_provider.py

@@ -478,6 +478,9 @@ def test_function(data):
 
         with capture_out() as out:
             test_function()
+        assert (
+            "Trying example: test_function(\n    data=data(...),\n)" in out.getvalue()
+        )
         assert "Draw 1: <symbolic>" in out.getvalue()
 
 
@@ -496,9 +499,8 @@ def test_function(data):
     assert {tc.representation for tc in test_cases} == {
         # from the first ChoiceTemplate(type="simplest") example
         "test_function(\n    data=data(...),\n)\nDraw 1: 0",
-        # from all other examples. data=<symbolic> isn't ideal; we should special
-        # case this as data=data(...).
-        f"test_function(\n    data=<symbolic>,\n)\nDraw 1: {RealizeProvider.REALIZED}",
+        # from all other examples
+        f"test_function(\n    data=data(...),\n)\nDraw 1: {RealizeProvider.REALIZED}",
     }
 
 

hypothesis/tests/cover/test_observability.py

@@ -186,10 +186,9 @@ def f(data):
     with capture_observations() as observations:
         f()
 
-    crosshair = settings.get_current_profile_name() == "crosshair"
-    expected = textwrap.dedent(f"""
+    expected = textwrap.dedent("""
         f(
-            data={'<symbolic>' if crosshair else 'data(...)'},
+            data=data(...),
         )
         Draw 1: True
         Draw 2 (second): True
@@ -198,15 +197,7 @@ def f(data):
         tc for tc in observations if tc.type == "test_case" and tc.status == "passed"
     ]
     assert test_cases
-    representations = {tc.representation for tc in test_cases}
-    if crosshair:
-        # Under the crosshair backend Hypothesis observes the same example under
-        # both the crosshair provider (data=<symbolic>) and its own concrete
-        # replay (data=data(...)), so there is more than one representation;
-        # just require the symbolic one to be present.
-        assert expected in representations
-    else:
-        assert {tc.representation for tc in test_cases} == {expected}
+    assert {tc.representation for tc in test_cases} == {expected}
 
 
 def test_capture_named_arguments():