Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ You can find our backwards-compatibility policy [here](https://github.com/hynek/
```
[#749](https://github.com/hynek/structlog/pull/749)

- Same for *sort_keys*.

- Added `structlog.dev.ConsoleRenderer.get_default_column_styles` for reuse the default column styles.
[#741](https://github.com/hynek/structlog/pull/741)

Expand Down
2 changes: 1 addition & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ API Reference
.. automodule:: structlog.dev

.. autoclass:: ConsoleRenderer
:members: get_default_level_styles, get_default_column_styles, exception_formatter
:members: get_default_level_styles, get_default_column_styles, exception_formatter, sort_keys

.. autofunction:: get_active_console_renderer
.. autoexception:: NoConsoleRendererConfiguredError
Expand Down
16 changes: 16 additions & 0 deletions src/structlog/dev.py
Original file line number Diff line number Diff line change
Expand Up @@ -856,6 +856,22 @@ def exception_formatter(self, value: ExceptionRenderer) -> None:
"""
self._exception_formatter = value

@property
def sort_keys(self) -> bool:
"""
Whether to sort keys when formatting.

.. versionadded:: 25.5.0
"""
return self._sort_keys

@sort_keys.setter
def sort_keys(self, value: bool) -> None:
"""
.. versionadded:: 25.5.0
"""
self._sort_keys = value


_SENTINEL = object()

Expand Down
16 changes: 16 additions & 0 deletions tests/test_dev.py
Original file line number Diff line number Diff line change
Expand Up @@ -696,6 +696,22 @@ def test_exception_formatter_property(self, cr):
assert sentinel is cr.exception_formatter
assert sentinel is cr._exception_formatter

def test_sort_keys_property(self, cr):
"""
The sort_keys setting can be set and retrieved without re-instantiating
ConsoleRenderer.
"""
assert cr.sort_keys is True
assert cr._sort_keys is True

cr.sort_keys = False
assert cr.sort_keys is False
assert cr._sort_keys is False

cr.sort_keys = True
assert cr.sort_keys is True
assert cr._sort_keys is True


class TestSetExcInfo:
def test_wrong_name(self):
Expand Down