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

Add stub typing for clients #1075

Open
wants to merge 15 commits into
base: master
Choose a base branch
from

Conversation

jackgene
Copy link
Contributor

Changes

Adds type stubs to classes that clients will interact with, and py.typed so that type checkers know type information is available.

Fixes #980 (kind of)

Per providing type annotations, there are several ways to distribute type information:

  • inline type annotations (preferred)
  • type stub files included in the package
  • a separate companion type stub package
  • type stubs in the typeshed repository

This is the second option, and does not touch any of the .py files. If you prefer to go with the first option (preferred, but makes changes to .py files), please have a look at #1074 instead. That PR also includes additional details on how type information was added.

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> (e.g. 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.

@jackgene
Copy link
Contributor Author

These type stubs are being used in a couple of my projects:

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.

Proposal to Add Type Hints
1 participant