Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unsafe_hash alias for class-wide hash #1065

Merged
merged 7 commits into from
Dec 2, 2022
Merged

Add unsafe_hash alias for class-wide hash #1065

merged 7 commits into from
Dec 2, 2022

Conversation

hynek
Copy link
Member

@hynek hynek commented Dec 1, 2022

Summary

attr.s(unsafe_hash=True) is now equivalent to attr.s(hash=True) to standardize based on PEP 681.

Fixes #1003

Pull Request Check List

  • Added tests for changed code.
    Our CI fails if coverage is not 100%.
  • New features have been added to our Hypothesis testing strategy.
  • Changes or additions to public APIs are reflected in our type stubs (files ending in .pyi).
    • ...and used in the stub test file tests/typing_example.py.
    • If they've been added to attr/__init__.pyi, they've also been re-imported in attrs/__init__.pyi.
  • Updated documentation for changed code.
    • New functions/classes have to be added to docs/api.rst by hand.
    • Changes to the signature of @attr.s() have to be added by hand too.
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
      Find the appropriate next version in our __init__.py file.
  • Documentation in .rst files is written using semantic newlines.
  • Changes (and possible deprecations) have news fragments in changelog.d.
  • Consider granting push permissions to the PR branch, so maintainers can fix minor issues themselves without pestering you.

@hynek
Copy link
Member Author

hynek commented Dec 1, 2022

@debonte does this cover what you asked me about in checks notes April? 🙈

docs/hashing.md Outdated Show resolved Hide resolved
@debonte
Copy link

debonte commented Dec 1, 2022

@debonte does this cover what you asked me about in checks notes April? 🙈

:) I added one minor comment about the documentation. Otherwise, this looks good to me. Thanks for making this change!

@hynek hynek merged commit 0f6a9b4 into main Dec 2, 2022
@hynek hynek deleted the unsafe-hash branch December 2, 2022 06:45
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.

Add unsafe_hash for PEP 681
2 participants