7422ab370d
Resolves https://github.com/pyodide/pyodide/issues/3112 This adds a carefully designed API for controlling stdin, stdout, and stderr. It changes the default behavior to be a bit more useful, though in doing so introduces some mild backwards incompatibility. In particular: 1. By default, stdin reads directly from `process.stdin` in node (as before) and raises an error if in browser (not as before). 2. By default, stdout writes directly to `process.stdout` in node (before it called console.log) and calls console.log in browser (as before). 3. By default, stderr writes directly to `process.stderr` in node (before it called console.warn) and calls console.warn in browser (as before). 4. In all three cases, by default isatty(stdin/stdout/stderr) is true in node and false in browser (in the browser it used to be true). 5. As before, if you pass `stdin`, `stdout`, or `stderr` as arguments to `loadPyodide`, `isatty` of the corresponding stream is set to false. The stdin function is now more flexible: we now correctly handle the case where it returns an ArrayBuffer or ArrayBufferView. I also added 3 new functions to set streams after Pyodide is loaded which offer additional control: * `setStdin({stdin?, error?, isatty = false})` -- Sets the stdin function. The stdin function takes no arguments and should return null, undefined, a string, or a buffer. Sets and `isatty(stdin)` to `isatty` (by default `false`). If error is true, set stdin to always raise an EIO error when it is read. * `setStdout({raw?, batched?, isatty = false})` -- If neither raw nor batched is passed, restore default stdout behavior. If rwa is passed, the raw stdout function receives a byte which it should interpret as a utf8 character code. Sets `isatty(stdout)` to isatty (by default `false`). If batched is passed but not raw, it sets a batched stdout function. The stdout function receives a string and should do something with it. In this case it ignores isatty and sets isatty(stdout) to false. * `setStderr({raw?, batched?, isatty = false})` -- same but with stderr. |
||
|---|---|---|
| .circleci | ||
| .github | ||
| benchmark | ||
| cpython | ||
| docs | ||
| emsdk | ||
| packages | ||
| pyodide-build | ||
| src | ||
| tools | ||
| .clang-format | ||
| .codecov.yml | ||
| .dockerignore | ||
| .editorconfig | ||
| .flake8 | ||
| .gitignore | ||
| .gitpod.yml | ||
| .pre-commit-config.yaml | ||
| .prettierignore | ||
| .readthedocs.yml | ||
| CODE-OF-CONDUCT.md | ||
| Dockerfile | ||
| LICENSE | ||
| Makefile | ||
| Makefile.envs | ||
| README.md | ||
| codecov.yml | ||
| conftest.py | ||
| lgtm.yml | ||
| pyodide_env.sh | ||
| pyproject.toml | ||
| repository-structure.md | ||
| requirements.txt | ||
| run_docker | ||
| setup.cfg | ||
README.md
Pyodide is a Python distribution for the browser and Node.js based on WebAssembly.
What is Pyodide?
Pyodide is a port of CPython to WebAssembly/Emscripten.
Pyodide makes it possible to install and run Python packages in the browser with micropip. Any pure Python package with a wheel available on PyPi is supported. Many packages with C extensions have also been ported for use with Pyodide. These include many general-purpose packages such as regex, PyYAML, lxml and scientific Python packages including NumPy, pandas, SciPy, Matplotlib, and scikit-learn.
Pyodide comes with a robust Javascript ⟺ Python foreign function interface so that you can freely mix these two languages in your code with minimal friction. This includes full support for error handling, async/await, and much more.
When used inside a browser, Python has full access to the Web APIs.
Try Pyodide (no installation needed)
Try Pyodide in a REPL directly in your browser. For further information, see the documentation.
Getting Started
Pyodide offers three different ways to get started depending on your needs and technical resources. These include:
- Use a hosted distribution of Pyodide: see the Getting Started documentation.
- Download a version of Pyodide from the releases page and serve it with a web server.
- Build Pyodide from source
- Build natively with
make: primarily for Linux users who want to experiment or contribute back to the project. - Use a Docker image: recommended for Windows and macOS users and for Linux users who prefer a Debian-based Docker image with the dependencies already installed.
- Build natively with
History
Pyodide was created in 2018 by Michael Droettboom at Mozilla as part of the Iodide project. Iodide is an experimental web-based notebook environment for literate scientific computing and communication.
Iodide is no longer maintained. If you want to use Pyodide in an interactive client-side notebook, see Pyodide notebook environments.
Contributing
Please view the contributing guide for tips on filing issues, making changes, and submitting pull requests. Pyodide is an independent and community-driven open-source project. The decision-making process is outlined in the Project governance.
Communication
- Blog: blog.pyodide.org
- Mailing list: mail.python.org/mailman3/lists/pyodide.python.org/
- Gitter: gitter.im/pyodide/community
- Twitter: twitter.com/pyodide
- Stack Overflow: stackoverflow.com/questions/tagged/pyodide
License
Pyodide uses the Mozilla Public License Version 2.0.