.config/coc/extensions/node_modules/coc-pyright/node_modules/pyright/dist/typeshed-fallback/README.md

   1 # typeshed
   2
   3 [![Build status](https://github.com/python/typeshed/workflows/Check%20stubs/badge.svg)](https://github.com/python/typeshed/actions?query=workflow%3A%22Check+stubs%22)
   4 [![Chat at https://gitter.im/python/typing](https://badges.gitter.im/python/typing.svg)](https://gitter.im/python/typing?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
   5 [![Pull Requests Welcome](https://img.shields.io/badge/pull%20requests-welcome-brightgreen.svg)](https://github.com/python/typeshed/blob/master/CONTRIBUTING.md)
   6
   7 ## About
   8
   9 Typeshed contains external type annotations for the Python standard library
  10 and Python builtins, as well as third party packages as contributed by
  11 people external to those projects.
  12
  13 This data can e.g. be used for static analysis, type checking or type inference.
  14
  15 For information on how to use `typeshed`, read below.  Information for
  16 contributors can be found in [CONTRIBUTING.md](CONTRIBUTING.md).  **Please read
  17 it before submitting pull requests; do not report issues with annotations to
  18 the project the stubs are for, but instead report them here to typeshed.**
  19
  20 Typeshed supports Python versions 2.7 and 3.6 and up.
  21
  22 ## Using
  23
  24 If you're just using mypy (or pytype or PyCharm), as opposed to
  25 developing it, you don't need to interact with the typeshed repo at
  26 all: a copy of standard library part of typeshed is bundled with mypy.
  27 And type stubs for third party packages and modules you are using can
  28 be installed from PyPI. For example, if you are using `six` and `requests`,
  29 you can install the type stubs using
  30
  31     $ pip install types-six types-requests
  32
  33 These PyPI packages follow [PEP 561](http://www.python.org/dev/peps/pep-0561/)
  34 and are automatically generated by typeshed internal machinery. Also starting
  35 from version 0.900 mypy will provide an option to automatically install missing
  36 type stub packages (if found on PyPI).
  37
  38 PyCharm, pytype etc. work in a similar way, for more details see documentation
  39 for the type-checking tool you are using.
  40
  41 ### The `_typeshed` package
  42
  43 typeshed includes a package `_typeshed` as part of the standard library.
  44 This package and its submodules contains utility types, but is not
  45 available at runtime. For more information about how to use this package,
  46 [see the `stdlib/_typeshed` directory](https://github.com/python/typeshed/tree/master/stdlib/_typeshed).
  47
  48 ## Discussion
  49
  50 If you've run into behavior in the type checker that suggests the type
  51 stubs for a given library are incorrect or incomplete,
  52 we want to hear from you!
  53
  54 Our main forum for discussion is the project's [GitHub issue
  55 tracker](https://github.com/python/typeshed/issues).  This is the right
  56 place to start a discussion of any of the above or most any other
  57 topic concerning the project.
  58
  59 If you have general questions about typing with Python, or you need
  60 a review of your type annotations or stubs outside of typeshed, head over to
  61 [our discussion forum](https://github.com/python/typing/discussions).
  62 For less formal discussion, try the typing chat room on
  63 [gitter.im](https://gitter.im/python/typing).  Some typeshed maintainers
  64 are almost always present; feel free to find us there and we're happy
  65 to chat.  Substantive technical discussion will be directed to the
  66 issue tracker.