Rooba
/
pyodide
mirror of https://github.com/pyodide/pyodide.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DOCS Use sphinx-issues to link prs / issues [skip CI] (#1487)

This commit is contained in:
Hood Chatham 2021-04-18 20:59:19 -04:00 committed by GitHub
parent aa9eca481c
commit 2ae0da3c45
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 76 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.py
View File

@ -47,11 +47,13 @@ extensions = [
"sphinx_pyodide",
"sphinx_argparse_cli",
"versionwarning.extension",
"sphinx_issues",
]
myst_enable_extensions = ["substitution"]
js_source_path = ["../src/", "../src/core"]
root_for_relative_js_paths = "../src/"
issues_github_path = "pyodide/pyodide"
versionwarning_messages = {
"latest": (

157
docs/project/changelog.md
View File

@ -15,142 +15,137 @@ substitutions:
### 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](https://github.com/pyodide/pyodide/pull/1236)
{pr}`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 Javascript `Promise` or other awaitable object is now a
Python awaitable.
[#880](https://github.com/pyodide/pyodide/pull/880)
{pr}`880`
- {{ API }} Instead of automatically converting Python lists and dicts into
Javascript, they are now wrapped in `PyProxy`. Added a new {any}`PyProxy.toJs`
API to request the conversion behavior that used to be implicit.
[#1167](https://github.com/pyodide/pyodide/pull/1167)
{pr}`1167`
- {{ API }} Added {any}`JsProxy.to_py` API to convert a Javascript object to Python.
[#1244](https://github.com/pyodide/pyodide/pull/1244)
{pr}`1244`
- {{ Feature }} Flexible jsimports: it now possible to add custom Python
"packages" backed by Javascript code, like the `js` package. The `js` package
is now implemented using this system.
[#1146](https://github.com/pyodide/pyodide/pull/1146)
{pr}`1146`
- {{ Feature }} 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 using `asyncio.ensure_future`.
[#1170](https://github.com/pyodide/pyodide/pull/1170)
{pr}`1170`
- {{ Feature }} A `JsProxy` of a Javascript `Promise` or other awaitable object is now a
Python awaitable.
[#880](https://github.com/pyodide/pyodide/pull/880)
{pr}`880`
- {{ Enhancement }} Made `PyProxy` of an iterable Python object an iterable Js
object: defined the `[Symbol.iterator]` method, can be used like `for(let x of
proxy)`. Made a `PyProxy` of a Python iterator an iterator: `proxy.next()` is
translated to `next(it)`. Made a `PyProxy` of a Python generator into a
Javascript generator: `proxy.next(val)` is translated to `gen.send(val)`.
[#1180](https://github.com/pyodide/pyodide/pull/1180)
{pr}`1180`
- {{ API }} Updated `PyProxy` so that if the wrapped Python object supports `__getitem__`
access, then the wrapper has `get`, `set`, `has`, and `delete` methods which do
`obj[key]`, `obj[key] = val`, `key in obj` and `del obj[key]` respectively.
[#1175](https://github.com/pyodide/pyodide/pull/1175)
{pr}`1175`
- {{ API }} The {any}`pyodide.pyimport` function is deprecated in favor of using
`pyodide.globals.get('key')`. [#1367](https://github.com/pyodide/pyodide/pull/1367)
`pyodide.globals.get('key')`. {pr}`1367`
- {{ API }} Added {any}`PyProxy.getBuffer` API to allow direct access to Python
buffers as Javascript TypedArrays.
[#1215](https://github.com/pyodide/pyodide/pull/1215)
{pr}`1215`
- {{ API }} 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](https://github.com/pyodide/pyodide/pull/1376)
{pr}`1376`
- {{ Enhancement }} Javascript `BigInt`s are converted into Python `int` and
Python `int`s larger than 2^53 are converted into `BigInt`.
[#1407](https://github.com/pyodide/pyodide/pull/1407)
{pr}`1407`
- {{ API }} Added {any}`pyodide.isPyProxy` to test if an object is a `PyProxy`.
[#1456](https://github.com/pyodide/pyodide/pull/1456)
{pr}`1456`
- {{ Enhancement }} `PyProxy` and `PyBuffer` objects are now garbage collected
if the browser supports `FinalizationRegistry`.
[#1306](https://github.com/pyodide/pyodide/pull/1306)
{pr}`1306`
### Fixed
- {{ Fix }} getattr and dir on JsProxy now report consistent results and include all
names defined on the Python dictionary backing JsProxy.
[#1017](https://github.com/pyodide/pyodide/pull/1017)
{pr}`1017`
- {{ Fix }} `JsProxy.__bool__` now produces more consistent results: both
`bool(window)` and `bool(zero-arg-callback)` were `False` but now are `True`.
Conversely, `bool(empty_js_set)` and `bool(empty_js_map)` were `True` but now
are `False`.
[#1061](https://github.com/pyodide/pyodide/pull/1061)
{pr}`1061`
- {{ Fix }} When calling a Javascript function from Python without keyword
arguments, Pyodide no longer passes a `PyProxy`-wrapped `NULL` pointer as the
last argument. [#1033](https://github.com/pyodide/pyodide/pull/1033)
last argument. {pr}`1033`
- {{ Fix }} JsBoundMethod is now a subclass of JsProxy, which fixes nested
attribute access and various other strange bugs.
[#1124](https://github.com/pyodide/pyodide/pull/1124)
{pr}`1124`
- {{ Fix }} Javascript functions imported like `from js import fetch` no longer
trigger "invalid invocation" errors (issue
[#461](https://github.com/pyodide/pyodide/issues/461)) and
`js.fetch("some_url")` also works now (issue
[#768](https://github.com/pyodide/pyodide/issues/461)).
[#1126](https://github.com/pyodide/pyodide/pull/1126)
trigger "invalid invocation" errors (issue {issue}`461`) and
`js.fetch("some_url")` also works now (issue {issue}`768`).
{pr}`1126`
- {{ Fix }} Javascript bound method calls now work correctly with keyword arguments.
[#1138](https://github.com/pyodide/pyodide/pull/1138)
{pr}`1138`
- {{ Fix }} Javascript constructor calls now work correctly with keyword
arguments.
[#1433](https://github.com/pyodide/pyodide/pull/1433)
{pr}`1433`
### pyodide-py package
- {{ Feature }} Added an `InteractiveConsole` with completion support to ease
the integration of Pyodide REPL in webpages (used in console.html)
[#1125](https://github.com/pyodide/pyodide/pull/1125) and
[#1155](https://github.com/pyodide/pyodide/pull/1155)
- {{ Feature }} Added an `InteractiveConsole` class with completion support to
ease the integration of Pyodide REPL in webpages (used in console.html)
{pr}`1125` and {pr}`1155`
- {{ 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.
[#1158](https://github.com/pyodide/pyodide/pull/1158)
{pr}`1158`
- {{ API }} Removed `as_nested_list` API in favor of `JsProxy.to_py`.
[#1345](https://github.com/pyodide/pyodide/pull/1345)
{pr}`1345`
### pyodide-js
- {{ API }} Removed iodide-specific code in `pyodide.js`. This breaks compatibility with
iodide.
[#878](https://github.com/pyodide/pyodide/pull/878),
[#981](https://github.com/pyodide/pyodide/pull/981)
{pr}`878`, {pr}`981`
- {{ API }} Removed the `pyodide.autocomplete` API, use Jedi directly instead.
[#1066](https://github.com/pyodide/pyodide/pull/1066)
{pr}`1066`
- {{ API }} Removed `pyodide.repr` API.
[#1067](https://github.com/pyodide/pyodide/pull/1067)
{pr}`1067`
- {{ Fix }} If `messageCallback` and `errorCallback` are supplied to
`pyodide.loadPackage`, `pyodide.runPythonAsync` and
`pyodide.loadPackagesFromImport`, then the messages are no longer
automatically logged to the console.
- {{ Feature }} `runPythonAsync` now runs the code with `eval_code_async`. In
particular, it is possible to use top level `await` inside of `runPythonAsync`.
particular, it is possible to use top-level await inside of `runPythonAsync`.
- `eval_code` now accepts separate `globals` and `locals` parameters.
[#1083](https://github.com/pyodide/pyodide/pull/1083)
{pr}`1083`
- Added the `pyodide.setInterruptBuffer` API. This can be used to set a
`SharedArrayBuffer` 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 a `KeyboardInterrupt` by writing to the interrupt buffer.
[#1148](https://github.com/pyodide/pyodide/pull/1148) and
[#1173](https://github.com/pyodide/pyodide/pull/1173)
{pr}`1148` and {pr}`1173`
- Changed the loading method: added an async function `loadPyodide` to load
Pyodide to use instead of `languagePluginURL` and `languagePluginLoader`. The
change is currently backwards compatible, but the old approach is deprecated.
[#1363](https://github.com/pyodide/pyodide/pull/1363)
{pr}`1363`
### micropip
- {{ Feature }} `micropip` now supports installing wheels from relative URLs.
[#872](https://github.com/pyodide/pyodide/pull/872)
{pr}`872`
- {{ API }} `micropip.install` now returns a Python `Future` instead of a Javascript `Promise`.
[#1324](https://github.com/pyodide/pyodide/pull/1324/)
{pr}`1324`
- {{ FIX }} {any}`micropip.install` now interacts correctly with
{any}`pyodide.loadPackage`.
[#1457](https://github.com/pyodide/pyodide/pull/1457/)
{pr}`1457`
- {{ FIX }} {any}`micropip.install` now handles version constraints correctly
even if there is a version of the package available from the Pyodide `indexURL`.
@ -158,7 +153,7 @@ substitutions:
### Build system
- {{ Enhancement }} Updated to latest emscripten 2.0.13 with the updstream LLVM backend
[#1102](https://github.com/pyodide/pyodide/pull/1102)
{pr}`1102`
- {{ API }} Use upstream `file_packager.py`, and stop checking package abi versions.
The `PYODIDE_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
@ -166,41 +161,36 @@ substitutions:
is introduced for this purpose.
As part of the change, Module.checkABI is no longer present.
[#991](https://github.com/pyodide/pyodide/pull/991)
{pr}`991`
- uglifyjs and lessc no longer need to be installed in the system during build
[#878](https://github.com/pyodide/pyodide/pull/878).
{pr}`878`.
- {{ Enhancement }} Reduce the size of the core Pyodide package
[#987](https://github.com/pyodide/pyodide/pull/987).
{pr}`987`.
- {{ Enhancement }} Optionally to disable docker port binding
[#1423](https://github.com/pyodide/pyodide/pull/1423).
{pr}`1423`.
- {{ Enhancement }} Run arbitrary command in docker
[#1424](https://github.com/pyodide/pyodide/pull/1424)
{pr}`1424`
### REPL
- {{ Fix }} In console.html: sync behavior, full stdout/stderr support, clean namespace,
bigger font, correct result representation, clean traceback
[#1125](https://github.com/pyodide/pyodide/pull/1125) and
[#1141](https://github.com/pyodide/pyodide/pull/1141)
{pr}`1125` and {pr}`1141`
- {{ Fix }} Switched from ̀Jedi to rlcompleter for completion in
`pyodide.console.InteractiveConsole` and so in `console.html`. This fixes
some completion issues (see
[#821](https://github.com/pyodide/pyodide/issues/821) and
[#1160](https://github.com/pyodide/pyodide/issues/1160)
some completion issues (see {issue}`821` and {issue}`1160`)
- {{ Enhancement }} Support top-level await in the console
[#1459](https://github.com/pyodide/pyodide/issues/1459)
{pr}`1459`
### Packages
- six, jedi and parso are no longer vendored in the main Pyodide package, and
need to be loaded explicitly
[#1010](https://github.com/pyodide/pyodide/pull/1010),
[#987](https://github.com/pyodide/pyodide/pull/987).
{pr}`1010`, {pr}`987`.
- Updated packages: bleach 3.3.0, packaging 20.8
[#1021](https://github.com/pyodide/pyodide/pull/1021)
[#1338](https://github.com/pyodide/pyodide/pull/1338)
{pr}`1021`, {pr}`1338`
- Added Plotly version 4.14.3 and Retrying dependency
[#1419](https://github.com/pyodide/pyodide/pull/1419)
{pr}`1419`
## Version 0.16.1
*December 25, 2020*
@ -218,60 +208,59 @@ by 0.16.1 with identical contents.
### Python and the standard library
- Pyodide includes CPython 3.8.2
[#712](https://github.com/pyodide/pyodide/pull/712)
{pr}`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](https://github.com/pyodide/pyodide/pull/796).
See [#237](https://github.com/pyodide/pyodide/pull/237) for the current
status of the threading support.
{pr}`796`.
See {issue}`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](https://github.com/pyodide/pyodide/pull/796).
{pr}`796`.
### Python / JS type conversions
- FIX Only call `Py_INCREF()` once when proxied by PyProxy
[#708](https://github.com/pyodide/pyodide/pull/708)
{pr}`708`
- Javascript exceptions can now be raised and caught in Python. They are
wrapped in pyodide.JsException.
[#891](https://github.com/pyodide/pyodide/pull/891)
{pr}`891`
### 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](https://github.com/pyodide/pyodide/pull/909).
{pr}`909`.
- FIX Get last version from PyPi when installing a module via micropip
[#846](https://github.com/pyodide/pyodide/pull/846).
{pr}`846`.
- Suppress REPL results returned by `pyodide.eval_code` by adding a semicolon
[#876](https://github.com/pyodide/pyodide/pull/876).
{pr}`876`.
- Enable monkey patching of `eval_code` and `find_imports` to customize
behavior of `runPython` and `runPythonAsync`
[#941](https://github.com/pyodide/pyodide/pull/941).
{pr}`941`.
### Build system
- Updated docker image to Debian buster, resulting in smaller images.
[#815](https://github.com/pyodide/pyodide/pull/815)
{pr}`815`
- Pre-built docker images are now available as
[`iodide-project/pyodide`](https://hub.docker.com/r/iodide/pyodide)
[#787](https://github.com/pyodide/pyodide/pull/787)
{pr}`787`
- Host 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](https://github.com/pyodide/pyodide/pull/830)
{pr}`830`
- FIX Infer package tarball directory from source URL
[#687](https://github.com/pyodide/pyodide/pull/687)
{pr}`687`
- Updated to emscripten 1.38.44 and binaryen v86 (see related
[commits](https://github.com/pyodide/pyodide/search?q=emscripten&type=commits))
- Updated default `--ldflags` argument to `pyodide_build` scripts to equal what
Pyodide actually uses.
[#817](https://github.com/pyodide/pyodide/pull/480)
{pr}`817`
- Replace C lz4 implementation with the (upstream) Javascript implementation.
[#851](https://github.com/pyodide/pyodide/pull/851)
{pr}`851`
- Pyodide deployment URL can now be specified with the `PYODIDE_BASE_URL`
environment variable during build. The `pyodide_dev.js` is no longer
distributed. To get an equivalent behavior with `pyodide.js`, set
@ -279,18 +268,18 @@ by 0.16.1 with identical contents.
window.languagePluginUrl = './';
```
before loading it.
[#855](https://github.com/pyodide/pyodide/pull/855)
{pr}`855`
- Build runtime C libraries (e.g. libxml) via package build system with correct
dependency resolution
[#927](https://github.com/pyodide/pyodide/pull/927)
{pr}`927`
- Pyodide can now be built in a conda virtual environment
[#835](https://github.com/pyodide/pyodide/pull/835)
{pr}`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](https://github.com/pyodide/pyodide/pull/893)
import caches {pr}`893`
### Packages
- New packages: freesasa, lxml, python-sat, traits, astropy, pillow,
@ -303,13 +292,13 @@ by 0.16.1 with identical contents.
- Updated packages: numpy 1.15.4, pandas 1.0.5, matplotlib 3.3.3 among others.
- New package
[pyodide-interrupt](https://pypi.org/project/pyodide-interrupts/), useful for
handling interrupts in Pyodide (see project descripion for details).
handling interrupts in Pyodide (see project description for details).
### Backward incompatible changes
- Dropped support for loading .wasm files with incorrect MIME type, following
[#851](https://github.com/pyodide/pyodide/pull/851)
{pr}`851`
### List of contributors

1
docs/requirements-doc.txt
View File

@ -8,3 +8,4 @@ autodocsumm
docutils==0.16
sphinx-argparse-cli~=1.6.0
sphinx-version-warning~=1.1.2
sphinx-issues