PyWebIO v1.3.1 Documentation

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

摘要

PyWebIO是一个Python库，允许开发者通过命令式API与浏览器交互，无需HTML和JavaScript知识即可构建简单的Web应用程序或基于浏览器的GUI应用。它支持将PyWebIO应用集成到现有Web框架如Flask、Django等中，并提供多种用户输入和输出功能，如文本、图片和表格显示。文档还介绍了不同版本的更新，包括新功能如WebSocket和HTTP通信支持、安全性增强和UI国际化。PyWebIO特别适合快速开发不需要复杂界面的应用。

AI总结

### PyWebIO v1.3.1 文档总结

PyWebIO 是一个用于快速开发基于浏览器的交互式 Web 应用程序的 Python 库，其核心设计理念是简化 Web 开发流程。以下是文档的核心内容总结：

---

#### 1. **核心功能**
PyWebIO 提供了一种类似终端编程的交互方式，通过 imperative API（如 `put_text`、`put_image`、`input` 等）实现与浏览器的交互。开发者只需编写 Python 代码即可完成用户输入输出，无需深入学习 HTML 和 JavaScript。

- **输入功能**：通过 `pywebio.input` 模块获取用户输入，支持文本、数字、下拉选择等多种输入类型。
- **输出功能**：通过 `pywebio.output` 模块输出内容，支持文本、图片、表格等格式。
- **交互控制**：提供布局管理、点击事件等高级功能，增强用户体验。

---

#### 2. **与 Web 框架集成**
PyWebIO 可以轻松集成到现有的 Web 框架中，支持以下主流框架：
- **Tornado**：使用 `webio_handler` 创建 WebSocketHandler。
- **Flask**：通过 `webio_view` 将 PyWebIO 应用嵌入 Flask 路由。
- **Django**：利用 `webio_view` 将 PyWebIO 应用集成到 Django 视图。
- **aiohttp** 和 **FastAPI**：支持异步通信。

**示例（以 Flask 为例）**：

from pywebio.platform.flask import webio_view
from flask import Flask

app = Flask(__name__)
app.add_url_rule('/tool', 'webio_view', webio_view(task_func))

---

#### 3. **通信协议**
PyWebIO 使用 WebSocket 或 HTTP 协议与客户端通信：
- **WebSocket**：适用于 Tornado 和 aiohttp。
- **HTTP**：适用于 Flask 和 Django。

命令（Command）由服务器发送到客户端，事件（Event）由客户端发送到服务器。命令格式如下：

{
    "command": "command_name",
    "task_id": "task_id",
    "spec": {}
}

---

#### 4. **更新日志**
- **v1.3.1**：
- 支持重新连接 WebSocket。
- 新增静态文件服务功能。
- 提升部署灵活性，支持从目录部署应用。
- **v1.2**：
- 新增 `put_info`、`put_error` 等输出函数。
- 支持 XSS 防护（`put_html` 和 `put_markdown` 的 `sanitize` 参数）。
- 提升应用访问速度，优化协议检测。
- **v1.1**：
- 支持国际化（UI 和文档）。
- 新增 SEO 支持和 CDN 集成。
- 优化部署方式，支持 `pywebio-path-deploy` 命令。

---

#### 5. **适用场景**
PyWebIO 适合快速开发不需要复杂 UI 的 Web 应用，例如：
- 简单的交互式工具。
- 数据可视化（支持 `pyg2plot`）。
- 教学演示或控制台模拟。

---

总结来看，PyWebIO 通过简洁的 API 和灵活的框架集成方式，降低了 Web 开发的门槛，特别适合需要快速实现交互式 Web 应用的场景。