PyWebIO v1.5.1 使用手册

# 《PyWebIO v1.5.1 使用手册》总结 ## 1. 核心特点 PyWebIO 是一个可以通过 Python 代码在浏览器上实现交互的库，允许开发者像编写终端脚本一样构建 Web 应用或基于浏览器的 GUI 应用。其主要特点包括： - **同步式交互**：代码逻辑更自然，避免回调式编程。 - **命令式 API**：通过简单的函数调用实现输入、输出和布局。 - **灵活集成**：支持与主流 Web 框架（如 Flask、Django、Tornado、FastAPI 等）整合。 - **数据可视化**：支持结合第三方库（如 Bokeh、Plotly、ECharts、g2plot）实现数据可视化。 --- ## 2. 输入功能 PyWebIO 提供了丰富的输入函数，方便用户在浏览器上获取输入数据： - **基本输入**：支持文本、密码、下拉选择、复选框、单选按钮、多行文本输入和文件上传。 ```python age = input("How old are you?", type=NUMBER) password = input("Input password", type=PASSWORD) gift = select('Which gift you want?', ['keyboard', 'ipad']) agree = checkbox("User Term", options=['I agree to terms and conditions']) ``` - **高级功能**：支持输入组、动态交互和取消输入。 --- ## 3. 输出功能 PyWebIO 提供了多种输出函数，将内容显示在浏览器上： - **基础输出**：支持文本、表格、图片、Markdown 和 JavaScript。 ```python put_text("Hello, world!") put_table([["Name", "Age"], ["Alice", 30]]) put_image("image.jpg") # 支持本地图片和 URL put_markdown("# Title") ``` - **布局与动画**：支持输出内容的动画显示和布局控制。 - **提示信息**：提供 `put_info()`、`put_error()`、`put_warning()` 和 `put_success()` 函数显示不同类型的提示消息。 --- ## 4. 会话控制 - **延迟调用**：通过 `defer_call()` 实现延迟执行。 - **内容保持**：使用 `hold()` 保持输出内容不被清除。 --- ## 5. 与 Web 框架集成 PyWebIO 支持与多种 Web 框架（如 Flask、Django、Tornado、FastAPI）无缝集成，实现 Web 服务的快速开发。 - **服务器启动**：通过 `start_server()` 搭建服务。 ```python start_server(bmi, port=80) ``` - **跨框架支持**：支持基于线程和协程的执行模型。 --- ## 6. 版本更新日志 ### 1.5 版本（2021/11/20） - **新增功能**： - 支持主题定制（`pywebio.config()`）。 - 提供 `defer_call()` 和 `hold()` 会话控制函数。 - 支持 WebSocket 重连。 - 提供英文文档和示例。 - **改进**： - 默认启用 WebSocket 心跳以避免连接超时。 - 异常排查：调试模式下显示错误细节。 - 兼容最新版 aiohttp（v3.8）。 - **Bug 修复**： - 修复表格样式和大文件上传问题。 - 修复文件名过长导致的显示问题。 ### 0.3 版本（2020/5/13） - **新增功能**： - 支持 Bokeh 数据可视化。 - 提供 `session.get_info()` 获取会话信息。 - 前端代码迁移至 TypeScript。 - **改进**： - 表格支持跨行/列单元格。 - 输出内容支持动画效果。 ### 0.2 版本（2020/4/30） - **新增功能**： - 支持与 Django 和 aiohttp 集成。 - 支持 Plotly 和 Pyecharts 数据可视化。 - 添加 `defer_call()` 和 `hold()` 会话控制函数。 - **改进**： - UI 界面加入动画提升用户体验。 - 构建测试用例和 CI 工作流。 --- ## 7. 总结 PyWebIO 是一个简单强大的工具，通过命令式 API 实现了从终端脚本到 Web 应用的无缝迁移，适用于快速开发不复杂的 Web 应用或基于浏览器的 GUI 应用。其丰富的输入输出功能、灵活的集成支持以及持续的版本迭代使其成为高效开发的理想选择。