d9b8b48972
* export 'pyscript' JS module with runtime attribute, to allow accessing (Pyodide) runtime and globals from JS. * add docs to explain the js module * add integration tests for the js module Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
3.0 KiB
The PyScript Module
The code underlying PyScript is a TypeScript/JavaScript module, which is loaded and executed by the browser. This is what loads when you include, for example, <script defer src="https://pyscript.net/latest/pyscript.js"> in your HTML.
The module is exported to the browser as pyscript. The exports from this module are:
pyscript.runtime
The RunTime object which is responsible for executing Python code in the Browser. Currently, all runtimes are assumed to be Pyodide runtimes, but there is flexibility to expand this to other web-based Python runtimes in future versions.
The RunTime object has the following attributes
| attribute | type | description |
|---|---|---|
| src | string | The URL from which the current runtime was fetched |
| interpreter | RuntimeInterpretter | A reference to the runtime object itself |
| globals | any | The globals dictionary of the runtime, if applicable/accessible |
| name (optional) | string | A user-designated name for the runtime |
| lang (optional) | string | A user-designation for the language the runtime runs ('Python', 'C++', etc) |
pyscript.runtime.src
The URL from which the current runtime was fetched.
pyscript.runtime.interpreter
A reference to the Runtime wrapper that PyScript uses to execute code. object itself. This allows other frameworks, modules etc to interact with the same (Pyodide) runtime instance that PyScript uses.
For example, assuming we've loaded Pyodide, we can access the methods of the Pyodide runtime as follows:
<button onclick="logFromPython()">Click Me to Run Some Python</button>
<script>
function logFromPython(){
pyscript.runtime.interpreter.runPython(`
animal = "Python"
sound = "sss"
console.warn(f"{animal}s go " + sound * 5)
`)
}
</script>
pyscript.runtime.globals
A proxy for the runtime's globals() dictionary. For example:
<body>
<py-script>x = 42</py-script>
<button onclick="showX()">Click Me to Get 'x' from Python</button>
<script>
function showX(){
console.log(`In Python right now, x = ${PyScript.runtime.globals.get('x')}`)
}
</script>
</body>
pyscript.runtime.name
A user-supplied string for the runtime given at its creation. For user reference only - does not affect the operation of the runtime or PyScript.
PyScript.runtime.lang
A user-supplied string for the language the runtime uses given at its creation. For user reference only - does not affect the operation of the runtime or PyScript.