A Python-3 (CPython >= 3.5.0) Interpreter written in Rust 🐍 😱 🤘.
Check out our online demo running on WebAssembly.
To test RustPython, do the following:
$ git clone https://github.com/RustPython/RustPython
$ cd RustPython
$ cargo run demo.py
Hello, RustPython!
Or use the interactive shell:
$ cargo run
Welcome to rustpython
>>>>> 2+2
4
RustPython is in a development phase and should not be used in production or a fault intolerant setting.
Our current build supports only a subset of Python syntax.
Contribution is also more than welcome! See our contribution section for more information on this.
- Full Python-3 environment entirely in Rust (not CPython bindings)
- A clean implementation without compatibility hacks
Currently along with other areas of the project, documentation is still in an early phase.
You can read the online documentation for the latest code on master.
You can also generate documentation locally by running:
$ cargo doc # Including documentation for all dependencies
$ cargo doc --no-deps --all # Excluding all dependenciesDocumentation HTML files can then be found in the target/doc directory.
If you wish to update the online documentation, push directly to the release branch (or ask a maintainer to do so). This will trigger a Travis build that updates the documentation and WebAssembly demo page.
parser/src: python lexing, parsing and astvm/src: python virtual machinebuiltins.rs: Builtin functionscompile.rs: the python compiler from ast to bytecodeobj: python builtin types
src: using the other subcrates to bring rustpython to life.docs: documentation (work in progress)py_code_object: CPython bytecode to rustpython bytecode converter (work in progress)wasm: Binary crate and resources for WebAssembly buildtests: integration test snippets
Contributions are more than welcome, and in many cases we are happy to guide contributors through PRs or on gitter.
With that in mind, please note this project is maintained by volunteers, some of the best ways to get started are below:
Most tasks are listed in the issue tracker.
Check issues labeled with good first issue if you wish to start coding.
Another approach is to checkout the source code: builtin functions and object methods are often the simplest and easiest way to contribute.
You can also simply run
./whats_left.sh to assist in finding any
unimplemented method.
To test rustpython, there is a collection of python snippets located in the
tests/snippets directory. To run those tests do the following:
$ cd tests
$ pipenv install
$ pipenv run pytest -vThere also are some unit tests, you can run those with cargo:
$ cargo test --allAs of now the standard library is under construction. You can use a standard library by setting the RUSTPYTHONPATH environment variable.
To do this, follow this method:
$ export RUSTPYTHONPATH=~/GIT/RustPython/Lib
$ cargo run -- -c 'import xdrlib'You can play around with other standard libraries for python. For example, the ouroboros library.
The code style used is the default rustfmt codestyle. Please format your code accordingly. We also use clippy to detect rust code issues.
Chat with us on gitter.
Our code of conduct can be found here.
The initial work was based on windelbouwman/rspython and shinglyu/RustPython
These are some useful links to related projects: