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

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

filbranden
Copy link
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.

…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
@filbranden
Copy link
Contributor Author

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

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.

1 participant