Share mapping key display fallback helper across parsers

Co-authored-by: Shri Sukhani <shrisukhani@users.noreply.github.com>

Author: cursoragent

hyperbrowser/client/managers/list_parsing_utils.py

@@ -1,26 +1,11 @@
 from typing import Any, Callable, List, TypeVar
 
 from hyperbrowser.exceptions import HyperbrowserError
-from hyperbrowser.mapping_utils import read_string_key_mapping
-from hyperbrowser.type_utils import is_plain_string
+from hyperbrowser.mapping_utils import read_string_key_mapping, safe_key_display_for_error
 
 T = TypeVar("T")
 
 
-def _safe_key_display_for_error(
-    key: str,
-    *,
-    key_display: Callable[[str], str],
-) -> str:
-    try:
-        key_text = key_display(key)
-        if not is_plain_string(key_text):
-            raise TypeError("key display must be a string")
-        return key_text
-    except Exception:
-        return "<unreadable key>"
-
-
 def parse_mapping_list_items(
     items: List[Any],
     *,
@@ -42,7 +27,7 @@ def parse_mapping_list_items(
             read_value_error_builder=lambda key_text: (
                 f"Failed to read {item_label} object value for key '{key_text}' at index {index}"
             ),
-            key_display=lambda key: _safe_key_display_for_error(
+            key_display=lambda key: safe_key_display_for_error(
                 key, key_display=key_display
             ),
         )

hyperbrowser/mapping_utils.py

@@ -5,7 +5,7 @@
 from hyperbrowser.type_utils import is_plain_string
 
 
-def _safe_key_display_for_error(
+def safe_key_display_for_error(
     key: str, *, key_display: Callable[[str], str]
 ) -> str:
     try:
@@ -66,7 +66,7 @@ def read_string_key_mapping(
         except HyperbrowserError:
             raise
         except Exception as exc:
-            key_text = _safe_key_display_for_error(key, key_display=key_display)
+            key_text = safe_key_display_for_error(key, key_display=key_display)
             raise HyperbrowserError(
                 read_value_error_builder(key_text),
                 original_error=exc,
@@ -90,7 +90,7 @@ def copy_mapping_values_by_string_keys(
         except HyperbrowserError:
             raise
         except Exception as exc:
-            key_text = _safe_key_display_for_error(key, key_display=key_display)
+            key_text = safe_key_display_for_error(key, key_display=key_display)
             raise HyperbrowserError(
                 read_value_error_builder(key_text),
                 original_error=exc,

tests/test_mapping_utils.py

@@ -4,10 +4,10 @@
 
 from hyperbrowser.exceptions import HyperbrowserError
 from hyperbrowser.mapping_utils import (
-    _safe_key_display_for_error,
     copy_mapping_values_by_string_keys,
     read_string_mapping_keys,
     read_string_key_mapping,
+    safe_key_display_for_error,
 )
 
 
@@ -135,14 +135,14 @@ def test_read_string_key_mapping_falls_back_for_unreadable_key_display():
 
 def test_safe_key_display_for_error_returns_display_value():
     assert (
-        _safe_key_display_for_error("field", key_display=lambda key: f"<{key}>")
+        safe_key_display_for_error("field", key_display=lambda key: f"<{key}>")
         == "<field>"
     )
 
 
 def test_safe_key_display_for_error_returns_unreadable_key_on_failures():
     assert (
-        _safe_key_display_for_error(
+        safe_key_display_for_error(
             "field",
             key_display=lambda key: key.encode("utf-8"),
         )