Improve error messages for invalid `shelve` datum
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Feature or enhancement
Proposal:
In https://github.com/python/cpython/issues/137829, I got confused because of the following:
import shelve
import dbm.gnu
db = dbm.gnu.open("myshelf", "c")
db.close()
def serializer(obj, protocol=None):
pass
def deserializer(data):
return data.decode("utf-8")
with shelve.open("myshelf", serializer=serializer, deserializer=deserializer) as s:
s["foo"] = "bar"
The traceback is
Traceback (most recent call last):
File "/home/arf/Desktop/source-codes/cpython/repro.py", line 17, in <module>
s["foo"] = "bar"
~^^^^^^^
File "/home/arf/Desktop/source-codes/cpython/Lib/shelve.py", line 138, in __setitem__
self.dict[key.encode(self.keyencoding)] = serialized_value
~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: gdbm mappings have bytes or string indices only
I got confused because I thought that the issue stemmed from the key (because of the word "indices") but the error is raised due to the serialized_value type as serializer returns None. IOW, s["foo"] = "bar" above is equivalent to s["foo"] = None. I suggest:
- changing the error message when the value type is incorrect (namely, don't talk about "indices"). Ideally, we should use "key" and "value" to distinguish the messages.
- add some "must be [...], not [...]" with the input type.
cc @furkanonder
Has this already been discussed elsewhere?
This is a minor feature, which does not need previous discussion elsewhere
Links to previous discussion of this feature:
No response
Linked PRs
- gh-138768
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne bei Lib/shelve.py in Zeile 138 und reproduziere das bereitgestellte shelve/dbm.gnu-Beispiel, um nachzuverfolgen, warum ein ungültiger serialisierter Wert den irreführenden Fehler erzeugt. Aktualisiere den gemeldeten Wortlaut, um Schlüssel von Werten zu unterscheiden und den empfangenen Typ einzubeziehen; als erledigt gilt die Aufgabe, wenn das Beispiel den ungültigen Wert eindeutig identifiziert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- databases
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 25/100