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

Improve pyodide.loadPackage docs (#3628)

This commit is contained in:
Roman Yurchak 2023-03-06 03:36:22 +01:00 committed by GitHub
parent 42fa9939b0
commit 3147cc324d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/js/load-package.ts
View File

@ -360,14 +360,29 @@ const cbDeprecationWarnOnce = makeWarnOnce(
);
/**
* Load a package or a list of packages over the network. This installs the
* package in the virtual filesystem. The package needs to be imported from
* Python before it can be used.
* Load packages from the Pyodide distribution or Python wheels by URL.
*
* This installs packages in the virtual filesystem. Packages
* needs to be imported from Python before it can be used.
*
* This function can only install packages included in the Pyodide distribution,
* or Python wheels by URL, without dependency resolution. It is significantly
* more limited in terms of functionality as compared to :mod:`micropip`,
* however it has less overhead and can be faster.
*
* When installing binary wheels by URLs it is user's responsibility to check
* that the installed binary wheel is compatible in terms of Python and
* Emscripten versions. Compatibility is not checked during installation time
* (unlike with micropip). If a wheel for the wrong Python/Emscripten version
* is installed it would fail at import time.
*
*
* @param names Either a single package name or URL or a list of them. URLs can
* be absolute or relative. The URLs must have file name ``<package-name>.js``
* and there must be a file called ``<package-name>.data`` in the same
* directory. The argument can be a :js:class:`~pyodide.ffi.PyProxy` of a list, in
* be absolute or relative. The URLs must correspond to Python wheels:
* either pure Python wheels, with a file name ending with `none-any.whl`
* or Emscripten/WASM 32 wheels, with a file name ending with
* `cp<pyversion>_emscripten_<em_version>_wasm32.whl`.
* The argument can be a :js:class:`~pyodide.ffi.PyProxy` of a list, in
* which case the list will be converted to JavaScript and the
* :js:class:`~pyodide.ffi.PyProxy` will be destroyed.
* @param options