Visitar URL original
gh-100272: Fix JSON serialization of OrderedDict by serhiy-storchaka · Pull Request #100273 · python/cpython · GitHub
Skip to content

gh-100272: Fix JSON serialization of OrderedDict #100273

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
serhiy-storchaka merged 2 commits into from
Dec 17, 2022
Merged

gh-100272: Fix JSON serialization of OrderedDict #100273

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3262ea6
gh-100272: Fix JSON serialization of OrderedDict
serhiy-storchaka Dec 15, 2022
8e5b181
Add more items in the test.
serhiy-storchaka Dec 17, 2022
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
Next Next commit
gh-100272: Fix JSON serialization of OrderedDict 
It now preserves the order of keys.
  • Loading branch information
@serhiy-storchaka
serhiy-storchaka committed Dec 15, 2022
commit 3262ea64b84bf19e00c5e3fdf9d56b1d28e6326b
11 changes: 11 additions & 0 deletions Lib/test/test_json/test_default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import collections
from test.test_json import PyTest, CTest


Expand All @@ -7,6 +8,16 @@ def test_default(self):
self.dumps(type, default=repr),
self.dumps(repr(type)))

def test_ordereddict(self):
od = collections.OrderedDict(a=1, b=2)

@rhettinger rhettinger Dec 15, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest adding a few more pairs to this to make this a more convincing test.

od.move_to_end('a')
self.assertEqual(
self.dumps(od),
'{"b": 2, "a": 1}')
self.assertEqual(
self.dumps(od, sort_keys=True),
'{"a": 1, "b": 2}')


class TestPyDefault(TestDefault, PyTest): pass
class TestCDefault(TestDefault, CTest): pass
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2022-12-15-18-28-13.gh-issue-100272.D1O9Ey.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix JSON serialization of OrderedDict. It now preserves the order of keys.
7 changes: 3 additions & 4 deletions Modules/_json.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1570,10 +1570,9 @@ encoder_listencode_dict(PyEncoderObject *s, _PyUnicodeWriter *writer,
*/
}

if (s->sort_keys) {

items = PyDict_Items(dct);
if (items == NULL || PyList_Sort(items) < 0)
if (s->sort_keys || !PyDict_CheckExact(dct)) {
items = PyMapping_Items(dct);
if (items == NULL || (s->sort_keys && PyList_Sort(items) < 0))
goto bail;

for (Py_ssize_t i = 0; i < PyList_GET_SIZE(items); i++) {
Expand Down