PyWebIO v1.3.3 Documentation

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

摘要

PyWebIO 是一个用于在浏览器中构建交互式Web应用的Python库，支持多种Web框架如Flask、Django、Tornado和FastAPI。文档详细介绍了如何使用PyWebIO进行应用部署、输入输出操作以及与服务器的通信协议。版本更新中新增了对FastAPI的支持、WebSocket连接重试功能、静态文件服务等特性，并改进了输入输出模块的函数。PyWebIO通过提供丰富的API，简化了Web应用开发，适用于快速构建不需要复杂UI的应用。

AI总结

PyWebIO 是一个用于快速构建基于浏览器的“富文本终端”应用的 Python 库，支持同步输入输出，无需前端知识即可实现交互式 Web 应用。它支持多种后端框架（如 Flask、Django、Tornado、aiohttp 和 FastAPI），适合快速开发不需要复杂 UI 的应用。

### 核心功能
1. **输入输出功能**
提供丰富的输入（如文本、数字、单选框、复选框、滑块等）和输出（如文本、图片、表格等）函数，简化用户交互。

2. **服务器与客户端通信**
支持 WebSocket 和 HTTP 两种通信协议，集成到现有 Web 项目中时可使用 `wsi_app()` 和 `asgi_app()`。

3. **部署方式**
- 使用 `start_server()` 启动内置服务器，支持指定端口、主机和静态文件目录。
- 通过 `path_deploy()` 和 `path_deploy_http()` 部署目录中的应用，支持默认主页和自定义索引页面。

4. **版本更新**
- **v1.3.3**：新增对 FastAPI 和 Starlette 的支持，添加 `wsi_app()` 和 `asgi_app()`，支持远程访问服务，优化输入模块（如 `slider()` 和 `update()`）。
- **v1.2**：新增 `static_dir` 参数，支持部署目录中的应用，改进错误处理。
- **v1.1**：新增 `cdn` 参数，优化 WebSocket 重连机制。
- **v1.0**：引入持久化输入支持，增强会话管理。

5. **数据可视化与第三方库集成**
支持使用 `pyg2plot` 等第三方库实现数据可视化。

### 安装
- 稳定版：`pip3 install -U pywebio`
- 开发版：`pip3 install -U https://code.aliyun.com/wang0618/pywebio/repository/archive.zip`

### 示例
以下是一个简单的 BMI 计算器示例：

from pywebio.input import input, FLOAT
from pywebio.output import put_text

weight = input("请输入您的体重（公斤）：", type=FLOAT)
height = input("请输入您的身高（米）：", type=FLOAT)

bmi = weight / (height ** 2)
put_text(f"您的 BMI 指数为：{bmi:.2f}")

### 文档结构
- **服务器-客户端通信协议**：介绍 WebSocket 和 HTTP 的数据格式。
- **输入模块**：支持多种输入类型，新增 `slider()` 和 `update()`。
- **输出模块**：支持 HTML 输出，新增 `put_tabs()`。
- **会话管理**：支持异步任务和更彻底的会话清理。
- **讨论与支持**：通过 GitHub Discussions 和 Issues 提供帮助。

PyWebIO 通过简洁的 API 和丰富的功能，帮助开发者快速构建交互式 Web 应用，适用于教育、数据分析和轻量级 Web 服务等多种场景。