Typst Python Runner Plugin

Run python code in typst using RustPython.

#import "@preview/pyrunner:0.4.0" as py

#let compiled = py.compile(
```python
def find_emails(string):
    import re
    return re.findall(r"\b[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}\b", string)

def sum_all(*array):
    return sum(array)
```)

#let txt = "My email address is john.doe@example.com and my friend's email address is jane.doe@example.net."

#py.call(compiled, "find_emails", txt)
#py.call(compiled, "sum_all", 1, 2, 3)

Block mode is also available.

#let code = ```
f'{a+b=}'
```

#py.block(code, globals: (a: 1, b: 2))

#py.block(code, globals: (a: "1", b: "2"))

The result will be a+b=3 and a+b='12'.

Current limitations

Due to restrictions of typst and its plugin system, some Python function will not work as expected:

• File and network IO will always raise an exception.
• datetime.now will always return 1970-01-01.

Also, there is no way to import third-party modules. Only bundled stdlib modules are available. We might find a way to lift this restriction, so feel free to submit an issue if you want this functionality.

API

The API reference is now generated from source comments with tidy.

• Source annotations live in pkg/pyrunner.typ.
• Generated reference entry point: docs/reference.typ.
• Build the reference PDF with make docs.

See the API reference for all functions and executable examples.

The reference includes executable examples with their actual results. Building it requires pkg/typst-pyrunner.wasm; follow the build instructions below if it is missing.

Build from source

Install wasi-stub. You should use a slightly modified one. See the related issue.

Build pyrunner.

rustup target add wasm32-wasip1
cargo build --release --target wasm32-wasip1
make pkg/typst-pyrunner.wasm

Add to local package.

make install BUILD_TYPE=release