mirror of
https://github.com/pyscript/pyscript.git
synced 2025-12-20 02:37:41 -05:00
8b7fb89c68
* Deprecate pyscript output attribute * Update code blocks so they work * Small tweaks to styling and use html to warning * Fix broken test from bad conflict resolution * lowercase pyodide
78 lines
3.3 KiB
Markdown
78 lines
3.3 KiB
Markdown
# pyscript
|
|
|
|
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.version
|
|
|
|
Once `pyscript.js` has loaded, the version of PyScript that is currently running can be accessed via `pyscript.version`.
|
|
```html
|
|
<script defer onload="console.log(`${pyscript.version}`)" src="https://pyscript.net/latest/pyscript.js"></script>
|
|
```
|
|
```js
|
|
//example result
|
|
Object { year: 2022, month: 11, patch: 1, releaselevel: "dev" }
|
|
```
|
|
|
|
## 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** | RuntimeInterpreter | 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](https://pyodide.org/en/stable/usage/api/js-api.html) that PyScript uses.
|
|
|
|
For example, assuming we've loaded Pyodide, we can access the methods of the Pyodide runtime as follows:
|
|
|
|
```html
|
|
<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:
|
|
|
|
```html
|
|
<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.
|