Minimal, modern embedded V8 for Python.
- Latest ECMAScript support
- Web Assembly support
- Unicode support
- Thread safe
- Re-usable contexts
MiniRacer can be easily used by Django or Flask projects to minify assets, run babel or WASM modules.
PyMiniRacer was created by Sqreen, and originally lived at
https://github.com/sqreen/PyMiniRacer with the PyPI package
py-mini-racer.
As of March 2024, after a few years without updates, I have
reached out to the original Sqreen team. We agreed that I should fork PyMiniRacer,
giving it a new home at https://github.com/bpcreech/PyMiniRacer with a new PyPI
package mini-racer (note: no py-). It now
has a new version for the
first time since 2021!
MiniRacer is straightforward to use:
$ pip install mini-racerand then:
$ python3
>>> from py_mini_racer import MiniRacer
>>> ctx = MiniRacer()
>>> ctx.eval("1+1")
2
>>> ctx.eval("var x = {company: 'Sqreen'}; x.company")
'Sqreen'
>>> print(ctx.eval("'❤'"))
❤
>>> ctx.eval("var fun = () => ({ foo: 1 });")Variables are kept inside of a context:
>>> ctx.eval("x.company")
'Sqreen'While eval only supports returning primitive data types such as strings, call
supports returning composite types such as objects:
>>> ctx.call("fun")
{'foo': 1}Composite values are serialized using JSON. Use a custom JSON encoder when sending non-JSON encodable parameters:
import json
from datetime import datetime
class CustomEncoder(json.JSONEncoder):
def default(self, obj):
if isinstance(obj, datetime):
return obj.isoformat()
return json.JSONEncoder.default(self, obj) >>> ctx.eval("var f = function(args) { return args; }")
>>> ctx.call("f", datetime.now(), encoder=CustomEncoder)
'2017-03-31T16:51:02.474118'MiniRacer is ES6 capable:
>>> ctx.execute("[1,2,3].includes(5)")
FalseMiniRacer supports the ECMA Intl API:
# Indonesian dates!
>>> ctx.eval('Intl.DateTimeFormat(["ban", "id"]).format(new Date())')
'16/3/2024'V8 heap information can be retrieved:
>>> ctx.heap_stats()
{'total_physical_size': 1613896,
'used_heap_size': 1512520,
'total_heap_size': 3997696,
'total_heap_size_executable': 3145728,
'heap_size_limit': 1501560832}A WASM example is available in the
tests.
PyMiniRacer is compatible with Python 3.8-3.12 and is based on ctypes.
PyMiniRacer is distributed using wheels on PyPI. The wheels are intended to provide compatibility with:
| OS | x86_64 | aarch64 |
|---|---|---|
| macOS ≥ 10.9 | ✓ | ✓ |
| Windows ≥ 10 | ✓ | ✖ |
| Ubuntu ≥ 20.04 | ✓ | ✓ |
| Debian ≥ 11 | ✓ | ✓ |
| RHEL ≥ 8 | ✓ | ✓ |
| other Linuxes with glibc ≥ 2.31 | ✓ | ✓ |
| Alpine ≥ 3.19 | ✓ | ✓ |
| other Linux with musl ≥ 1.2 | ✓ | ✓ |
If you have a up-to-date pip and it doesn't use a wheel, you might have an environment for which no wheel is built. Please open an issue.
Built with love by Sqreen.
PyMiniRacer launch was described in
this blog post.
PyMiniRacer is inspired by mini_racer, built for the Ruby world by Sam Saffron.
In 2024, PyMiniRacer was revived, and adopted by Ben Creech. Upon discussion with the original Sqreen authors, we decided to re-launch PyMiniRacer as a fork under https://github.com/bpcreech/PyMiniRacer and https://pypi.org/project/mini-racer/.