jprdonnelly/pyscript
1
0
Fork 0
mirror of https://github.com/pyscript/pyscript.git synced 2025-12-19 18:27:29 -05:00
Code Issues Projects Releases Wiki Activity

Add docs to repl with attr src (#1353)

Browse Source 
* Add docs to repl with attr src

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Mike Chen
2023-04-03 20:19:23 +08:00
committed by GitHub
parent d7e80ad51b
commit 088a264910
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/reference/elements/py-repl.md
View File

@@ -4,12 +4,13 @@ The `<py-repl>` element provides a REPL(Read Eval Print Loop) to evaluate multi-
## Attributes
| attribute | type | default | description |
|-------------------|---------|---------|---------------------------------------|
| attribute | type | default | description |
|-------------------|---------|---------|--------------------------------------|
| **auto-generate** | boolean | | Auto-generates REPL after evaluation |
| **output-mode** | string | "" | Determines whether the output element is cleared prior to writing output |
| **output** | string | | The id of the element to write `stdout` and `stderr` to |
| **output** | string | | The id of the element to write `stdout` and `stderr` to |
| **stderr** | string | | The id of the element to write `stderr` to |
| **src** | string | | Resource to be preloaded into the REPL |
### `auto-generate`
@@ -24,6 +25,9 @@ The ID of an element in the DOM that `stdout` (e.g. `print()`), `stderr`, and th
### `stderr`
The ID of an element in the DOM that `stderr` will be written to. Defaults to None, though writes to `stderr` will still appear in the location specified by `output`.
### `src`
If a \<py-repl\> tag has the `src` attribute, during page initialization, resource in the `src` will be preloaded into the REPL. Please note that this will not run in advance. If there is content in the \<py-repl\> tag, it will be cleared and replaced with preloaded resource.
## Examples
### `<py-repl>` element set to auto-generate
@@ -46,3 +50,13 @@ The following will write "Hello! World!" to the div with id `replOutput`.
```
Note that if we `print` from the REPL (or otherwise write to `sys.stdout`), the output will be printed in the [`py-terminal`](../plugins/py-terminal.md) if is enabled.
### `<py-repl>` element with src
Preload resource from src into the REPL
```html
<py-repl id="py-repl" output="replOutput" src="./src/py/py_code.py">
If a py-repl tag has the src attribute,
the content here will be cleared and replaced.
</py-repl>
<div id="replOutput"></div>
```