Exception notes discarded from TypeError within __hash__()
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 77.2k
- 派生
- 35.9k
- PR 合并指标
- PR 指标待抓取
描述
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
dictandsetto 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
dictorset. (Contributed by CF Bolz-Tereick and Victor Stinner in gh-132828.)(code block)
In those instances, the original
TypeErrorand its notes and stack trace are replaced. You can raise a subclass ofTypeErrorfrom 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
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先检查报告中涉及的 dict 和 set 哈希方法,以及 hash 入口点和关联的 PR gh-149505。比较 Python 3.13 和 3.14 的行为,包括异常说明和 traceback 处理。如果实现了针对该回归问题的已接受解决方案,或者在保留该行为时更新了 What's New,并补充了相关的回归测试覆盖或文档,则视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- backend
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100