Discussion and support 61 Python 模块索引 63 索引 65 i ii PyWebIO, 发布 0.3.0 PyWebIO 是一个用于在浏览器上获取输入和进行输出的工具库。能够将原有的通过终端交互的脚本快速服务 化，供其他人在网络上通过浏览器访问使用；PyWebIO 还可以方便地整合进现有的 Web 服务，让你不需要 编写 Html 和 JS 代码，就可以构建出具有良好可用性的 PyWebIO 支持在多线程环境中使用。 Script mode 在 Script mode 下，你可以自由地启动线程，并在其中调用 PyWebIO 的交互函数。当所有非 Daemon 线程 运 行结束后，脚本退出。 Server mode Server mode 下，由于对多会话的支持，如果需要在新创建的线程中使用 PyWebIO 的交互函数，需要 手动调用register_thread(thread) span (dict) –表格的跨行/跨列信息，格式为 { (行 id, 列 id):{"col": 跨列 数, "row": 跨行数} } 其中 行 id 和 列 id 为将表格转为二维数组后的需要跨 行/列的单元格，二维数据包含表头，id 从 0 开始记数。 • anchor, before, after (str) –与put_text 函数的同名参数含义一致 使用示例: # 'Name'

PyWebIO PyWebIO是一个用于在浏览器上获取输入和进行输出的工具库。能够将原有的 通过终端交互的脚本快速服务化，供其他人在网络上通过浏览器访问使用； PyWebIO还可以方便地整合进现有的Web服务，让你不需要编写Html和JS代 码，就可以构建出具有良好可用性的Web程序。 特点 使用同步而不是基于回调的方式获取输入，无需在各个步骤之间保存状 态，使用更方便 代码侵入性小，对于旧脚本代码仅需修改输入输出逻辑 列表。 span (dict) – 表格的跨行/跨列信息，格式为 { (行id,列 id):{"col": 跨列数, "row": 跨行数} } 其中 行id 和 列id 为将表格转为二维数组后的需要跨行/列的单元格，二维 数据包含表头，id 从 0 开始记数。 anchor, before, after (str) – 与 put_text 函数的同名参数 含义一致 使用示例: # 'Name' ，则运行当前点击事件时，其他所有新的点 击事件都将被排队等待当前点击事件时运行完 成。 不开启 serial_mode 时，ThreadBasedSession 在新线程中执行回调函数。所以如果回调函数运 行时间很短， 可以关闭 serial_mode 来提高性 能。 使用示例: from functools import partial def edit_row(choice, id):

scope=- 1, position=- 1) → pywebio.io_ctrl.Output 使用网格布局输出内容 content – 输出内容. put_xxx() / None 组成的二维数组, None 表示空白. 数组项可以使用 span() 函数设置元素在 网格的跨度. cell_width (str) – 网格元素的宽度. 宽度值格式参考 put_row() 函数的 size )，然后在button的回调函数中调用输入函数来 获取输入并进行后续操作。 为什么 put_buttons() 的回调不起作用 一般情况下，在Server模式下，任务函数一旦返回(或在Script模式下，脚本运 行结束)，会话就结束了，此时事件回调也将不起作用，可以在任务函数(或脚 本)末尾处使用 pywebio.session.hold() 函数来将会话保持，这样在用户关闭 浏览器页面前，事件回调将一直可用。 bool，是否显示为小按钮样式 link: bool，是否显示为链接样式 type: file name: 下载保存为的文件名 content: 文件base64编码的内容 type: table data: 二维数组，表示表格数据，第一行为表头 span: 跨行/跨列的单元格信息，格式: {“[行id],[列id]”: {“row”:跨行数, “col”:跨列数 }} popup 显示弹窗 命令 spec

性地提供服务。当用户 访问服务地址时，PyWebIO会开启一个新会话并运行PyWebIO应用。 使用 start_server() 启动一个Web Server来将PyWebIO应用作为Web服务运 行， start_server() 可以接收一个函数作为PyWebIO应用； 也支持使用函数 列表或字典，从而使一个PyWebIO Server下可以有多个不同功能的服务，服务 之间可以通过 go_app() start_server(main, auto_open_webbrowser=True) run_async(coro) 返回一个 TaskHandler ，通过该 TaskHandler 可以查询协程运 行状态和关闭协程。 会话的结束 与基于线程的会话类似，在基于协程的会话中，当任务函数和在会话内通过 run_async() 运行的协程全部结束后，会话关闭。 对于因为用户的关闭浏览器而造成的会话结束，处理逻辑和 scope=- 1, position=- 1) → pywebio.io_ctrl.Output 使用网格布局输出内容 content – 输出内容. put_xxx() / None 组成的二维数组, None 表示空白. 数组项可以使用 span() 函数设置元素在 网格的跨度. cell_width (str) – 网格元素的宽度. cell_height (str) – 网格元素的高度

性地提供服务。当用户 访问服务地址时，PyWebIO会开启一个新会话并运行PyWebIO应用。 使用 start_server() 启动一个Web Server来将PyWebIO应用作为Web服务运 行， start_server() 可以接收一个函数作为PyWebIO应用； 也支持使用函数 列表或字典，从而使一个PyWebIO Server下可以有多个不同功能的服务，服务 之间可以通过 go_app() start_server(main, auto_open_webbrowser=True) run_async(coro) 返回一个 TaskHandler ，通过该 TaskHandler 可以查询协程运 行状态和关闭协程。 会话的结束 与基于线程的会话类似，在基于协程的会话中，当任务函数和在会话内通过 run_async() 运行的协程全部结束后，会话关闭。 对于因为用户的关闭浏览器而造成的会话结束，处理逻辑和 scope=- 1, position=- 1) → pywebio.io_ctrl.Output 使用网格布局输出内容 content – 输出内容. put_xxx() / None 组成的二维数组, None 表示空白. 数组项可以使用 span() 函数设置元素在 网格的跨度. cell_width (str) – 网格元素的宽度. cell_height (str) – 网格元素的高度

