Tutorial document

Thoughts on the tutorial document.

Basic Topics

• Set up a basic venv with a pinned mypy version. (For compatibility reasons.) Should add a note about using a current version in production.
• Annotating variables.
• Annotating functions and methods.
• Unions, using | None
• Any
• cast() and # type: ignore
• Using generics, variance
• Built-in collections
• Type aliases
• int/float
• NoReturn (not strictly necessary, but a fairly easy topic)
• Installing third-party stubs

Advanced Topics

The are fairly complicated topics, but basically required when typing a non-trivial code base:

• Callable
• Writing generics
• Protocols
• type[...]
• typing.TYPE_CHECKING and circular imports
• TypeVar and AnyStr
• overloads
• Literal

What not to include

• # type annotations (except # type: ignore)

The following topics could arguably be included, but for simplicity's sake, I'd suggest to skip them in this basic tutorial:

• NewType
• ClassVar
• Final
• Annotated
• NamedTuple
• TypedDict

Other Thoughts

• We can use a newer version of Python (e.g. 3.8+) for simplicity and add a note that not all features are available in older Python versions.
• We should probably just use from __future__ import annotations and skip the whole forward references/quoting types problem.

L’issue ne nomme aucun fichier de tutoriel, point d’entrée ni test. Commencez par localiser la documentation existante du tutoriel et comparez-la aux listes proposées de sujets de base et avancés. La tâche est considérée comme terminée lorsque le périmètre du tutoriel, les indications concernant la version de Python, les sujets de typing inclus et les exclusions ont été convenus, puis que ces décisions ont été documentées.