Repository files navigation

A Python-3 (CPython >= 3.5.0) Interpreter written in Rust 🐍 😱 🤘.

To test RustPython, do the following:

$ git clone https://github.com/RustPython/RustPython$ cd RustPython$ cargo run demo.pyHello, RustPython!

Or use the interactive shell:

$ cargo runWelcome to rustpython>>>>> 2+24

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 theonline 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 dependencies

Documentation HTML files can then be found in thetarget/doc directory.

If you wish to update the online documentation, push directly to therelease 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 ast
• vm/src: python virtual machine
  • builtins.rs: Builtin functions
  • compile.rs: the python compiler from ast to bytecode
  • obj: 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 build
• tests: 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 theissue tracker.Check issues labeled withgood first issue if you wish to start coding.

Another approach is to checkout the source code: builtin functions and object methods are often the simplestand easiest way to contribute.

You can also simply run./whats_left.sh to assist in finding anyunimplemented method.

To test rustpython, there is a collection of python snippets located in thetests/snippets directory. To run those tests do the following:

$cd tests$ pipenv install$ pipenv run pytest -v

There also are some unit tests, you can run those with cargo:

$ cargotest --all

As of now the standard library is under construction. You canuse a standard library by setting the RUSTPYTHONPATH environmentvariable.

To do this, follow this method:

$export RUSTPYTHONPATH=~/GIT/RustPython/Lib$ cargo run -- -c'import xdrlib'

You can play aroundwith other standard libraries for python. For example,theouroboros library.

See this doc

The code style used is the defaultrustfmt codestyle. Please format your code accordingly.We also useclippy to detect rust code issues.

Chat with us ongitter.

Our code of conductcan be found here.

The initial work was based onwindelbouwman/rspython andshinglyu/RustPython

These are some useful links to related projects:

• https://github.com/ProgVal/pythonvm-rust
• https://github.com/shinglyu/RustPython
• https://github.com/windelbouwman/rspython