search

graphql-python / graphene

GraphQL framework for Python
http://graphene-python.org/
MIT License
8.08k stars 823 forks source link

Correct documentation and use of type hints #1454

Open erikwrede opened 2 years ago

erikwrede commented 2 years ago

We should upgrade graphene to use modern type hints. In that process, type hints should be removed from the class/method documentation to have the code as the single source of truth for typing. We can use https://github.com/tox-dev/sphinx-autodoc-typehints to automatically add type hints back into the docs.

PRs addressing this issue should at least fix the entire file they are contributing to reduce double-checking effort and streamline the process.

Known issues:

1100 , see #1282 (Query on schema)

anentropic commented 2 years ago

This would big a big help to anyone wanting to use graphene in a typed codebase

Because the 3rd party type defs we've been using seem to be abandonware (e.g. https://github.com/trialspark/graphene-stubs/pull/27 and no commits for ~3 years)