Skip to content

Honor sort_keys for parsed TOML documents #471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frostming merged 1 commit into from
Apr 27, 2026
Merged

Honor sort_keys for parsed TOML documents #471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,12 @@ def test_mapping_types_can_be_dumped() -> None:
assert dumps(x) == 'foo = "bar"\n'


def test_parsed_document_can_be_dumped_with_sorted_keys() -> None:
doc = loads('zzz = 1\naaa = "foo"')

assert dumps(doc, sort_keys=True) == 'aaa = "foo"\nzzz = 1\n'


def test_dumps_weird_object() -> None:
with pytest.raises(TypeError):
dumps(object()) # type: ignore[arg-type]
Expand Down
7 changes: 5 additions & 2 deletions tomlkit/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,12 @@ def dumps(data: Mapping[str, Any], sort_keys: bool = False) -> str:
Dumps a TOMLDocument into a string.
"""
if isinstance(data, (Table, InlineTable, Container)):
return data.as_string()
if not sort_keys:
return data.as_string()

table: Table = item(dict(data), _sort_keys=sort_keys)
return item(data, _sort_keys=True).as_string()

table = item(dict(data), _sort_keys=sort_keys)
return table.as_string()


Expand Down
Loading