PyWebIO v1.7.0 Documentation

语言	格式	评分
英语	.epub	3
摘要
PyWebIO 是一个用于快速构建基于浏览器的交互式应用程序的 Python 库，支持多种 Web 框架（如 Flask、Django、FastAPI 等），提供了丰富的输出函数和布局支持。文档详细介绍了其功能特性，包括基于 WebSocket 协议的浏览器通信、非声明式布局、多任务支持以及数据可视化功能。此外，还涵盖了安装、配置和部署等内容，特别提到了在生产环境中的注意事项和静态资源托管的配置方法。
AI总结
### PyWebIO v1.7.0 文档总结 PyWebIO 是一个用于快速构建交互式 Web 应用的 Python 库，通过提供丰富的命令式 API，将浏览器变为一个“富文本终端”，适用于开发简单的 Web 应用或基于浏览器的 GUI 应用。以下是文档的核心内容总结： --- #### 1. 主要功能 - 基于 WebSocket 的通信：支持异步和同步交互，适用于快速开发交互式应用。 - 多框架支持：可与 Flask、Django、Tornado、aiohttp 和 FastAPI 等框架无缝集成。 - 丰富的输出函数：支持文本、图片、表格、弹窗、布局（网格、行、列）等交互元素。 - 数据可视化：支持与第三方库（如 pyg2plot）结合，实现数据可视化。 - 文件上传与下载：支持多文件上传和下载，可限制文件大小并显示上传进度。 - 静态资源托管：默认使用 CDN，支持离线部署和自定义静态资源路径。 --- #### 2. 版本更新 - v1.7.0：支持 WebSocket 连接的重新连接功能，新增 `reconnect_timeout` 参数；支持从目录部署应用，新增 `path_deploy()` 和 `path_deploy_http()` 函数。 - v1.6.0：优化了静态资源托管功能，支持通过 `static_dir` 参数指定静态文件目录。 - v1.5.0：新增 `put_info()`、`put_error()`、`put_warning()`、`put_success()` 等输出函数；支持通过 `pywebio-handler()` 和 `pywebio-view()` 部署应用。 - v1.4.0：新增 `put_grid()`、`put_row()`、`put_column()` 等布局函数，支持自定义样式。 - v1.3.0：支持文件上传的大小限制和进度显示，优化了输入和输出控制函数。 - v1.2.0：支持多任务函数，新增 `go_app()` 用于任务函数之间的跳转；新增 `put_toast()`、`put_popup()` 等交互控件。 - v1.1.0：新增 `put_html()` 和 `put_markdown()` 函数，支持 XSS 防护；优化了文件上传功能。 - v1.0.0：新增基于 Scope 的输出控制模型，替代了旧的基于锚点的模型；支持 `put_widget()`、`put_collapse()` 等新控件。 --- #### 3. 安装与使用 - 安装：通过 `pip` 安装稳定版或开发版。 ```bash pip3 install -U pywebio # 稳定版 pip3 install -U https://code.aliyun.com/wang0618/pywebio/repository/archive.zip # 开发版 ``` - 使用：通过命令式 API 实现交互，例如： ```python from pywebio.input import input from pywebio.output import put_text name = input("请输入你的名字：") put_text(f"你好，{name}！") ``` --- #### 4. 部署与注意事项 - 生产部署：推荐使用 uWSGI、Gunicorn 或 Uvicorn 等服务器。若使用 Flask 或 Django，建议只启动一个 worker 进程以避免会话问题。 - 静态资源：默认使用 CDN，若需离线部署，需手动托管静态文件并设置 `cdn=False`。 - 反向代理配置：若服务器使用 Nginx 等反向代理，需配置 WebSocket 支持。 - 安全性：部分输出函数支持 XSS 防护（如 `put_html()` 和 `put_markdown()`）。 --- #### 5. 文档与支持 - 用户指南：详细介绍了输入、输出、布局、事件处理等功能。 - 示例与演示：文档顶部提供示例代码的在线运行链接。 - 支持与反馈：通过 GitHub Discussions 和 Issue 提交问题和反馈。 --- 总结：PyWebIO 是一个功能强大且易于使用的工具，适合快速开发交互式 Web 应用。其基于 WebSocket 的通信机制和丰富的输出函数使其在无需复杂前端开发的情况下即可实现高效的用户交互。