python / python/cpython

Exception notes discarded from TypeError within __hash__()

Offen
#149,313 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

interpreter-core type-bug
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Bug report

Bug description:

Context

I'm maintaining this library that requires users to construct deeply nested structures that are used as dict keys. To alleviate the annoyance of figuring out where a non-hashable value has been introduced into the key structure, I started using dedicated data structures with a __hash__(), which adds location information to the exception's notes:

from dataclasses import dataclass
from dataclasses import field

@dataclass
class KeyStruct:
    name: str
    first: object = field(repr=False)
    second: object = field(repr=False)

    def __hash__(self) -> int:
        try:
            h1 = hash(self.first)
        except TypeError as e:
            e.add_note(f"within {self}.first")
            raise

        try:
            h2 = hash(self.second)
        except TypeError as e:
            e.add_note(f"within {self}.second")
            raise

        return hash((self.name, h1, h2))

So when such a structure is used, information about the location of the offending value can be provided:

s = KeyStruct("foo", 1, KeyStruct("bar", 2, KeyStruct("spam", 3, [])))
s_dict = {s: "hello"}
Traceback (most recent call last):
  File "/Users/michi/Documents/Projects/Declarative_Python/declarative-python/src/hello.py", line 43, in <module>
    s_dict = {s: "hello"}
             ^^^^^^^^^^^^
  File "/Users/michi/Documents/Projects/Declarative_Python/declarative-python/src/hello.py", line 34, in __hash__
    h2 = hash(self.second)
  File "/Users/michi/Documents/Projects/Declarative_Python/declarative-python/src/hello.py", line 34, in __hash__
    h2 = hash(self.second)
  File "/Users/michi/Documents/Projects/Declarative_Python/declarative-python/src/hello.py", line 28, in __hash__
    h1 = hash(self.first)
TypeError: unhashable type: 'list'
within KeyStruct(name='spam').first
within KeyStruct(name='bar').second
within KeyStruct(name='foo').second

It is not very beautiful, but very helpful. :)

The Bug

The above output is from Python 3.13. The output changes with Python 3.14 (3.14.4 on macOS 14.8.5):

Traceback (most recent call last):
  File "/Users/michi/Documents/Projects/Declarative_Python/declarative-python/src/hello.py", line 43, in <module>
    s_dict = {s: "hello"}
             ^^^^^^^^^^^^
TypeError: cannot use 'KeyStruct' as a dict key (unhashable type: 'list')

I suspect that the source of this is the improved error messages introduced with https://github.com/python/cpython/issues/132825. If I interpret this code correctly, the dict and set methods that need to hash a key will catch and discard the raised TypeError and only re-use the exception message.

IMHO his is unfortunate and I consider it a regression.

I'm not sure what the best way to solve this would be:

  • As an experienced Python programmer, I would have expected the implementation of dict and set to attach the existing exception as __cause__ on the new exception. That would solve my use case.

  • An alternative would be to copy the notes from the old to the new exception. If you consider the notes a part of something I'll call the "extended exception message", the code would conceptually replace the exception, modifying, but retaining its "extended exception message" in full.

    But this sill has the drawback of discarding the original stack trace, which I also consider valuable in many cases.

  • Update the passage describing the improvement in What’s new in Python 3.14 to document the change in behavior and provide a workaround. E.g.:

    • Improved error message when trying to add an instance of an unhashable type to a dict or set. (Contributed by CF Bolz-Tereick and Victor Stinner in gh-132828.)

      (code block)

      In those instances, the original TypeError and its notes and stack trace are replaced. You can raise a subclass of TypeError from a __hash__() implementation to opt-out of this feature.

    AFAICT, the improvement is not documented elsewhere in Python's documentation.

CPython versions tested on:

3.14

Operating systems tested on:

macOS

Linked PRs
  • gh-149505

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 mit der Überprüfung der im Bericht genannten Hashing-Methoden von dict und set sowie des hash-Einstiegspunkts und des verknüpften PR gh-149505. Vergleiche das Verhalten von Python 3.13 und 3.14, einschließlich der Hinweise zu Ausnahmen und der Behandlung von Tracebacks. Als abgeschlossen gilt die Implementierung der akzeptierten Lösung für die Regression oder die Aktualisierung von What's New, falls das Verhalten beibehalten wird, zusammen mit der relevanten Regressionstestabdeckung oder Dokumentation.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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