gh-100956: Update directions for how to run python + wasm - #101003
gh-100956: Update directions for how to run python + wasm#101003brendandburns wants to merge 1 commit into
Conversation
|
Most changes to Python require a NEWS entry. Please add it using the blurb_it web app or the blurb command-line tool. |
|
All commit authors signed the Contributor License Agreement. |
|
@brendandburns FYI we will need you to sign the CLA before we can review this. |
brettcannon
left a comment
There was a problem hiding this comment.
Thanks for the PR! A couple clarification suggestions and some ideas on how to simplify the script and make it more of a teachable moment. 🙂
| * [Build emscripten](https://github.com/python/cpython/tree/main/Tools/wasm#wasm32-emscripten-build) | ||
| * [Serve Python WASM](https://github.com/python/cpython/tree/main/Tools/wasm#hosting-python-wasm-builds) | ||
| * [Build WASI-SDK](https://github.com/python/cpython/tree/main/Tools/wasm#wasi-wasm32-wasi) | ||
| * [Running Python in WASI]((https://github.com/python/cpython/tree/main/Tools/wasm#running-python-wasi) | ||
|
|
There was a problem hiding this comment.
We should either use relative anchor links so this works offline or rely on GitHub's automatic table of contents for all Markdown files.
| Here is a simple script that can run a python script, it expects that the Python installation | ||
| is at the root of the filesystem (and it appears that currently that is [required](https://github.com/python/cpython/issues/100307). |
There was a problem hiding this comment.
Issue #100307 is not about where you run the WASI binary from, but how you have to mount the lib directory that contains the stdlib.
| Here is a simple script that can run a python script, it expects that the Python installation | |
| is at the root of the filesystem (and it appears that currently that is [required](https://github.com/python/cpython/issues/100307). | |
| Here is a script for running a Python file. It helps demonstrate how WASI | |
| follows a capabilities security model, requiring that you explicitly clear which | |
| directories are accessible from within the WASI runtime. You can specify the | |
| _host directories_ that you want to allow in and the _guest directories_ that | |
| they map to. | |
| Make sure to update the `PYTHON_WASI_ROOT` variable in the script to the | |
| directory where you are storing your WASI binary and `lib` directories with the | |
| stdlib. |
| FILE="/$PWD/${@#}" | ||
| fi | ||
|
|
||
| PYTHON_WASI_ROOT=/Python-3.11.0-wasm32-wasi-16 |
There was a problem hiding this comment.
Should probably move this to the top and leave a comment about updating it.
| wasmtime run --dir ${PYTHON_WASI_ROOT} \ | ||
| --mapdir /::${PYTHON_WASI_ROOT} \ | ||
| --dir ${HOST_DIR} \ | ||
| --mapdir ${GUEST_DIR}::${HOST_DIR} \ | ||
| -- ${PYTHON_WASI_ROOT}/python.wasm $FILE |
There was a problem hiding this comment.
--mapdir automatically adds the host directories as accessible.
| wasmtime run --dir ${PYTHON_WASI_ROOT} \ | |
| --mapdir /::${PYTHON_WASI_ROOT} \ | |
| --dir ${HOST_DIR} \ | |
| --mapdir ${GUEST_DIR}::${HOST_DIR} \ | |
| -- ${PYTHON_WASI_ROOT}/python.wasm $FILE | |
| wasmtime run --mapdir /::${PYTHON_WASI_ROOT} \ | |
| --mapdir ${GUEST_DIR}::${HOST_DIR} \ | |
| -- ${PYTHON_WASI_ROOT}/python.wasm $FILE |
| REAL_PATH=$(realpath $1) | ||
| HOST_DIR=$(dirname $REAL_PATH) | ||
| GUEST_DIR=$HOST_DIR | ||
| FILE=${REAL_PATH} |
There was a problem hiding this comment.
Maybe to help make things clearer around the difference between host and guest directories it's worth mapping to a /workspace guest directory?
| # Launch a directory | ||
| python3-wasm some/directory/ | ||
| ``` | ||
|
|
There was a problem hiding this comment.
| If you just want to quickly launch the WASI binary, you can run | |
| `wasmtime run --dir . python.wasm`. This does require putting any code you | |
| want in the same directory as `python.wasm`. If you want to pass any | |
| arguments, use `--`, e.g. `wasmtime run --dir . python.wasm -- -c "print('hello, world!')"`. | |
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
|
Since this PR went stale, I implemented instructions in 70dc2fb . |
Issue: #100956
Happy for feedback on better/different documentation.