PyWebIO v1.3.0 Documentation

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

摘要

PyWebIO是一个用于快速构建基于浏览器的交互式Web应用的Python库。它通过提供丰富的输出函数和用户输入接口，简化了Web应用的开发过程。PyWebIO可以轻松地与现有的Web框架（如Flask、Django、Tornado等）集成，允许开发者以类似控制台程序的方式编写代码，从而实现与浏览器的交互。文档详细介绍了PyWebIO的功能、安装、使用方法以及与各种Web框架的集成方式，并提供了版本更新和常见问题解答。

AI总结

### PyWebIO v1.3.0 文档总结

PyWebIO 是一个用于快速开发基于浏览器的交互式应用程序的 Python 库，其设计理念类似于终端编程，但将终端替换为浏览器。它通过命令式 API 提供了一系列函数，用于在浏览器上输出文本、图片、表格等，并获取用户输入，从而实现丰富的用户交互。

#### 核心功能

1. **用户交互**
PyWebIO 提供了多种输入方式，包括文本输入、数值输入、文件上传等。输入函数是阻塞式的，类似于 Python 的 `input()` 函数，直到用户提交表单才会返回输入值。

2. **输出功能**
支持输出文本、图片、表格等，还支持通过 `put_info()`、`put_error()` 等函数输出不同类型的消息，并支持上下文管理器模式。

3. **Web 框架集成**
PyWebIO 可以与多种主流 Web 框架集成，包括 Flask、Django、Tornado、aiohttp 和 FastAPI/Starlette。通过相应的接口函数（如 `webio_view()` 和 `webio_handler()`），可以将 PyWebIO 应用作为 Web 服务运行。

4. **部署与优化**
PyWebIO 提供了静态文件服务功能，并支持通过 `start_server()` 配置端口、主机和静态目录等参数。在反向代理（如 Nginx）场景下，需配置 WebSocket 支持以确保通信正常。

#### 新功能与改进

1. **1.3.0 版本更新**
- 支持 WebSocket 连接重试，增加 `reconnect_timeout` 参数。
- 提供 `path_deploy()` 和 `path_deploy_http()` 命令，方便从目录部署应用。
- 支持更多输出函数的上下文管理器模式。
- 修复了文件上传、输入验证等多处问题。

2. **1.2 版本更新**
- 增加了 `put_info()`、`put_error()` 等消息输出函数。
- 支持通过 `pywebio.platform.seo()` 设置 SEO 信息。
- 改进了静态文件服务和文档的英文版本。

3. **1.1 版本更新**
- 增加了 XSS 防护功能，支持 `sanitize` 参数防止跨站脚本攻击。
- 支持多语言界面和 SEO 配置。
- 优化了应用访问速度，减少了探测请求。

4. **1.0 版本更新**
- 引入了 `put_grid()`、`put_row()` 等布局函数，支持更复杂的 UI 组件。
- 增加了 JavaScript 支持，允许在浏览器上运行 JavaScript 代码。
- 提供了更丰富的控制台交互功能。

#### 常见问题

- 如何让输入表单在提交后不消失？
- 如何输出搜索栏等输入组件？
- 为什么 `put_buttons()` 的回调不生效？
- 为什么无法下载文件？

#### 总结

PyWebIO 通过简洁的代码实现丰富的用户交互，特别适合快速开发不需要复杂 UI 的 Web 应用。其与主流 Web 框架的集成能力，使其成为开发者的有力工具。文档提供了详细的示例和配置指南，方便用户快速上手和部署。