Add `sort_dicts` parameter to `reprlib.Repr`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Feature or enhancement
Proposal:
reprlib.Repr currently sorts dictionaries by key when producing representations. However, sometimes the insertion order is meaningful. It would be useful to have a sort_dicts parameter, analogous to the existing parameter in pprint.PrettyPrinter & friends.
The proposed API is:
orepr = reprlib.Repr(sort_dicts=False)
orepr.repr(my_ordered_dict)
The default should be True to preserve the existing behavior.
A possible implementation is here:
https://github.com/python/cpython/compare/main...warden127:cpython:reprlib-sort_dicts
Has this already been discussed elsewhere?
I have already opened a thread under Ideas on discuss.python.org a couple days ago, but got no response (and therefore no objections *wink*).
Links to previous discussion of this feature:
Linked PRs
- gh-155817
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at reprlib.Repr and review the current dictionary-sorting behavior, then compare the proposed API with pprint.PrettyPrinter. Check linked PR gh-155817; done means the API supports sort_dicts=False while default True preserves existing behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100