PyWebIO v1.3.0 使用手册

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

摘要

文档详细介绍了PyWebIO的使用方法，包括输入输出函数的调用方式、与现有Web框架的集成、服务器模式与脚本模式的区别，以及如何通过PyWebIO进行应用部署。文档还提供了丰富的示例代码和在线演示链接，帮助用户快速上手。内容涵盖PyWebIO的核心功能，如用户输入处理、数据可视化输出、会话管理等，并介绍了安全性支持和第三方库的整合方式。

AI总结

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

PyWebIO 是一个用于快速开发交互式 Web 应用的 Python 库，其核心特点是以编写 Python 代码的方式实现前后端交互逻辑，类似于编写控制台程序，但输出内容通过浏览器展示。以下是文档的核心内容和关键信息：

### 1. **基本功能**
- **输入功能**：PyWebIO 提供多种输入方式，包括文本输入、密码输入、下拉选择、复选框、单选框和文件上传等。输入函数阻塞直到用户提交表单。
- 示例：`age = input("How old are you?", type=NUMBER)`
- **输出功能**：支持输出文本、表格、图片、文件等内容，函数实时输出到浏览器。
- 示例：`put_text("Hello world!")`、`put_table(...)`、`put_file(...)`。
- **交互支持**：提供点击事件和布局功能，支持通过最少代码实现良好的用户交互体验。

### 2. **使用模式**
- **Server 模式**：通过 `start_server()` 启动服务，支持远程访问和多任务部署。
- 示例：`pywebio.start_server(bmi, port=80)` 可在 80 端口提供服务。
- **Script 模式**：允许在交互式环境中直接调用输入输出函数，但需注意会话管理。

### 3. **部署与集成**
- **路径部署**：使用 `path_deploy()` 可以从指定目录加载 PyWebIO 应用，支持通过 URL 访问不同文件中的任务函数。
- **第三方框架集成**：PyWebIO 可与主流 Web 框架（如 Flask、Django）集成，提供路由支持。
- **静态文件托管**：`start_server()` 支持通过 `static_dir` 参数托管静态文件。

### 4. **新功能与改进**
- **安全性增强**：`put_html()` 和 `put_markdown()` 支持防 XSS 攻击。
- **国际化支持**：UI 和文档提供多语言支持。
- **SEO 支持**：通过任务函数注释或 `seo()` 函数设置 SEO 信息。
- **性能优化**：通信协议优化提升应用访问速度。

### 5. **其他功能**
- **数据可视化**：支持使用 `pyg2plot` 进行数据可视化。
- **文件下载**：`put_file()` 支持文件下载，会话保持功能确保文件可用性。
- **上下文管理**：输出函数支持上下文管理器，便于控制输出内容。

### 6. **使用建议**
- 如果在终端程序中有解决方案，可以直接在 PyWebIO 中实现类似功能。
- 遇到设计问题时，可参考控制台程序的思路，或使用 `pin` 模块解决复杂交互需求。

### 7. **文档资源**
- 提供 PDF 和 Epub 格式的离线文档。
- 示例代码均配有在线 Demo 链接，便于验证功能。

总结：PyWebIO 通过简洁的 API 和灵活的部署方式，帮助开发者快速实现交互式 Web 应用，特别适合需要快速开发和验证的场景。