pywebio_battery — PyWebIO battery

Utilities that help write PyWebIO apps quickly and easily.

Note

pywebio_battery is an extension package of PyWebIO, you must install it before using it. To install this package, run pip3 install -U pywebio-battery

Functions list

Interaction related

Function name	Description
confirm	Confirmation modal
popup_input	Show a form in popup window
redirect_stdout	redirecting stdout to pywebio
run_shell	Run command in shell
put_logbox, logbox_append	Logbox widget

Web application related

Function name	Description
get_all_query, get_query	Get URL parameter
set_localstorage, get_localstorage	User browser storage
set_cookie, get_cookie	Web Cookie
login	Authentication

pywebio_battery.confirm(title, content=None, *, timeout=None)

Show a confirmation modal.

Parameters

• title (str) – Model title.

• content (list/put_xxx()) – Model content.

• timeout (None/float) – Seconds for operation time out.

Returns

Return True when the “CONFIRM” button is clicked, return False when the “CANCEL” button is clicked, return None when a timeout is given and the operation times out.

pywebio_battery.popup_input(pins, title='Please fill out the form below')

Show a form in popup window.

Parameters

• pins (list) – pin output list.

• title (str) – model title.

Returns

return the form value as dict, return None when user cancel the form.

pywebio_battery.redirect_stdout(output_func=functools.partial(<function put_text>, inline=True))

Context manager for temporarily redirecting stdout to pywebio.

with redirect_stdout():
    print("Hello world.")

pywebio_battery.run_shell(cmd, output_func=functools.partial(<function put_text>, inline=True))

Run command in shell and output the result to pywebio

pywebio_battery.put_logbox(name, height=400, keep_bottom=True) → pywebio.io_ctrl.Output

Output a logbox widget

import time

put_logbox("log")
while True:
    logbox_append("log", f"{time.time()}\n")
    time.sleep(0.2)

Parameters

• name (str) – the name of the widget, must unique in session-wide.

• height (int) – the height of the widget in pixel

• keep_bottom (bool) – Whether to scroll to bottom when new content is appended (via logbox_append()).

Changed in version 0.3: add keep_bottom parameter

pywebio_battery.logbox_append(name, text)

Append text to a logbox widget

pywebio_battery.get_all_query()

Get URL parameter (also known as “query strings” or “URL query parameters”) as a dict

pywebio_battery.get_query(name)

Get URL parameter value

pywebio_battery.set_localstorage(key, value)

Save data to user’s web browser

The data is specific to the origin (protocol+domain+port) of the app. Different origins use different web browser local storage.

Parameters

• key (str) – the key you want to create/update.

• value (str) – the value you want to give the key you are creating/updating.

You can read the value by using get_localstorage(key)

pywebio_battery.get_localstorage(key) → str

Get the key’s value in user’s web browser local storage

pywebio_battery.set_cookie(key, value, days=7)

Set cookie

pywebio_battery.get_cookie(key)

Get cookie