Files
pyscript/docs/reference/plugins/py-terminal.md
Fábio Rosado b990bcb67a Add basic docs for py-terminal (#933)
* Add basic docs for py-terminal

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

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

* Add Antonio's suggestions

* Remove terminal = true

* fix typo

Co-authored-by: Antonio Cuni <anto.cuni@gmail.com>

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Antonio Cuni <anto.cuni@gmail.com>
2022-11-15 15:35:50 +00:00

1.2 KiB

<py-terminal>

This is one of the core plugins in PyScript, which is active by default. With it, you can print to stdout and stderr from your python code, and the output will be displayed on the page in <py-terminal>.

Configuration

You can control how <py-terminal> behaves by setting the value of the terminal configuration in your <py-config>.

value description
false Don't add <py-terminal> to the page
true Automatically add a <py-terminal> to the page
"auto" This is the default. Automatically add a <py-terminal auto>, to the page. The terminal is initially hidden and automatically shown as soon as something writes to stdout and/or stderr

Examples

<py-config>
    terminal = true
</py-config>

<py-script>
    print("Hello, world!")
</py-script>

This example will create a new <py-terminal>, the value "Hello, world!" that was printed will show in it.

You can also add one (or more) <py-terminal> to the page manually.

<py-script>
    print("Hello, world!")
</py-script>

<py-terminal></py-terminal>
If you include a `<py-terminal>` in the page, you can skip `terminal` from your `<py-config>`.