PyWebIO v1.1.0 使用手册

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

摘要

《PyWebIO v1.1.0 使用手册》详细介绍了PyWebIO的使用方法，包括输入输出功能、布局支持、安全性改进、静态资源托管以及与不同Web框架的集成。文档还涵盖了基于协程和线程的会话实现、任务函数跳转、输出控制模型的改进等内容，并提供了详细的版本更新信息和示例代码。PyWebIO通过WebSocket和HTTP协议实现服务器-客户端通信，支持在线和离线部署。

AI总结

《PyWebIO v1.1.0 使用手册》总结如下：

### 1. **核心功能**
PyWebIO 是一个用于快速开发基于浏览器的交互式 Web 应用的 Python 库，其特点是将前端和后端逻辑通过 Python 代码统一实现，类似于编写控制台程序，但输出终端为浏览器。

#### 1.1 **主要特点**
- **命令式 API**：通过 `put_text`、`put_image`、`put_table` 等函数输出内容到浏览器，通过 `input`、`select`、`file_upload` 等函数接收用户输入。
- **交互支持**：支持点击事件、表单交互、弹窗、toast 等丰富的用户交互功能。
- **布局和样式**：提供布局函数（如 `put_grid`、`put_row`、`put_column`）和样式设置（如 `style`），便于实现复杂的页面结构和美观的界面。
- **安全性**：新增防 XSS 攻击支持，确保用户输入的安全性。

#### 1.2 **运行模式**
- **基于 WebSocket 的通信**：使用 Tornado 或 aiohttp 后端时，默认采用 WebSocket 协议与浏览器通信。
- **基于 HTTP 的通信**：使用 Flask 或 Django 后端时，采用 HTTP 协议，通过轮询获取后端消息。

### 2. **输入与输出**
- **输入函数**：`input`、`select`、`file_upload` 等函数用于接收用户输入，支持文本、数字、文件等多种类型。
- **输出函数**：`put_text`、`put_image`、`put_table` 等函数用于输出内容，支持文本、图片、表格、弹窗、进度条等多种形式。

### 3. **高级功能**
#### 3.1 **基于协程的会话**
- 协程会话采用单线程模型，适合 IO 密集型任务，资源占用少，性能高。
- 协程函数支持上下文切换，减少同步与加锁需求，避免临界区问题。

#### 3.2 **静态资源托管**
- 默认使用 CDN 托管静态资源，支持离线部署时手动托管。
- 使用 `start_server` 启动服务时，可自动托管静态资源。

#### 3.3 **国际化与 SEO 支持**
- 新增 UI 国际化支持，便于开发多语言应用。
- 通过任务函数注释或 `pywebio.platform.seo()` 设置 SEO 信息。

### 4. **更新日志**
#### 4.1 **v1.1.0 主要更新**
- **新增功能**：
- 添加安全性支持：`put_html` 和 `put_markdown` 支持防 XSS 攻击。
- 新增 SEO 支持，提升应用访问速度。
- 支持 CDN 托管，Web 框架整合更方便。
- **移除或调整**：
- 移除 `pywebio.session.data()`，推荐使用 `local` 存储会话数据。
- 移除 `put_scrollable()` 的 `max_height` 参数，改为使用 `height` 替代。

#### 4.2 **v1.0.0 主要更新**
- **新增功能**：
- 支持多任务函数，提供 `go_app` 实现任务间跳转。
- 新增布局函数（`put_grid`、`put_row`、`put_column`）和自定义样式支持。
- 新增 `toast`、`popup` 等交互组件。
- **移除功能**：
- 移除基于锚点的输出控制模型，改用基于 Scope 的模型。
- 移除 `pywebio.output.set_title()` 和 `pywebio.output.set_auto_scroll_bottom()`，改用 `pywebio.session.set_env()` 进行控制。

### 5. **注意事项**
- **静态资源托管**：离线环境中需手动托管静态文件，路径可通过 `pywebio.STATIC_PATH` 获取。
- **协程支持**：基于协程的会话不支持 Script 模式，需使用 `start_server` 启动服务或集成到 Web 框架中。
- **兼容性**：部分旧版本功能已移除或调整，升级时需注意代码适配。

### 6. **开发建议**
- **设计思路**：参考终端程序的设计方式，利用 PyWebIO 的命令式 API 实现交互逻辑。
- **问题解决**：若遇到设计问题，可尝试使用 `put_buttons` 的回调机制或 `session.local` 存储会话数据。

### 7. **资源与支持**
- **文档**：提供详细的模块索引和示例代码，便于快速上手。
- **社区支持**：通过 GitHub 讨论区和 Issue 提交反馈和问题报告。

以上为《PyWebIO v1.1.0 使用手册》的核心内容总结，涵盖主要功能、更新日志及使用注意事项。