PyWebIO v1.3.1 Documentation

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

摘要

PyWebIO是一个用于在浏览器中进行用户交互的Python库，支持多种Web框架，如Flask、Django、Tornado、aiohttp和FastAPI。文档详细介绍了其功能、新版本更新和与Web框架的集成。主要更新包括多任务函数支持、布局功能、WebSocket和HTTP通讯协议、文件上传改进以及安全性和国际化支持。文档还列出了不兼容更改和详细的模块变更。

AI总结

### PyWebIO v1.3.1 文档总结

#### 修复内容
- **解析错误修复**：解决了`file upload()`中`max_size`和`max_total_size`参数的解析错误。
- **浏览器自动打开问题**：修复了在Python 3.6中自动打开浏览器失败的问题。

---

#### PyWebIO 1.0 新功能
**亮点**：
1. **多任务支持**：`start_server`支持多任务函数，新增`go_app()`用于任务函数之间的跳转。
2. **基于Scope的输出模型**：不再使用基于锚点的输出控制模型。
3. **布局支持**：新增`put_grid()`、`put_row()`、`put_column()`等布局函数，以及`style()`的自定义样式支持。
4. **新增输出函数**：包括`toast()`、`popup()`、`put_widget()`、`put_collapse()`、`put_link()`、`put_scrollable()`、`put_loading()`、`put_processbar()`等。
5. **输入控制**：新增`span()`和`output()`函数，支持动态设置输入项的值。
6. **JS执行支持**：新增`run_js()`和`eval_js()`函数。
7. **UI优化**：输入框改为浮动式输入框，异常捕获后前端使用`console`记录日志。

**不兼容改动**：
- 移除`pywebio.output.set_title()`和`pywebio.output.set_auto_scroll_bottom()`，改用`pywebio.session.set_env()`。
- 移除`pywebio.output.table_cell_buttons()`，改用`pywebio.output.put_buttons()`。

---

#### PyWebIO 1.3 新功能
**亮点**：
1. **持久化输入支持**：新增`pin`模块，支持持久化输入。
2. **远程访问服务**：`start_server()`新增远程访问功能，支持FastAPI和Starlette框架。
3. **输入更新与回调**：新增`input.update()`和`onchange`回调。
4. **兼容性提升**：新增`put_tabs()`、`put_html()`等输出函数，支持IPython富文本输出。
5. **WebSocket与HTTP通信**：支持通过WebSocket或HTTP协议与客户端通信。

**细节更新**：
- `put_buttons()`新增`group`和`outline`参数。
- `eval_js()`支持Promise。
- `start_server()`新增`max_file_upload`、`payload_size_limit`等参数。

---

#### PyWebIO 1.2 新功能
**亮点**：
1. **WebSocket重连支持**：新增`reconnect_timeout`参数。
2. **部署功能**：新增`path_deploy()`、`path_deploy_http()`和`pywebio-path-deploy`命令。
3. **输出函数上下文管理**：部分输出函数支持上下文管理。
4. **文档与可视化**：新增PyG2Plot的数据可视化文档。
5. **静态文件支持**：新增`static_dir`参数用于服务静态文件。

**细节更新**：
- 新增`put_info()`、`put_error()`、`put_warning()`、`put_success()`。
- `reset()`、`append()`、`insert()`支持任意类型内容。
- 弃用`pywebio.session.get_info()`，改用`pywebio.session.info`。

---

#### 核心功能
1. **同步输入输出**：采用同步方式获取输入，无需回调。
2. **布局简单高效**：非侵入式设计，旧代码只需修改输入输出操作即可转换为Web服务。
3. **框架集成支持**：支持Flask、Django、Tornado、aiohttp、FastAPI等框架。
4. **异步与协程支持**：支持`asyncio`和协程。
5. **数据可视化**：支持第三方库（如Plotly、Pyecharts）进行数据可视化。

---

#### 兼容性与安装
- **Python版本**：要求Python 3.5.2或更高版本。
- **安装**：
- 稳定版：`pip3 install -U pywebio`
- 开发版：`pip3 install -U https://code.aliyun.com/wang0618/pywebio/repository/archive.zip`

---

#### 其他资源
- **文档**：涵盖部署、协议、数据可视化等内容。
- **支持与讨论**：
- GitHub讨论区：[https://github.com/wang0618/PyWebIO/discussions](https://github.com/wang0618/PyWebIO/discussions)
- 问题报告：[https://github.com/wang0618/pywebio/issues](https://github.com/wang0618/pywebio/issues)

---

总结：PyWebIO通过简洁的API实现了Web应用的快速开发，支持多种Web框架和数据可视化，适合快速构建不需要复杂UI的应用。