VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2026-01-17 08:35:03 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

CONTRIBUTING: Use PEP 604 syntax (#5925)

Browse Source 
Co-authored-by: Akuli <akuviljanen17@gmail.com>
This commit is contained in:
Sebastian Rittau
2021-08-15 05:48:40 +02:00
committed by GitHub
parent 0e62c8ab06
commit 5f2e117bba
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@@ -327,9 +327,10 @@ checker, and leave out unnecessary detail:
Some further tips for good type hints:
* use built-in generics (`list`, `dict`, `tuple`, `set`), instead
of importing them from `typing`, **except** for arbitrary length tuples
(`Tuple[int, ...]`) (see
[python/mypy#9980](https://github.com/python/mypy/issues/9980));
of importing them from `typing`, **except** in type aliases, in base classes, and for
arbitrary length tuples (`Tuple[int, ...]`);
* use `X | Y` instead of `Union[X, Y]` and `X | None`, instead of
`Optional[X]`, **except** when it is not possible due to mypy bugs (type aliases and base classes);
* in Python 3 stubs, import collections (`Mapping`, `Iterable`, etc.)
from `collections.abc` instead of `typing`;
* avoid invariant collection types (`list`, `dict`) in argument