| commit | 02d79c28bcfc1971b7f540de5779860389b5f21c | [log] [tgz] |
|---|---|---|
| author | Stephen Rosen <sirosen@globus.org> | Mon Feb 21 13:22:23 2022 -0500 |
| committer | GitHub <noreply@github.com> | Mon Feb 21 19:22:23 2022 +0100 |
| tree | 5230eea7a2b520b65d14171d2cabccb60946f637 | |
| parent | 1cb25b85dc8ddfb818923531bbaf1d1978715daa [diff] |
Document how to test type annotations (#1071) This is a slightly broader refactor than just testing. It also consolidates information about checking type coverage/completeness. This originates from a thread on the mypy tracker [1]. In terms of presentation, the goal is to present guidance and offer up several options, many of which were proposed by contributors to that thread. Several of the goals from that thread were not achieved here, including documentation covering stubgen and monkeytype, stubtest, and potentially more. However, the document is written such that it should be possible to add a section on "Generating Annotations" as was planned earlier. [1]: https://github.com/python/mypy/issues/11506
The documentation for Python's static typing can be found at typing.readthedocs.io. You can get help either in our support forum or chat with us on Gitter.
Improvements to the type system should be discussed on the typing-sig mailing list, although the issues in this repository contain some historic discussions.
This GitHub repository is used for several things:
The typing_extensions module lives in the typing_extensions directory.
The documentation at typing.readthedocs.io is maintained in the docs directory.
A discussion forum for typing-related user help is hosted here.
Historically, this repository hosted a backport of the typing module for older Python versions. The last released version, supporting Python 2.7 and 3.4, is available at PyPI.
See CONTRIBUTING.md for more.