put_markdown('markdown') ]).style('margin-top: 20px') 使用 start_server() 启动一个Web Server来将PyWebIO应用作为Web服务运 行， start_server() 可以接收一个函数作为PyWebIO应用； 也支持使用函数 列表或字典，从而使一个PyWebIO Server下可以有多个不同功能的服务，服务 之间可以通过 go_app() start_server(main, auto_open_webbrowser=True) run_async(coro) 返回一个 TaskHandler ，通过该 TaskHandler 可以查询协程运 行状态和关闭协程。 会话的结束 与基于线程的会话类似，在基于协程的会话中，当任务函数和在会话内通过 run_async() 运行的协程全部结束后，会话关闭。 对于因为用户的关闭浏览器而造成的会话结束，处理逻辑和 scope=- 1, position=- 1) → pywebio.io_ctrl.Output 使用网格布局输出内容 content – 输出内容. put_xxx() / None 组成的二维数组, None 表示空白. 数组项可以使用 span() 函数设置元素在 网格的跨度. cell_width (str) – 网格元素的宽度. cell_height (str) – 网格元素的高度

put_markdown('markdown') ]).style('margin-top: 20px') 使用 start_server() 启动一个Web Server来将PyWebIO应用作为Web服务运 行， start_server() 可以接收一个函数作为PyWebIO应用； 也支持使用函数 列表或字典，从而使一个PyWebIO Server下可以有多个不同功能的服务，服务 之间可以通过 go_app() start_server(main, auto_open_webbrowser=True) run_async(coro) 返回一个 TaskHandler ，通过该 TaskHandler 可以查询协程运 行状态和关闭协程。 会话的结束 与基于线程的会话类似，在基于协程的会话中，当任务函数和在会话内通过 run_async() 运行的协程全部结束后，会话关闭。 对于因为用户的关闭浏览器而造成的会话结束，处理逻辑和 scope=- 1, position=- 1) → pywebio.io_ctrl.Output 使用网格布局输出内容 content – 输出内容. put_xxx() / None 组成的二维数组, None 表示空白. 数组项可以使用 span() 函数设置元素在 网格的跨度. cell_width (str) – 网格元素的宽度. cell_height (str) – 网格元素的高度

put_markdown('markdown') ]).style('margin-top: 20px') 使用 start_server() 启动一个Web Server来将PyWebIO应用作为Web服务运 行， start_server() 可以接收一个函数作为PyWebIO应用； 也支持使用函数 列表或字典，从而使一个PyWebIO Server下可以有多个不同功能的服务，服务 之间可以通过 go_app() start_server(main, auto_open_webbrowser=True) run_async(coro) 返回一个 TaskHandler ，通过该 TaskHandler 可以查询协程运 行状态和关闭协程。 会话的结束 与基于线程的会话类似，在基于协程的会话中，当任务函数和在会话内通过 run_async() 运行的协程全部结束后，会话关闭。 对于因为用户的关闭浏览器而造成的会话结束，处理逻辑和 scope=- 1, position=- 1) → pywebio.io_ctrl.Output 使用网格布局输出内容 content – 输出内容. put_xxx() / None 组成的二维数组, None 表示空白. 数组项可以使用 span() 函数设置元素在 网格的跨度. cell_width (str) – 网格元素的宽度. cell_height (str) – 网格元素的高度

put_markdown('markdown') ]).style('margin-top: 20px') 使用 start_server() 启动一个Web Server来将PyWebIO应用作为Web服务运 行， start_server() 可以接收一个函数作为PyWebIO应用； 也支持使用函数 列表或字典，从而使一个PyWebIO Server下可以有多个不同功能的服务，服务 之间可以通过 go_app() start_server(main, auto_open_webbrowser=True) run_async(coro) 返回一个 TaskHandler ，通过该 TaskHandler 可以查询协程运 行状态和关闭协程。 会话的结束 与基于线程的会话类似，在基于协程的会话中，当任务函数和在会话内通过 run_async() 运行的协程全部结束后，会话关闭。 对于因为用户的关闭浏览器而造成的会话结束，处理逻辑和 scope=- 1, position=- 1) → pywebio.io_ctrl.Output 使用网格布局输出内容 content – 输出内容. put_xxx() / None 组成的二维数组, None 表示空白. 数组项可以使用 span() 函数设置元素在 网格的跨度. cell_width (str) – 网格元素的宽度. cell_height (str) – 网格元素的高度

put_code('B')], size='40% 10px 60%') 参数: Example: 参数: 返回: content – 输出内容. put_xxx() / None 组成的二维数组, None 表示空白. 数组项可以使用 span() 函数设置元素在 网格的跨度. cell_width (str) – 网格元素的宽度. cell_height (str) – 网格元素的高度 tornado_http.start_server() 的 同名参数。 Application Deploy start_server() 函数可以启动一个Web服务器来将PyWebIO应用作为Web服务运 行。 webio_handler() 和 webio_view() 函数用于将PyWebIO应用整合到现有的Python Web项目中。 wsgi_app() 和 asgi_app() 用于获取运行PyWebIO应用的 有一个Nginx配置WebSocket的例子。 FastAPI/Starlette 使用 pywebio.platform.fastapi.webio_routes() 来获取在FastAPI/Starlette中运 行PyWebIO应用的路由组件，你可以将其挂载在到FastAPI/Starlette应用中。 FastAPI: from fastapi import FastAPI from pywebio.platform