dev: add repr_native_str property

Author: hynek

docs/api.rst

@@ -76,7 +76,7 @@ API Reference
 .. automodule:: structlog.dev
 
 .. autoclass:: ConsoleRenderer
-   :members: get_default_level_styles, get_default_column_styles, exception_formatter, sort_keys, columns, get_active
+   :members: get_default_level_styles, get_default_column_styles, exception_formatter, sort_keys, columns, get_active, event_key, timestamp_key, level_styles,colors, force_colors, repr_native_str, pad_level, pad_event_to
 
 .. autoclass:: ColumnStyles
 

src/structlog/dev.py

@@ -710,6 +710,38 @@ def add_meaningless_arg(arg: str) -> None:
         for w in to_warn:
             warnings.warn(w, stacklevel=2)
 
+    @classmethod
+    def get_active(cls) -> ConsoleRenderer:
+        """
+        If *structlog* is configured to use `ConsoleRenderer`, it's returned.
+
+        It does not have to be the last processor.
+
+        Raises:
+            NoConsoleRendererConfiguredError:
+                If no ConsoleRenderer is found in the current configuration.
+
+            MultipleConsoleRenderersConfiguredError:
+                If more than one is found in the current configuration. This is
+                almost certainly a bug.
+
+        .. versionadded:: 25.5.0
+        """
+        from ._config import get_config
+
+        cr = None
+        for p in get_config()["processors"]:
+            if isinstance(p, ConsoleRenderer):
+                if cr is not None:
+                    raise MultipleConsoleRenderersConfiguredError
+
+                cr = p
+
+        if cr is None:
+            raise NoConsoleRendererConfiguredError
+
+        return cr
+
     @classmethod
     def get_default_column_styles(
         cls, colors: bool, force_colors: bool = False
@@ -744,6 +776,37 @@ def get_default_column_styles(
 
         return _colorful_styles
 
+    @staticmethod
+    def get_default_level_styles(colors: bool = True) -> dict[str, str]:
+        """
+        Get the default styles for log levels
+
+        This is intended to be used with `ConsoleRenderer`'s ``level_styles``
+        parameter.  For example, if you are adding custom levels in your
+        home-grown :func:`~structlog.stdlib.add_log_level` you could do::
+
+            my_styles = ConsoleRenderer.get_default_level_styles()
+            my_styles["EVERYTHING_IS_ON_FIRE"] = my_styles["critical"]
+            renderer = ConsoleRenderer(level_styles=my_styles)
+
+        Args:
+            colors:
+                Whether to use colorful styles. This must match the *colors*
+                parameter to `ConsoleRenderer`. Default: `True`.
+        """
+        styles: ColumnStyles
+        styles = _colorful_styles if colors else _plain_styles
+        return {
+            "critical": styles.level_critical,
+            "exception": styles.level_exception,
+            "error": styles.level_error,
+            "warn": styles.level_warn,
+            "warning": styles.level_warn,
+            "info": styles.level_info,
+            "debug": styles.level_debug,
+            "notset": styles.level_notset,
+        }
+
     def _configure_columns(self) -> None:
         """
         Re-configure self._columns and self._default_column_formatter
@@ -865,37 +928,6 @@ def __call__(
 
         return sio.getvalue()
 
-    @staticmethod
-    def get_default_level_styles(colors: bool = True) -> dict[str, str]:
-        """
-        Get the default styles for log levels
-
-        This is intended to be used with `ConsoleRenderer`'s ``level_styles``
-        parameter.  For example, if you are adding custom levels in your
-        home-grown :func:`~structlog.stdlib.add_log_level` you could do::
-
-            my_styles = ConsoleRenderer.get_default_level_styles()
-            my_styles["EVERYTHING_IS_ON_FIRE"] = my_styles["critical"]
-            renderer = ConsoleRenderer(level_styles=my_styles)
-
-        Args:
-            colors:
-                Whether to use colorful styles. This must match the *colors*
-                parameter to `ConsoleRenderer`. Default: `True`.
-        """
-        styles: ColumnStyles
-        styles = _colorful_styles if colors else _plain_styles
-        return {
-            "critical": styles.level_critical,
-            "exception": styles.level_exception,
-            "error": styles.level_error,
-            "warn": styles.level_warn,
-            "warning": styles.level_warn,
-            "info": styles.level_info,
-            "debug": styles.level_debug,
-            "notset": styles.level_notset,
-        }
-
     @property
     def exception_formatter(self) -> ExceptionRenderer:
         """
@@ -1019,38 +1051,6 @@ def force_colors(self, value: bool) -> None:
 
         self._configure_columns()
 
-    @classmethod
-    def get_active(cls) -> ConsoleRenderer:
-        """
-        If *structlog* is configured to use `ConsoleRenderer`, it's returned.
-
-        It does not have to be the last processor.
-
-        Raises:
-            NoConsoleRendererConfiguredError:
-                If no ConsoleRenderer is found in the current configuration.
-
-            MultipleConsoleRenderersConfiguredError:
-                If more than one is found in the current configuration. This is
-                almost certainly a bug.
-
-        .. versionadded:: 25.5.0
-        """
-        from ._config import get_config
-
-        cr = None
-        for p in get_config()["processors"]:
-            if isinstance(p, ConsoleRenderer):
-                if cr is not None:
-                    raise MultipleConsoleRenderersConfiguredError
-
-                cr = p
-
-        if cr is None:
-            raise NoConsoleRendererConfiguredError
-
-        return cr
-
     @property
     def level_styles(self) -> dict[str, str]:
         """
@@ -1153,6 +1153,22 @@ def timestamp_key(self, value: str) -> None:
         self._timestamp_key = value
         self._configure_columns()
 
+    @property
+    def repr_native_str(self) -> bool:
+        """
+        Whether native strings are passed through repr() in non-event values.
+
+        .. versionadded:: 25.5.0
+        """
+        return self._repr_native_str
+
+    @repr_native_str.setter
+    def repr_native_str(self, value: bool) -> None:
+        """
+        .. versionadded:: 25.5.0
+        """
+        self._repr_native_str = value
+
 
 _SENTINEL = object()
 

tests/test_dev.py

@@ -1004,6 +1004,23 @@ def test_roundtrip_pad_event_to(self):
         assert cr.pad_event_to == 20
         assert cr._pad_event_to == 20
 
+    def test_repr_native_str_property(self, cr):
+        """
+        The repr_native_str property can be set and retrieved, and affects formatting.
+        """
+        cr = dev.ConsoleRenderer(colors=False, repr_native_str=False)
+
+        assert False is cr.repr_native_str
+        assert "event                          key=plain" == cr(
+            None, None, {"event": "event", "key": "plain"}
+        )
+
+        cr.repr_native_str = True
+
+        assert "event                          key='plain'" == cr(
+            None, None, {"event": "event", "key": "plain"}
+        )
+
     def test_pad_event_deprecation_warning(self, recwarn):
         """
         Using pad_event argument raises a deprecation warning.

tests/typing/api.py

@@ -408,3 +408,6 @@ def f() -> None:
 
 cr.event_key
 cr.event_key = "le event"
+
+cr.repr_native_str
+cr.repr_native_str = True