pypy / pypy / doc / dir-reference.rst

PyPy directory cross-reference

Here is a fully referenced alphabetical two-level deep directory overview of PyPy:

Directory explanation/links
`pypy/bin/`_ command-line scripts, mainly `pypy/bin/`_
`pypy/config/`_ handles the numerous options for building and running PyPy
`pypy/doc/`_ text versions of PyPy developer documentation
`pypy/doc/config/`_ documentation for the numerous translation options
`pypy/doc/discussion/`_ drafts of ideas and documentation
doc/*/ other specific documentation topics or tools
`pypy/interpreter/`_ bytecode interpreter and related objects (frames, functions, modules,...)
`pypy/interpreter/pyparser/`_ interpreter-level Python source parser
`pypy/interpreter/astcompiler/`_ interpreter-level bytecode compiler, via an AST representation
`pypy/module/`_ contains mixed modules implementing core modules with both application and interpreter level code. Not all are finished and working. Use the --withmod-xxx or --allworkingmodules translation options.
`pypy/objspace/`_ object space implementations
`pypy/objspace/std/`_ the StdObjSpace implementing CPython's objects and types
`pypy/tool/`_ various utilities and hacks used from various places
`pypy/tool/algo/`_ general-purpose algorithmic and mathematic tools
`pypy/tool/pytest/`_ support code for our testing methods
`rpython/annotator/`_ type inferencing code for RPython programs
`rpython/config/`_ handles the numerous options for RPython
`rpython/flowspace/`_ the FlowObjSpace implementing abstract interpretation
`rpython/rlib/`_ a "standard library" for RPython programs
`rpython/rtyper/`_ the RPython Typer
`rpython/rtyper/lltypesystem/`_ the low-level type system for C-like backends
`rpython/memory/`_ the garbage collector construction framework
`rpython/translator/`_ translation backends and support code
`rpython/translator/backendopt/`_ general optimizations that run before a backend generates code
`rpython/translator/c/`_ the GenC backend, producing C code from an RPython program (generally via the rtyper)
`pypy/goal/`_ our main PyPy-translation scripts live here
`rpython/translator/tool/`_ helper tools for translation
`dotviewer/`_ graph viewer
*/test/ many directories have a test subdirectory containing test modules (see Testing in PyPy)
_cache/ holds cache files from various purposes