Skip to content

Fix type annotations for converter types, considering the Converter class#1373

Merged
hynek merged 2 commits intopython-attrs:mainfrom
filbranden:typing2
Nov 27, 2024
Merged

Fix type annotations for converter types, considering the Converter class#1373
hynek merged 2 commits intopython-attrs:mainfrom
filbranden:typing2

Conversation

@filbranden
Copy link
Copy Markdown
Contributor

Summary

A converter can either be a callable with a single argument or an instance of the Converter class, fix the type annotation to allow both cases everywhere _ConverterType is used

Also update field() and attr.ib() which are able to take a list or tuple of converters as an implicit pipe, add type annotations for that syntax

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%.
  • N/A 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.
    • N/A If they've been added to attr/__init__.pyi, they've also been re-imported in attrs/__init__.pyi.
  • N/A Updated documentation for changed code.
  • N/A 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.

@filbranden
Copy link
Copy Markdown
Contributor Author

@hynek Would you kindly take a look whenever possible? Thanks!

@hynek hynek requested a review from Tinche November 25, 2024 07:54
…lass

Also consider that field() or attr.ib() takes a list or tuple of
converters as an implicit pipe, add type annotations for that syntax
Copy link
Copy Markdown
Member

@Tinche Tinche left a comment

Choose a reason for hiding this comment

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

LGTM from what I can follow

@hynek
Copy link
Copy Markdown
Member

hynek commented Nov 25, 2024

It looks to me like worthy a changelog entry because apparently converters are better supported now? 🤔

@filbranden
Copy link
Copy Markdown
Contributor Author

I believe Converters are already mentioned in the changelog for 24.1.0:

"It is now possible to wrap a converter into an attrs.Converter and get the current instance and/or the current field definition passed into the converter callable.

Note that this is not supported by any type checker, yet. #1267"

This just fixes some type annotations but I believe full type checker support would need some mypy changes (see commented out code) so not sure how much is worth mentioning in a changelog.

Having said that, feel free to add a note if you'd like 😃

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.

3 participants