Change Log¶
[0.18.0]¶
General¶
Update Pyodide now runs Python 3.9.5. #1637
Enhancement Pyodide can experimentally be used in Node.js #1689
Enhancement Pyodide now directly exposes the Emscripten filesystem API, allowing for direct manipulation of the in-memory filesystem #1692
Enhancement Pyodide’s support of emscripten file systems is expanded from the default
MEMFS
to includeIDBFS
,NODEFS
,PROXYFS
, andWORKERFS
, allowing for custom persistence strategies depending on execution environment #1596API Change The
packages.json
schema for Pyodide was redesigned for better compatibility with conda. #1700API Change
run_docker
no longer binds any port to the docker image by default. #1750
Standard library¶
API Change The following standard library modules are now available as standalone packages
distlib
They are loaded by default in
loadPyodide
, however this behavior can be disabled with thefullStdLib
parameter set tofalse
. All optional stdlib modules can then be loaded as needed withpyodide.loadPackage
. #1543Enhancement The standard library module
audioop
is now included, making thewave
,sndhdr
,aifc
, andsunau
modules usable. #1623Enhancement Added support for
ctypes
. #1656
Javascript package¶
Enhancement The Pyodide Javascript package is released to npm under npmjs.com/package/pyodide #1762
API Change
loadPyodide
no longer automatically stores the API into a global variable calledpyodide
. To get old behavior, sayglobalThis.pyodide = await loadPyodide({...})
. #1597Enhancement
loadPyodide
now accepts callback functions forstdin
,stdout
andstderr
#1728Enhancement Pyodide now ships with first party typescript types for the entire Javascript API (though no typings are available for
PyProxy
fields). #1601Enhancement It is now possible to import
Comlink
objects into Pyodide after usingpyodide.registerComlink
#1642Enhancement If a Python error occurs in a reentrant
runPython
call, the error will be propagated into the outerrunPython
context as the original error type. This is particularly important if the error is aKeyboardInterrupt
. #1447
Python package¶
Enhancement Added a new
CodeRunner
API for finer control thaneval_code
andeval_code_async
. Designed with the needs of REPL implementations in mind. #1563Enhancement Added
Console
class closely based on the Python standard librarycode.InteractiveConsole
but with support for top level await and stream redirection. Also added the subclassPyodideConsole
which automatically usespyodide.loadPackagesFromImports
on the code before running it. #1125, #1155, #1635Fix
eval_code_async
no longer automatically awaits a returned coroutine or attempts to await a returned generator object (which triggered an error). #1563
Python / JavaScript type conversions¶
API Change
pyodide.runPythonAsync
no longer automatically callspyodide.loadPackagesFromImports
. #1538.Enhancement Added the
PyProxy.callKwargs
method to allow using Python functions with keyword arguments from Javascript. #1539Enhancement Added the
PyProxy.copy
method. #1549 #1630API Change Updated the method resolution order on
PyProxy
. Performing a lookup on aPyProxy
will prefer to pick a method from thePyProxy
api, if no such method is found, it will usegetattr
on the proxied object. Prefixing a name with$
forcesgetattr
. For instance,PyProxy.destroy
now always refers to the method that destroys the proxy, whereasPyProxy.$destroy
refers to an attribute or method calleddestroy
on the proxied object. #1604API Change It is now possible to use
Symbol
keys with PyProxies. TheseSymbol
keys put markers on the PyProxy that can be used by external code. They will not currently be copied byPyProxy.copy
. #1696Enhancement Memory management of
PyProxy
fields has been changed so that fields looked up on aPyProxy
are “borrowed” and have their lifetime attached to the basePyProxy
. This is intended to allow for more idiomatic usage. (See #1617.) #1636API Change The depth argument to
toJs
is now passed as an option, sotoJs(n)
in v0.17 changed totoJs({depth : n})
. Similarly,pyodide.toPy
now takesdepth
as a named argument. Alsoto_js
andto_py
only take depth as a keyword argument. #1721API Change
toJs
andto_js
now take an optionpyproxies
, if a Javascript Array is passed for this, then any proxies created during conversion will be placed into this array. This allows easy cleanup later. Thecreate_pyproxies
option can be used to disable creation of pyproxies during conversion (instead aConversionError
is raised). #1726API Change
toJs
andto_js
now take an optiondict_converter
which will be called on a Javascript iterable of two-element Arrays as the final step of converting dictionaries. For instance, passObject.fromEntries
to convert to an object orArray.from
to convert to an array of pairs. #1742
pyodide-build¶
API Change pyodide-build is now an installable Python package, with an identically named CLI entrypoint that replaces
bin/pyodide
which is removed #1566
micropip¶
Fix micropip now correctly handles packages that have mixed case names. (See #1614). #1615
Enhancement micropip now resolves dependencies correctly for old versions of packages (it used to always use the dependencies from the most recent version, see #1619 and #1745). micropip also will resolve dependencies for wheels loaded from custom urls. #1753
Version 0.17.0¶
April 21, 2021
See the Version 0.17.0 Release Notes for more information.
Improvements to package loading and dynamic linking¶
Enhancement Uses the emscripten preload plugin system to preload .so files in packages
Enhancement Support for shared library packages. This is used for CLAPACK which makes scipy a lot smaller. #1236
Fix Pyodide and included packages can now be used with Safari v14+. Safari v13 has also been observed to work on some (but not all) devices.
Python / JS type conversions¶
Feature A
JsProxy
of a JavascriptPromise
or other awaitable object is now a Python awaitable. #880API Change Instead of automatically converting Python lists and dicts into Javascript, they are now wrapped in
PyProxy
. Added a newPyProxy.toJs
API to request the conversion behavior that used to be implicit. #1167API Change Added
JsProxy.to_py
API to convert a Javascript object to Python. #1244Feature Flexible jsimports: it now possible to add custom Python “packages” backed by Javascript code, like the
js
package. Thejs
package is now implemented using this system. #1146Feature A
PyProxy
of a Python coroutine or awaitable is now an awaitable Javascript object. Awaiting a coroutine will schedule it to run on the Python event loop usingasyncio.ensure_future
. #1170Enhancement Made
PyProxy
of an iterable Python object an iterable Js object: defined the[Symbol.iterator]
method, can be used likefor(let x of proxy)
. Made aPyProxy
of a Python iterator an iterator:proxy.next()
is translated tonext(it)
. Made aPyProxy
of a Python generator into a Javascript generator:proxy.next(val)
is translated togen.send(val)
. #1180API Change Updated
PyProxy
so that if the wrapped Python object supports__getitem__
access, then the wrapper hasget
,set
,has
, anddelete
methods which doobj[key]
,obj[key] = val
,key in obj
anddel obj[key]
respectively. #1175API Change The
pyodide.pyimport
function is deprecated in favor of usingpyodide.globals.get('key')
. #1367API Change Added
PyProxy.getBuffer
API to allow direct access to Python buffers as Javascript TypedArrays. #1215API Change The innermost level of a buffer converted to Javascript used to be a TypedArray if the buffer was contiguous and otherwise an Array. Now the innermost level will be a TypedArray unless the buffer format code is a ‘?’ in which case it will be an Array of booleans, or if the format code is a “s” in which case the innermost level will be converted to a string. #1376
Enhancement Javascript
BigInt
s are converted into Pythonint
and Pythonint
s larger than 2^53 are converted intoBigInt
. #1407API Change Added
pyodide.isPyProxy
to test if an object is aPyProxy
. #1456Enhancement
PyProxy
andPyBuffer
objects are now garbage collected if the browser supportsFinalizationRegistry
. #1306Enhancement Automatic conversion of Javascript functions to CPython calling conventions. #1051, #1080
Enhancement Automatic detection of fatal errors. In this case Pyodide will produce both a Javascript and a Python stack trace with explicit instruction to open a bug report. pr
{1151}
, pr{1390}
, pr{1478}
.Enhancement Systematic memory leak detection in the test suite and a large number of fixed to memory leaks. pr
{1340}
Fix getattr and dir on JsProxy now report consistent results and include all names defined on the Python dictionary backing JsProxy. #1017
Fix
JsProxy.__bool__
now produces more consistent results: bothbool(window)
andbool(zero-arg-callback)
wereFalse
but now areTrue
. Conversely,bool(empty_js_set)
andbool(empty_js_map)
wereTrue
but now areFalse
. #1061Fix When calling a Javascript function from Python without keyword arguments, Pyodide no longer passes a
PyProxy
-wrappedNULL
pointer as the last argument. #1033Fix JsBoundMethod is now a subclass of JsProxy, which fixes nested attribute access and various other strange bugs. #1124
Fix Javascript functions imported like
from js import fetch
no longer trigger “invalid invocation” errors (issue #461) andjs.fetch("some_url")
also works now (issue #768). #1126Fix Javascript bound method calls now work correctly with keyword arguments. #1138
Fix Javascript constructor calls now work correctly with keyword arguments. #1433
pyodide-py package¶
Feature Added a Python event loop to support asyncio by scheduling coroutines to run as jobs on the browser event loop. This event loop is available by default and automatically enabled by any relevant asyncio API, so for instance
asyncio.ensure_future
works without any configuration. #1158API Change Removed
as_nested_list
API in favor ofJsProxy.to_py
. #1345
pyodide-js¶
API Change Removed iodide-specific code in
pyodide.js
. This breaks compatibility with iodide. #878, #981API Change Removed the
pyodide.autocomplete
API, use Jedi directly instead. #1066API Change Removed
pyodide.repr
API. #1067Fix If
messageCallback
anderrorCallback
are supplied topyodide.loadPackage
,pyodide.runPythonAsync
andpyodide.loadPackagesFromImport
, then the messages are no longer automatically logged to the console.Feature
runPythonAsync
now runs the code witheval_code_async
. In particular, it is possible to use top-level await inside ofrunPythonAsync
.eval_code
now accepts separateglobals
andlocals
parameters. #1083Added the
pyodide.setInterruptBuffer
API. This can be used to set aSharedArrayBuffer
to be the keyboard interupt buffer. If Pyodide is running on a webworker, the main thread can signal to the webworker that it should raise aKeyboardInterrupt
by writing to the interrupt buffer. #1148 and #1173Changed the loading method: added an async function
loadPyodide
to load Pyodide to use instead oflanguagePluginURL
andlanguagePluginLoader
. The change is currently backwards compatible, but the old approach is deprecated. #1363
micropip¶
Feature
micropip
now supports installing wheels from relative URLs. #872API Change
micropip.install
now returns a PythonFuture
instead of a JavascriptPromise
. #1324Fix
micropip.install
now interacts correctly withpyodide.loadPackage
. #1457Fix
micropip.install
now handles version constraints correctly even if there is a version of the package available from the PyodideindexURL
.
Build system¶
Enhancement Updated to latest emscripten 2.0.13 with the updstream LLVM backend #1102
API Change Use upstream
file_packager.py
, and stop checking package abi versions. ThePYODIDE_PACKAGE_ABI
environment variable is no longer used, but is still set as some packages use it to detect whether it is being built for Pyodide. This usage is deprecated, and a new environment variablePYODIDE
is introduced for this purpose.As part of the change, Module.checkABI is no longer present. #991
uglifyjs and lessc no longer need to be installed in the system during build #878.
Enhancement Reduce the size of the core Pyodide package #987.
Enhancement Optionally to disable docker port binding #1423.
Enhancement Run arbitrary command in docker #1424
Docker images for Pyodide are now accessible at pyodide/pyodide-env and pyodide/pyodide.
Enhancement Option to run docker in non-interactive mode #1641
REPL¶
Fix In console.html: sync behavior, full stdout/stderr support, clean namespace, bigger font, correct result representation, clean traceback #1125 and #1141
Fix Switched from ̀Jedi to rlcompleter for completion in
pyodide.console.InteractiveConsole
and so inconsole.html
. This fixes some completion issues (see #821 and #1160)Enhancement Support top-level await in the console #1459
Packages¶
List of contributors¶
(in alphabetic order)
Aditya Shankar, casatir, Dexter Chua, dmondev, Frederik Braun, Hood Chatham, Jan Max Meyer, Jeremy Tuloup, joemarshall, leafjolt, Michael Greminger, Mireille Raad, Ondřej Staněk, Paul m. p. P, rdb, Roman Yurchak, Rudolfs
Version 0.16.1¶
December 25, 2020
Note: due to a CI deployment issue the 0.16.0 release was skipped and replaced by 0.16.1 with identical contents.
Pyodide files are distributed by JsDelivr,
https://cdn.jsdelivr.net/pyodide/v0.16.1/full/pyodide.js
The previous CDNpyodide-cdn2.iodide.io
still works and there are no plans for deprecating it. However please use JsDelivr as a more sustainable solution, including for earlier Pyodide versions.
Python and the standard library¶
Pyodide includes CPython 3.8.2 #712
ENH Patches for the threading module were removed in all packages. Importing the module, and a subset of functionality (e.g. locks) works, while starting a new thread will produce an exception, as expected. #796. See #237 for the current status of the threading support.
ENH The multiprocessing module is now included, and will not fail at import, thus avoiding the necessity to patch included packages. Starting a new process will produce an exception due to the limitation of the WebAssembly VM with the following message:
Resource temporarily unavailable
#796.
Python / JS type conversions¶
pyodide-py package and micropip¶
The
pyodide.py
file was transformed to a pyodide-py package. The imports remain the same so this change is transparent to the users #909.FIX Get last version from PyPi when installing a module via micropip #846.
Suppress REPL results returned by
pyodide.eval_code
by adding a semicolon #876.Enable monkey patching of
eval_code
andfind_imports
to customize behavior ofrunPython
andrunPythonAsync
#941.
Build system¶
Updated docker image to Debian buster, resulting in smaller images. #815
Pre-built docker images are now available as
iodide-project/pyodide
#787Host Python is no longer compiled, reducing compilation time. This also implies that Python 3.8 is now required to build Pyodide. It can for instance be installed with conda. #830
FIX Infer package tarball directory from source URL #687
Updated to emscripten 1.38.44 and binaryen v86 (see related commits)
Updated default
--ldflags
argument topyodide_build
scripts to equal what Pyodide actually uses. #817Replace C lz4 implementation with the (upstream) Javascript implementation. #851
Pyodide deployment URL can now be specified with the
PYODIDE_BASE_URL
environment variable during build. Thepyodide_dev.js
is no longer distributed. To get an equivalent behavior withpyodide.js
, setwindow.languagePluginUrl = "./";
before loading it. #855
Build runtime C libraries (e.g. libxml) via package build system with correct dependency resolution #927
Pyodide can now be built in a conda virtual environment #835
Other improvements¶
Modifiy MEMFS timestamp handling to support better caching. This in particular allows to import newly created Python modules without invalidating import caches #893
Packages¶
New packages: freesasa, lxml, python-sat, traits, astropy, pillow, scikit-image, imageio, numcodecs, msgpack, asciitree, zarr
Note that due to the large size and the experimental state of the scipy package, packages that depend on scipy (including scikit-image, scikit-learn) will take longer to load, use a lot of memory and may experience failures.
Updated packages: numpy 1.15.4, pandas 1.0.5, matplotlib 3.3.3 among others.
New package pyodide-interrupt, useful for handling interrupts in Pyodide (see project description for details).
Backward incompatible changes¶
Dropped support for loading .wasm files with incorrect MIME type, following #851
List of contributors¶
abolger, Aditya Shankar, Akshay Philar, Alexey Ignatiev, Aray Karjauv, casatir, chigozienri, Christian glacet, Dexter Chua, Frithjof, Hood Chatham, Jan Max Meyer, Jay Harris, jcaesar, Joseph D. Long, Matthew Turk, Michael Greminger, Michael Panchenko, mojighahar, Nicolas Ollinger, Ram Rachum, Roman Yurchak, Sergio, Seungmin Kim, Shyam Saladi, smkm, Wei Ouyang
Version 0.15.0¶
May 19, 2020
Upgrades Pyodide to CPython 3.7.4.
micropip no longer uses a CORS proxy to install pure Python packages from PyPi. Packages are now installed from PyPi directly.
micropip can now be used from web workers.
Adds support for installing pure Python wheels from arbitrary URLs with micropip.
The CDN URL for Pyodide changed to https://pyodide-cdn2.iodide.io/v0.15.0/full/pyodide.js It now supports versioning and should provide faster downloads. The latest release can be accessed via https://pyodide-cdn2.iodide.io/latest/full/
Adds
messageCallback
anderrorCallback
topyodide.loadPackage
.Reduces the initial memory footprint (
TOTAL_MEMORY
) from 1 GiB to 5 MiB. More memory will be allocated as needed.When building from source, only a subset of packages can be built by setting the
PYODIDE_PACKAGES
environment variable. See partial builds documentation for more details.New packages: future, autograd
Version 0.14.3¶
Dec 11, 2019
Convert Javascript numbers containing integers, e.g.
3.0
, to a real Python long (e.g.3
).Adds
__bool__
method to forJsProxy
objects.Adds a Javascript-side auto completion function for Iodide that uses jedi.
New packages: nltk, jeudi, statsmodels, regex, cytoolz, xlrd, uncertainties
Version 0.14.0¶
Aug 14, 2019
The built-in
sqlite
andbz2
modules of Python are now enabled.Adds support for auto-completion based on jedi when used in iodide
Version 0.12.0¶
May 3, 2019
User improvements:
Packages with pure Python wheels can now be loaded directly from PyPI. See Micropip for more information.
Thanks to PEP 562, you can now
import js
from Python and use it to access anything in the global Javascript namespace.Passing a Python object to Javascript always creates the same object in Javascript. This makes APIs like
removeEventListener
usable.Calling
dir()
in Python on a Javascript proxy now works.Passing an
ArrayBuffer
from Javascript to Python now correctly creates amemoryview
object.Pyodide now works on Safari.
Version 0.11.0¶
Apr 12, 2019
User improvements:
Support for built-in modules:
sqlite
,crypt
New packages:
mne
Developer improvements:
The
mkpkg
command will now select an appropriate archive to use, rather than just using the first.The included version of emscripten has been upgraded to 1.38.30 (plus a bugfix).
New packages:
jinja2
,MarkupSafe
Version 0.10.0¶
Mar 21, 2019
User improvements:
New packages:
html5lib
,pygments
,beautifulsoup4
,soupsieve
,docutils
,bleach
,mne
Developer improvements:
console.html
provides a simple text-only interactive console to test local changes to Pyodide. The existing notebooks based on legacy versions of Iodide have been removed.The
run_docker
script can now be configured with environment variables.