mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-21 03:11:16 +08:00
1b188921fd
The file CODE_OF_CONDUCT.md is the standard location for it and is treated specially by GitHub, for example by linking to it directly when opening issues and PRs.
57 lines
2.6 KiB
Markdown
57 lines
2.6 KiB
Markdown
# typeshed
|
|
|
|
[](https://github.com/python/typeshed/actions?query=workflow%3A%22Check+stubs%22)
|
|
[](https://gitter.im/python/typing?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](https://github.com/python/typeshed/blob/master/CONTRIBUTING.md)
|
|
|
|
## About
|
|
|
|
Typeshed contains external type annotations for the Python standard library
|
|
and Python builtins, as well as third party packages as contributed by
|
|
people external to those projects.
|
|
|
|
This data can e.g. be used for static analysis, type checking or type inference.
|
|
|
|
For information on how to use `typeshed`, read below. Information for
|
|
contributors can be found in [CONTRIBUTING.md](CONTRIBUTING.md). **Please read
|
|
it before submitting pull requests; do not report issues with annotations to
|
|
the project the stubs are for, but instead report them here to typeshed.**
|
|
|
|
Typeshed supports Python versions 2.7 and 3.6 and up.
|
|
|
|
## Using
|
|
|
|
If you're just using mypy (or pytype or PyCharm), as opposed to
|
|
developing it, you don't need to interact with the typeshed repo at
|
|
all: a copy of standard library part of typeshed is bundled with mypy.
|
|
And type stubs for third party packages and modules you are using can
|
|
be installed from PyPI. For example, if you are using `six` and `requests`,
|
|
you can install the type stubs using
|
|
|
|
$ pip install types-six types-requests
|
|
|
|
These PyPI packages follow [PEP 561](http://www.python.org/dev/peps/pep-0561/)
|
|
and are automatically generated by typeshed internal machinery. Also starting
|
|
from version 0.900 mypy will provide an option to automatically install missing
|
|
type stub packages (if found on PyPI).
|
|
|
|
PyCharm, pytype etc. work in a similar way, for more details see documentation
|
|
for the type-checking tool you are using.
|
|
|
|
## Discussion
|
|
|
|
If you've run into behavior in the type checker that suggests the type
|
|
stubs for a given library are incorrect or incomplete,
|
|
we want to hear from you!
|
|
|
|
Our main forum for discussion is the project's [GitHub issue
|
|
tracker](https://github.com/python/typeshed/issues). This is the right
|
|
place to start a discussion of any of the above or most any other
|
|
topic concerning the project.
|
|
|
|
For less formal discussion, try the typing chat room on
|
|
[gitter.im](https://gitter.im/python/typing). Some typeshed maintainers
|
|
are almost always present; feel free to find us there and we're happy
|
|
to chat. Substantive technical discussion will be directed to the
|
|
issue tracker.
|