|
2 | 2 |
|
3 | 3 | ## Motivation
|
4 | 4 |
|
5 |
| -[PEP 729](https://peps.python.org/pep-0729/) provides a structured and documented way to specify and evolve the Python type system. In support of this effort, an official [Python typing spec](https://github.com/python/typing/tree/main/docs/spec) has been drafted. This spec consolidates details from various historical typing-related PEPs. The spec will be modified over time to clarify unspecified and under-specified parts of the type system. It will also be extended to cover new features of the type system. |
| 5 | +[PEP 729](https://peps.python.org/pep-0729/) provides a structured and documented way to specify and evolve the Python type system. In support of this effort, an official [Python typing spec](https://typing.python.org/en/latest/spec/) has been drafted. This spec consolidates details from various historical typing-related PEPs. The spec will be modified over time to clarify unspecified and under-specified parts of the type system. It will also be extended to cover new features of the type system. |
6 | 6 |
|
7 | 7 | Accompanying the typing specification is this conformance test suite which validates the behavior of static type checkers against the specification.
|
8 | 8 |
|
9 | 9 | ## Structure & Name
|
10 | 10 |
|
11 | 11 | This project contains test cases for behaviors defined in the Python typing spec. Tests are structured and grouped in accordance with the specification's chapter headings.
|
12 | 12 |
|
13 |
| -* [concepts](https://typing.readthedocs.io/en/latest/spec/concepts.html) |
14 |
| -* [annotations](https://typing.readthedocs.io/en/latest/spec/annotations.html) |
15 |
| -* [specialtypes](https://typing.readthedocs.io/en/latest/spec/special-types.html) |
16 |
| -* [generics](https://typing.readthedocs.io/en/latest/spec/generics.html) |
17 |
| -* [qualifiers](https://typing.readthedocs.io/en/latest/spec/qualifiers.html) |
18 |
| -* [classes](https://typing.readthedocs.io/en/latest/spec/class-compat.html) |
19 |
| -* [aliases](https://typing.readthedocs.io/en/latest/spec/aliases.html) |
20 |
| -* [literals](https://typing.readthedocs.io/en/latest/spec/literal.html) |
21 |
| -* [protocols](https://typing.readthedocs.io/en/latest/spec/protocol.html) |
22 |
| -* [callables](https://typing.readthedocs.io/en/latest/spec/callables.html) |
23 |
| -* [constructors](https://typing.readthedocs.io/en/latest/spec/constructors.html) |
24 |
| -* [overloads](https://typing.readthedocs.io/en/latest/spec/overload.html) |
25 |
| -* [dataclasses](https://typing.readthedocs.io/en/latest/spec/dataclasses.html) |
26 |
| -* [typeddicts](https://typing.readthedocs.io/en/latest/spec/typeddict.html) |
27 |
| -* [tuples](https://typing.readthedocs.io/en/latest/spec/tuples.html) |
28 |
| -* [namedtuples](https://typing.readthedocs.io/en/latest/spec/namedtuples.html) |
29 |
| -* [narrowing](https://typing.readthedocs.io/en/latest/spec/narrowing.html) |
30 |
| -* [directives](https://typing.readthedocs.io/en/latest/spec/directives.html) |
31 |
| -* [distribution](https://typing.readthedocs.io/en/latest/spec/distributing.html) |
32 |
| -* [historical](https://typing.readthedocs.io/en/latest/spec/historical.html) |
| 13 | +* [concepts](https://typing.python.org/en/latest/spec/concepts.html) |
| 14 | +* [annotations](https://typing.python.org/en/latest/spec/annotations.html) |
| 15 | +* [specialtypes](https://typing.python.org/en/latest/spec/special-types.html) |
| 16 | +* [generics](https://typing.python.org/en/latest/spec/generics.html) |
| 17 | +* [qualifiers](https://typing.python.org/en/latest/spec/qualifiers.html) |
| 18 | +* [classes](https://typing.python.org/en/latest/spec/class-compat.html) |
| 19 | +* [aliases](https://typing.python.org/en/latest/spec/aliases.html) |
| 20 | +* [literals](https://typing.python.org/en/latest/spec/literal.html) |
| 21 | +* [protocols](https://typing.python.org/en/latest/spec/protocol.html) |
| 22 | +* [callables](https://typing.python.org/en/latest/spec/callables.html) |
| 23 | +* [constructors](https://typing.python.org/en/latest/spec/constructors.html) |
| 24 | +* [overloads](https://typing.python.org/en/latest/spec/overload.html) |
| 25 | +* [dataclasses](https://typing.python.org/en/latest/spec/dataclasses.html) |
| 26 | +* [typeddicts](https://typing.python.org/en/latest/spec/typeddict.html) |
| 27 | +* [tuples](https://typing.python.org/en/latest/spec/tuples.html) |
| 28 | +* [namedtuples](https://typing.python.org/en/latest/spec/namedtuples.html) |
| 29 | +* [narrowing](https://typing.python.org/en/latest/spec/narrowing.html) |
| 30 | +* [directives](https://typing.python.org/en/latest/spec/directives.html) |
| 31 | +* [distribution](https://typing.python.org/en/latest/spec/distributing.html) |
| 32 | +* [historical](https://typing.python.org/en/latest/spec/historical.html) |
33 | 33 |
|
34 | 34 | A test file is a ".py" file. The file name should start with one of the above names followed by a description of the test (with words separated by underscores). For example, `generics_paramspec_basic_usage.py` would contain the basic usage tests for `ParamSpec`. Each test file can contain multiple individual unit tests, but these tests should be related to each other. If the number of unit tests in a single test file exceeds ten, it may be desirable to split it into separate test files. This will help maintain a consistent level of granularity across tests.
|
35 | 35 |
|
|
0 commit comments