PyWebIO v1.7.1 使用手册

• 语言: 中文（简体）
• 格式: .pdf
• 来源: pywebio.readthedocs.io

摘要

文档详细介绍了PyWebIO v1.7.1的使用方法，涵盖输入、输出、会话管理、部署及高级特性。PyWebIO通过阻塞式输入函数和实时输出函数实现用户交互，支持多种输入类型（如文本、密码、下拉选择等）和输出形式（如文本、表格、图像等）。文档还介绍了如何将PyWebIO应用部署为Web服务，支持WebSocket和HTTP协议通信，并提供了脚本模式和服务器模式的使用方法。此外，还提到了与现有Web框架的集成、持续性输入处理、数据可视化及会话管理等功能。

AI总结

《PyWebIO v1.7.1 使用手册》总结：

### 1. 核心功能
PyWebIO 是一个用于快速开发交互式 Web 应用的 Python 库，支持通过编写 Python 代码实现终端与浏览器之间的交互，提供良好的用户体验。其核心功能包括：
- **输入交互**：支持多种输入类型（文本、密码、下拉选择、复选框、单选按钮、文件上传等）。
- **输出展示**：支持文本、表格、图片、文件等多种输出形式。
- **持续性输入**：通过 `pywebio.pin` 模块实现表单的持续性输入。
- **平台部署**：支持多种部署方式（WebSocket 和 HTTP 协议），并提供跨域支持。

### 2. 主要模块
#### 2.1 输入模块 (`pywebio.input`)
- 提供多种输入函数：
- 文本输入：`input(prompt, type)`。
- 密码输入：`input(prompt, type=PASSWORD)`。
- 下拉选择：`select(prompt, options)`。
- 复选框：`checkbox(prompt, options)`。
- 单选按钮：`radio(prompt, options)`。
- 多行文本：`textarea(prompt, rows, placeholder)`。
- 文件上传：`file_upload(prompt, accept)`。
- 输入函数是阻塞式的，表单提交前不会返回。

#### 2.2 输出模块 (`pywebio.output`)
- 提供多种输出函数：
- 文本输出：`put_text(text)`。
- 表格输出：`put_table(data)`。
- 图片输出：支持本地和网络图片。
- 文件输出：`put_file(name, content)`。
- 弹窗通知：`popup(title, content)` 和 `toast(message)`。

#### 2.3 会话管理 (`pywebio.session`)
- 支持基于线程和协程的会话实现。
- 提供会话控制函数：`defer_call()` 和 `hold()`。

#### 2.4 平台部署 (`pywebio.platform`)
- 提供 `start_server()` 和 `path_deploy()` 两种部署方式：
- `start_server()`：启动 Web 服务，支持远程访问和调试模式。
- `path_deploy()`：通过目录部署应用，支持通过 URL 路径访问。

### 3. 高级特性
- **与 Web 框架集成**：支持将 PyWebIO 应用整合到现有 Web 项目中。
- **数据可视化**：支持第三方库进行数据可视化。
- **独立应用打包**：通过 `pywebio_battery` 打包成独立可执行文件。
- **持续性输入**：通过 `pywebio.pin` 模块实现表单的持续性输入。

### 4. 更新日志
- **新功能**：
- 支持所有平台的会话 reconnect。
- 添加 `put_image()` 和 `remove()` 函数。
- 支持更精细化的滚动控制。
- **改进**：
- 提升 UI 体验，添加元素显示动画。
- 支持跨域配置。
- **修复**：
- 修复 textarea 和文件上传的相关问题。
- 修复脚本模式下的显示问题。

### 5. 使用建议
- 将 PyWebIO 应用设计为类似终端程序的逻辑。
- 在遇到设计问题时，参考终端程序的交互方式。
- 对于复杂场景，可结合 `pin` 模块和回调机制。

### 6. 快速上手
- 基本示例：

  from pywebio import start_server
  from pywebio.input import input
  from pywebio.output import put_text

  def main():
      name = input("What's your name?")
      put_text(f"Hello, {name}!")

  start_server(main, port=8080)

通过以上功能和特性，PyWebIO 可以帮助开发者快速开发交互式 Web 应用，适用于教育、数据分析、Web �界面开发等多种场景。