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.

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

Function annotations #108

Open
dopplershift opened this issue Nov 25, 2015 · 1 comment
Open

Function annotations #108

dopplershift opened this issue Nov 25, 2015 · 1 comment
Labels
Area: DevTools Pertains to tools for developers Type: Enhancement Enhancement to existing functionality

Comments

@dopplershift
Copy link
Member

Would be good to experiment with adding PEP-484 function annotations to assist PyCharm with consuming our API. Might also be able to find some static-checking tools that can use them.

While we remain Python 2.x compatible, we can put these in .pyi files
@dopplershift dopplershift added Type: Enhancement Enhancement to existing functionality Area: DevTools Pertains to tools for developers labels Jan 26, 2016
@dopplershift
Copy link
Member Author

MyPy would be the go-to these days for the annotations. So basic plan would be:

  • Add mypy as another build job on Travis (or maybe part of linting)
  • Add config file (mypy.ini)
  • Enable checking of untyped stuff (--check-untyped-defs)
  • Start picking off modules

For more info, see zulip's blog post

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area: DevTools Pertains to tools for developers Type: Enhancement Enhancement to existing functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dopplershift