Skip to content

Mix instance type into generated hashes - #1630

Open
00200200 wants to merge 2 commits into
python-attrs:mainfrom
00200200:fix-528-hash-instance-type
Open

00200200 wants to merge 2 commits into
python-attrs:mainfrom
00200200:fix-528-hash-instance-type

Conversation

@00200200

Copy link
Copy Markdown

Summary

Generated __hash__ mixed in a class identity captured when the method was created.
Undecorated subclasses therefore inherited the base class's hash component and collided for equal field values (#528).

This switches that component to id(type(self)), so each subclass hashes distinctly while same-class instances keep matching hashes. That matches the hashing docs and Hynek's note on mixing a type identity into the hash.

Pull Request Checklist

  • I acknowledge this project's AI policy.
  • This pull request is not from my main branch.
  • There's tests for all new and changed code.
  • Changes or additions to public APIs are reflected in our type stubs (files ending in .pyi).
    • ...and used in the stub test file typing_tests/baseline.py or, if necessary, typing_tests/mypy.py.
    • If they've been added to attr/__init__.pyi, they've also been re-imported in attrs/__init__.pyi.
  • The documentation has been updated.
    • New functions/classes have to be added to docs/api.rst by hand.
    • Changes to the signatures of @attr.s() and @attrs.define() have to be added by hand too.
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
      The next version is the second number in the current release + 1.
      The first number represents the current year.
      So if the current version on PyPI is 26.2.0, the next version is gonna be 26.3.0.
      If the next version is the first in the new year, it'll be 27.1.0.
    • Documentation in .rst and .md files is written using semantic newlines.
  • Changes have news fragments in changelog.d.

Fixes #528

Undecorated subclasses inherited a hash that only captured the base
class identity, so frozen subclasses with equal fields collided. Use
id(type(self)) so each subclass hashes distinctly.
@codspeed

codspeed Bot commented Sep 29, 2026

Copy link
Copy Markdown

Merging this PR will degrade performance by 14.66%

⚠️ Different runtime environments detected

Some benchmarks with significant performance changes were compared across different runtime environments,
which may affect the accuracy of the results.

Open the report in CodSpeed to investigate

❌ 1 regressed benchmark
✅ 16 untouched benchmarks
⏩ 2 skipped benchmarks1

Warning

Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Mode Benchmark BASE HEAD Efficiency
❌ Simulation test_hash 2.7 ms 3.1 ms -14.66%

Tip

Investigate this regression by commenting @codspeedbot fix this regression on this PR, or directly use the CodSpeed MCP with your agent.


Comparing 00200200:fix-528-hash-instance-type (cfc1c25) with main (65c80d7)2

Open in CodSpeed

Footnotes

  1. 2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

  2. No successful run was found on main (8f76777) during the generation of this report, so 65c80d7 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Inheriting from a frozen class causes instantiated child hashes to collide

1 participant