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

Improve documentation around runPythonAsync (#1748) [skip ci]

This commit is contained in:
Will Lachance 2021-07-25 15:35:56 -04:00 committed by GitHub
parent b322d6727a
commit a4aa23a040
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/js/api.js
View File

@ -102,8 +102,8 @@ Module.runPython = runPython;
*/
/**
* Inspect a Python code chunk and use :js:func:`pyodide.loadPackage` to
* install any known packages that the code chunk imports. Uses the Python API
* Inspect a Python code chunk and use :js:func:`pyodide.loadPackage` to install
* any known packages that the code chunk imports. Uses the Python API
* :func:`pyodide.find\_imports` to inspect the code.
*
* For example, given the following code as input
@ -113,7 +113,7 @@ Module.runPython = runPython;
* import numpy as np x = np.array([1, 2, 3])
*
* :js:func:`loadPackagesFromImports` will call
* ``pyodide.loadPackage(['numpy'])``. See also :js:func:`runPythonAsync`.
* ``pyodide.loadPackage(['numpy'])``.
*
* @param {string} code The code to inspect.
* @param {LogFn=} messageCallback The ``messageCallback`` argument of
@ -170,6 +170,13 @@ export function pyimport(name) {
* Runs Python code using `PyCF_ALLOW_TOP_LEVEL_AWAIT
* <https://docs.python.org/3/library/ast.html?highlight=pycf_allow_top_level_await#ast.PyCF_ALLOW_TOP_LEVEL_AWAIT>`_.
*
* .. admonition:: Python imports
* :class: warning
*
* Since pyodide 0.18.0, you must call :js:func:`loadPackagesFromImports` to
* import any python packages referenced via `import` statements in your code.
* This function will no longer do it for you.
*
* For example:
*
* .. code-block:: pyodide
@ -178,10 +185,10 @@ export function pyimport(name) {
* from js import fetch
* response = await fetch("./packages.json")
* packages = await response.json()
* # If final statement is an expression, its value is returned to
* Javascript len(packages['packages'].object_keys())
* # If final statement is an expression, its value is returned to Javascript
* len(packages.packages.object_keys())
* `);
* console.log(result); // 72
* console.log(result); // 79
*
* @param {string} code Python code to evaluate
* @returns {Py2JsResult} The result of the Python code translated to Javascript.