Skip to content

Add AttrsInstance protocol to forgotten attrs.asdict and attrs.astuple #1090

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.

Sign up for GitHub

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

Jump to bottom
Merged
hynek merged 4 commits into from
Jan 23, 2023
Merged

Add AttrsInstance protocol to forgotten attrs.asdict and attrs.astuple #1090

hynek merged 4 commits into from
Jan 23, 2023

Conversation

@tsx
Copy link
Contributor

@tsx tsx commented Jan 19, 2023 •
edited
Loading

Summary

Fixes #1089

AttrsInstance protocol was added in #890 but two functions in the attrs namespace were apparently forgotten and still accept Any as the instance. This PR changes the signatures to accept AttrsInstance instead to match what's in the attr namespace.

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.

@tsx tsx marked this pull request as ready for review January 19, 2023 18:20
@tsx tsx mentioned this pull request Jan 19, 2023
Closed
@hynek
Copy link
Member

hynek commented Jan 22, 2023

@tsx ah sorry can you add a news fragment describing the change in one sentence? I'm traveling rn otherwise I would do it myself. Thanks!

@tsx
Copy link
Contributor Author

tsx commented Jan 22, 2023

@hynek done. I tried to make it short and to the point.

@hynek hynek enabled auto-merge (squash) January 23, 2023 09:18
@hynek hynek merged commit 882805e into python-attrs:main Jan 23, 2023
@hynek
Copy link
Member

hynek commented Jan 23, 2023

Thanks! I've added a clarification that it's just about stubs, so people don't think there's a change in behavior.

@dougthor42 dougthor42 mentioned this pull request Sep 20, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Tinche Tinche Tinche approved these changes

Assignees

@Tinche Tinche

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AttrsInstance protocol in the new attrs namespace

3 participants

@tsx @hynek @Tinche