python / python/cpython

Add `sort_dicts` parameter to `reprlib.Repr`

Offen
#155,812 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

stdlib type-feature
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne bei reprlib.Repr und überprüfe das aktuelle Verhalten beim Sortieren von Dictionaries. Vergleiche anschließend die vorgeschlagene API mit pprint.PrettyPrinter. Prüfe den verknüpften PR gh-155817; als abgeschlossen gilt die Arbeit, wenn die API sort_dicts=False unterstützt und der Standardwert True das bestehende Verhalten beibehält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
backend
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.