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

Annotate all attrs members #5115

Merged
merged 3 commits into from
Oct 24, 2020
Merged

Annotate all attrs members #5115

merged 3 commits into from
Oct 24, 2020

Conversation

layday
Copy link
Contributor

@layday layday commented Oct 24, 2020

What do these changes do?

In py.typed packages, public attributes must be explicitly typed.
This is not an issue for mypy because the attrs mypy plug-in is able
to infer the types of attrs dynamically. However, in other
static type checkers, like Pyright and pytype, the type of
unannotated attrs is not known statically.

Since aiohttp no longer supports Python versions older than 3.6
I've taken the liberty of converting the annotations to the native
format.

Are there changes in behavior for the user?

No.

Related issue number

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@layday layday requested a review from asvetlov as a code owner October 24, 2020 14:20
In py.typed packages, public attributes must be explicitly typed.
This is not an issue for mypy because the attrs mypy plug-in is able
to infer the types of attrs dynamically.  However, in other
static type checkers, like Pyright and pytype, the type of
unannotated attrs is not known statically.

Since aiohttp no longer supports Python versions older than 3.6
I've taken the liberty of converting the annotations to the native
format.
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Oct 24, 2020
@asvetlov asvetlov merged commit 6373560 into aio-libs:master Oct 24, 2020
@aio-libs-github-bot
Copy link
Contributor

💔 Backport was not successful

The PR was attempted backported to the following branches:

  • ❌ 3.7: Commit could not be cherrypicked due to conflicts

asvetlov pushed a commit that referenced this pull request Oct 24, 2020
* Annotate all attrs members

In py.typed packages, public attributes must be explicitly typed.
This is not an issue for mypy because the attrs mypy plug-in is able
to infer the types of attrs dynamically.  However, in other
static type checkers, like Pyright and pytype, the type of
unannotated attrs is not known statically.

Since aiohttp no longer supports Python versions older than 3.6
I've taken the liberty of converting the annotations to the native
format.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants