Skip to content

Engineering documents

TyPy is an independent implementation of Python that compiles a strict subset of standard Python ahead of time to native code through LLVM. The engineering documents below are written in order, and each builds on the one before. The user documentation explains how to install TyPy and what each release accepts.

Order Document Status
1 Research Approved
2 Software requirements specification Approved
3 Use case model Approved
4 Domain model Approved
5 Software architecture Approved
6 Architecture decision records 50 records: 46 Accepted, 1 Proposed, 3 Superseded
7 Detailed design Approved
8 Test plan Draft
9 Development guide Draft

The benchmark report measures TyPy's programs against CPython, the other compilers of Python, and C, C++, Rust, Go, Java and JavaScript.

Diagrams

Diagram UML type Used by
TyPy use cases and their actors Use case diagram Use case model
How TyPy use cases build on each other Use case diagram Use case model
TyPy bounded contexts Package diagram Domain model
Source and checking concepts Class diagram, conceptual Domain model
Lowering, code generation and build concepts Class diagram, conceptual Domain model
Runtime and conformance concepts Class diagram, conceptual Domain model
Lifecycle of a heap object State machine diagram Domain model
Lifecycle of an exception State machine diagram Domain model
Lifecycle of a module in the compiler State machine diagram Domain model
TyPy in its environment Component diagram, system context Software architecture
TyPy building blocks Component diagram Software architecture
Building an executable Sequence diagram Software architecture
An exception returned through two frames Sequence diagram Software architecture
Running one conformance test Sequence diagram Software architecture
Collecting reference cycles Activity diagram Software architecture
Where TyPy and its output run Deployment diagram Software architecture
Design classes of typy_diagnostics and typy_source Class diagram, design Detailed design
Design classes of typy_check Class diagram, design Detailed design
Design classes of typy_tyir and typy_lower Class diagram, design Detailed design
Design classes of typy_codegen and typy_build Class diagram, design Detailed design
Design classes of the runtime Class diagram, design Detailed design

Each diagram is a PlantUML source in docs/diagrams/, rendered to the SVG beside it by make diagrams, which runs PlantUML in the diagrams container.