api: Add sorting for API responses. #669
Conversation
Currently the API response keys were sorted in random order, making the responses unreadable. Added JSON dumps to sort the response keys.
MSurfer20
force-pushed
the
fix_api_responses
branch
from
9b98d96 to
993ce94
Compare
| versioned_url = API_VERSTRING + (url if url is not None else "") | ||
| return self.do_api_query(marshalled_request, versioned_url, method=method, | ||
| longpolling=longpolling, files=files, timeout=timeout) | ||
| return json.dumps(self.do_api_query(marshalled_request, versioned_url, method=method, |
There was a problem hiding this comment.
We definitely don't want to do JSON dumps here -- a program accessing this wants the Python dictionary.
What I think we want to do here is sorting in #663 and in all the tools in examples/, so the main PR to do here would be to adjust examples/ appropriately.
There was a problem hiding this comment.
@timabbott Can we instead change this to
return json.loads(json.dumps(self.do_api_query(marshalled_request, versioned_url, method=method,
longpolling=longpolling, files=files, timeout=timeout), sort_keys=True))
since dictionaries are ordered from Python 3.7(and CPython 3.6)?
There was a problem hiding this comment.
@timabbott Should I instead go with the modifying examples/ approach?
There was a problem hiding this comment.
I don't think this will help if someone is running zulip in an env where python <= 3.6.
The only way is updating examples/.
There was a problem hiding this comment.
I think after thinking about this more, I'm not sure there's anything we want to do client-side -- the extra code in the examples is unlikely to be worth it.
4 participants
Currently the API response keys were sorted in random order, making
the responses unreadable. Added JSON dumps to sort the response keys.
Fixes zulip/zulip#17428