PyWebIO v1.3.3 Documentation

• 语言: 英语
• 格式: .pdf
• 来源: pywebio.readthedocs.io

摘要

文档介绍了PyWebIO库的功能和使用方法，包括如何在Web框架中集成、输入输出功能、会话管理、平台部署等。文档还详细介绍了不同版本的更新内容，包括新功能、性能改进和bug修复。内容涵盖PyWebIO在Tornado、Flask、Django等框架中的应用，以及如何使用WebSocket和HTTP进行通信。

AI总结

《PyWebIO v1.3.3 Documentation》总结：

1. **核心特点**
- PyWebIO 是一个用于快速开发交互式Web应用的Python框架，使用 imperative API，像编写控制台程序一样开发Web应用，输出内容到浏览器，支持输入、布局、点击事件等功能。
- 目标是用最少代码实现用户交互，同时提供良好的用户体验。

2. **输入功能**
- 提供多种输入类型（如文本、数字、文件上传等），输入函数是阻塞式的，直到表单提交成功才会返回。
- 示例：`age = input("How old are you?", type=NUMBER)`。

3. **输出功能**
- 支持输出文本、图片、表格等，提供丰富的输出函数（如 `put_text`, `put_image`, `put_table` 等）。
- 新增功能：支持 HTML 和 Markdown 输出，支持进度条 `put_processbar` 和其他交互控件。

4. **服务器-客户端通信协议**
- 使用 WebSocket 或 HTTP 进行通信，具体取决于后端框架（如 Tornado/Aiohttp 使用 WebSocket，Flask/Django 使用 HTTP）。
- 命令（Command）由服务器发送到客户端，事件（Event）由客户端发送到服务器。

5. **版本更新**
- **v1.3.3**：
- 新增 `put_html`, `put_info`, `put_error`, `put_success` 等函数。
- 支持文件上传 sanitization，防止路径解析漏洞。
- 提升应用访问速度，优化 WebSocket 和 HTTP 通信协议。
- **v1.2**：
- 支持 WebSocket 重连、静态文件服务、SEO 支持、CDN 集成等。
- 新增 `path_deploy` 和 `pywebio-path-deploy` 命令，支持从目录部署应用。
- **v1.1**：
- 新增安全功能（如 XSS 防护）、国际化支持、SEO 配置等。
- **v1.0**：
- 支持多服务跳转，新增 `go_app` 和 `put_link` 功能。
- 提供远程访问功能，支持通过 `localhost.run` 生成公网访问地址。

6. **框架集成**
- 支持与主流 Web 框架（如 Flask、Django、Aiohttp、FastAPI）集成，提供相应的视图函数或处理程序。
- 示例：在 Flask 中使用 `webio_view` 将 PyWebIO 应用绑定到指定路径。

7. **其他功能**
- 支持文件部署，将目录下的 Python 文件作为应用运行。
- 提供 SEO 配置，支持通过文档字符串或 `pywebio.platform.seo()` 设置 SEO 信息。
- 支持 JS 调用和控制台输出，增强交互体验。

总结：PyWebIO 通过简洁的 API 和丰富的功能，帮助开发者快速构建交互式 Web 应用，适用于数据可视化、Web �仪表盘、在线工具等多种场景。