PyWebIO v1.6.3 Documentation

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

摘要

PyWebIO 是一个用于快速开发交互式 Web 应用的 Python 库，其核心功能包括通过 imperative API 输出文本、图片、表格等内容，并支持用户输入操作。文档详细介绍了其输入模块、输出模块、会话控制模块以及平台支持模块的功能，并提供了与常见 Web 框架（如 Flask、Django、FastAPI 等）的集成方法。此外，文档还列出了版本更新内容，包括新功能、改进和已知问题的修复。最新版本 1.6.3 提供了更好的安全性、UI 国际化支持、CDN 集成以及对 WebSocket 的支持。

AI总结

PyWebIO 是一个用于快速开发 Web 应用的 Python 库，其核心特点是以简洁的代码实现用户交互，类似于编写控制台程序，但输出内容通过浏览器展示。以下是对《PyWebIO v1.6.3 Documentation》的总结：

### 核心功能
1. **用户交互**
- 提供阻塞式的输入函数（如 `input()`、`select()`、`file_upload()`），用户输入后立即处理。
- 支持 HTML 输出（`put_html()`）、图片（`put_image()`）、表格（`put_table()`）等多样化输出形式。
- 通过 `pin` 模块实现持久化输入，输入表单不消失，可继续接收输入。

2. **平台支持**
- 支持主流 Web 框架（Flask、Django、FastAPI、Tornado、aiohttp）集成，适合现有项目扩展。
- 提供 WebSocket 和 HTTP 协议支持，默认使用 WebSocket。
- 新增 `path_deploy()` 和 `pywebio-path-deploy` 命令，方便从目录部署应用。

3. **功能增强**
- 新增 `put_info()`、`put_error()`、`put_warning()`、`put_success()` 等输出函数。
- 支持静态文件服务（`static_dir` 参数）。
- 改进文件上传限制参数（`max_file_upload`、`upload_size_limit` 等）。
- 新增 `pywebio_battery` 扩展包，提供快速开发工具。

4. **安全性**
- `put_html()` 和 `put_markdown()` 支持 XSS 防护（通过 `sanitize` 参数）。
- `file_upload()` 返回的文件名经过 sanitization，避免路径解析漏洞。

5. **性能与兼容性**
- 支持 coroutine-based 会话，提升应用响应速度。
- 兼容最新 aiohttp（v3.8）和 FastAPI，优化反向代理（如 Nginx）下的 WebSocket 配置。

### 发行说明
- **v1.6.3**
- 支持 WebSocket 重连（`reconnect_timeout`）。
- 修复文件上传溢出、图片扩展名错误等问题。
- 改进 `put_image()`、`put_scrollable()` 等 UI 组件的样式和功能。

- **v1.5.2**
- 修复线程泄漏问题。
- 支持绑定onclick回调到输出组件。

- **v1.4**
- 新增应用路由功能，支持多应用部署。
- 默认启用调试模式，显示异常堆栈。

### 总结
PyWebIO 通过简洁的 API 和丰富的功能，帮助开发者快速构建交互式 Web 应用。其对主流框架的支持和持续的功能优化，使其成为 Python 开发者的有力工具。