PyWebIO v1.7.1 使用手册

• 语言: 中文（简体）
• 格式: .pdf
• 来源: pywebio.readthedocs.io

摘要

文档是PyWebIO v1.7.1的使用手册，详细介绍了PyWebIO的各种功能和使用方法。PyWebIO是一个可以在浏览器上实现交互式用户界面的库，支持通过简单的代码实现输入、输出以及会话控制。文档中介绍了输入函数如text、select、file_upload等，输出函数如put_image、put_table，会话控制函数如hold、defer_call等。同时，文档还包含了PyWebIO的版本更新日志，详细列出了各个版本中新增的功能和修复的Bug。

AI总结

# 《PyWebIO v1.7.1 使用手册》总结

## 一、核心功能
PyWebIO 是一个可以通过最少代码实现用户交互并提供良好用户体验的库。其输入函数定义在 `pywebio.input` 模块中，调用这些函数会在浏览器上弹出输入表单，阻塞式等待用户提交。支持的输入类型包括文本、密码、下拉选择、复选框、单选按钮、多行文本和文件上传等。

## 二、主要特性
1. **简单高效**：通过同步方式获取输入，代码逻辑自然，布局方式简单。
2. **兼容性强**：支持与 Flask、Django、Tornado、aiohttp、FastAPI 等主流 Web 框架集成。
3. **支持数据可视化**：可以结合第三方库如 plotly、pyecharts、bokeh 等实现数据可视化。
4. **代码侵入性低**：旧脚本代码仅需修改输入输出逻辑即可改造成 Web 服务。

## 三、版本更新亮点
### 1. PyWebIO 1.0
- 支持输出 bokeh 数据可视化图表。
- 添加 `session.get_info()` 获取会话信息。
- 前端 JavaScript 代码迁移 TypeScript。

### 2. PyWebIO 1.1
- 支持绑定 onclick 回调到任意输出组件。
- 自动持久化会话。
- 添加 `output_max_width` 参数。

### 3. PyWebIO 1.2
- 支持与 FastAPI 和 Starlette 集成。
- 添加远程访问服务。
- 支持 `input_update()` 和 `onchange` 回调。

### 4. PyWebIO 1.3
- 新增 `pin` 模块提供持久化输入支持。
- 添加 `put_info()`、`put_error()` 等提示消息功能。

### 5. 新增功能
- 安全性支持：`put_html()` 和 `put_markdown()` 添加防 XSS 参数。
- 国际化支持。
- SEO 支持。

## 四、改进与修复
1. **UI 改进**：添加元素显示动画，优化页面底部 footer。
2. **输入功能增强**：`input_group()` 支持取消输入，`actions()` 函数支持 reset 和 cancel 按钮。
3. **输出功能优化**：输出函数支持锚点替换，`put_code()` 支持行数限制，`put_scrollable()` 支持自动滚动。
4. **平台支持**：`start_server()` 和 `webio_view` 添加跨域支持。
5. **会话管理**：`Session` 关闭时清理更彻底。

## 五、其他工具
- **pywebio-battery**：扩展包，提供诸多实用工具，辅助快速开发。
- **测试与文档**：构建 CI 工作流，提供完整的中英文文档。

PyWebIO 通过命令式交互函数将浏览器变为富文本终端，可快速构建简单 Web 应用或基于浏览器的 GUI 应用，适合需要快速开发但对 UI 要求不高的场景。