commit | e703629a339a670b44a3612f87bfa90a49c794f0 | [log] [tgz] |
---|---|---|
author | Jelle Zijlstra <jelle.zijlstra@gmail.com> | Wed Jun 21 08:46:02 2023 -0700 |
committer | GitHub <noreply@github.com> | Wed Jun 21 17:46:02 2023 +0200 |
tree | 04227d693a5068549d6ac8b1bce2ec32c45b0b12 | |
parent | a65658fcbc0a86e529e1c46a4eaa5fee4f150607 [diff] |
README improvements (#250) - The mention of testing in the README (which is what appears on PyPI) felt out of place. Replace it with a more general link to CONTRIBUTING. - Mention why typing-extensions is special. - Add discussion of stub files to CONTRIBUTING.
The typing_extensions
module serves two related purposes:
typing.TypeGuard
is new in Python 3.10, but typing_extensions
allows users on previous Python versions to use it too.typing
module.typing_extensions
is treated specially by static type checkers such as mypy and pyright. Objects defined in typing_extensions
are treated the same way as equivalent forms in typing
.
typing_extensions
uses Semantic Versioning. The major version will be incremented only for backwards-incompatible changes. Therefore, it's safe to depend on typing_extensions
like this: typing_extensions >=x.y, <(x+1)
, where x.y
is the first version that includes all features you need.
typing_extensions
supports Python versions 3.7 and higher.
See the documentation for a complete listing of module contents.
See CONTRIBUTING.md for how to contribute to typing_extensions
.