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

Perform attr order checks after field transformer. #1401

Merged
merged 6 commits into from
Feb 9, 2025

Conversation

jamesmurphy-mc
Copy link
Contributor

@jamesmurphy-mc jamesmurphy-mc commented Jan 31, 2025

Fixes: #1147

Summary

Previously, attrs performed order checks for mandatory vs non-mandatory attributes before applying the field transformer, giving errors even when the field transformer intended to fix such errors such as by supplying defaults, factories, making args keyword-only, removing attrs, or reordering attrs.

This PR moves the checks after the field transformer.

Pull Request Check List

  • Do not open pull requests from your main branch – use a separate branch!
    • There's a ton of footguns waiting if you don't heed this warning. You can still go back to your project, create a branch from your main branch, push it, and open the pull request from the new branch.
    • This is not a pre-requisite for your pull request to be accepted, but you have been warned.
  • 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 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 22.2.0, the next version is gonna be 22.3.0.
      If the next version is the first in the new year, it'll be 23.1.0.
      • If something changed that affects both attrs.define() and attr.s(), you have to add version directives to both.
  • Documentation in .rst and .md 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 hynek requested a review from sscherfke February 1, 2025 10:01
Copy link
Contributor

@sscherfke sscherfke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea and looks good. :)

@jamesmurphy-mc
Copy link
Contributor Author

Thanks! I just merged the latest autocommit from main into the PR so assuming all checks pass, I think it's ready to merge.

Copy link
Member

@hynek hynek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Great to meet a fellow Python YouTuber with checks notes 100x subscribers. :D

@hynek hynek added this pull request to the merge queue Feb 9, 2025
Merged via the queue into python-attrs:main with commit e048efc Feb 9, 2025
19 checks passed
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.

field checks done too early causing error
3 participants