PyWebIO v1.0.3 使用手册

语言	格式	评分
中文（简体）	.pdf	5
摘要
PyWebIO 是一个支持通过 Python 代码实现 Web 交互的库，提供了丰富的输入和输出函数，包括文本输入、密码输入、下拉选择、勾选选项、单选选项、多行文本输入和文件上传等。输出函数支持文本、表格、Markdown、文件、弹窗等格式，并提供布局和自定义样式支持。PyWebIO 支持服务器模式和脚本模式两种运行方式，服务器模式下启动 Web 服务，脚本模式下在任意位置调用交互函数。同时支持基于协程的会话，适用于 IO 密集型任务，提供了与 Web 框架的集成、静态资源托管、跨域配置等高级功能。
AI总结
《PyWebIO v1.0.3 使用手册》是一份详细介绍PyWebIO框架使用方法的指南，旨在帮助开发者通过最少的代码实现与用户的交互，并提供良好的用户体验。以下是文档的核心内容总结： --- ### 1. 输入功能 PyWebIO 的输入函数定义在 `pywebio.input` 模块中，用于在浏览器上弹出输入表单，阻塞式获取用户输入。常见输入函数包括： - 文本输入：`input()` - 密码输入：`input(type=PASSWORD)` - 下拉选择框：`select()` - 勾选选项：`checkbox()` - 单选选项：`radio()` - 多行文本输入：`textarea()` - 文件上传：`file_upload()` --- ### 2. 输出功能 PyWebIO 的输出函数定义在 `pywebio.output` 模块中，用于实时输出内容到浏览器。常见输出函数包括： - 文本输出：`put_text()` - 表格输出：`put_table()` - Markdown 输出：`put_markdown()` - 文件输出：`put_file()` - 弹窗：`popup()` - 组合输出：支持将多个输出函数嵌套使用，例如 `put_table()` 中嵌入 `put_html()`、`put_text()` 等。 --- ### 3. Server 模式与 Script 模式 - Server 模式：通过 `start_server()` 启动一个 Web 服务，持续提供服务。用户访问服务地址时，PyWebIO 会开启新会话并运行任务函数。 - Script 模式：在脚本中自由调用 PyWebIO 交互函数，适合快速开发和测试。 --- ### 4. 会话管理 - 基于线程的会话：默认模式，用户每打开一个会话，PyWebIO 会启动一个新线程。 - 基于协程的会话：通过 `async` 和 `await` 支持协程函数，适合 IO 密集型任务，资源占用更少。 --- ### 5. 集成与配置 - 与 Web 框架集成：支持 Django、Flask、Aiohttp 等框架，通过路由配置提供服务。 - 静态资源托管：开发阶段可使用后端框架托管静态文件，生产环境建议使用 Nginx 或 CDN。 - 跨域配置：通过 `allowed_origins` 或 `check_origin` 参数配置跨域访问。 --- ### 6. 注意事项 - 会话保持：在任务函数末尾使用 `pywebio.session.hold()` 可保持会话，防止用户关闭浏览器后功能失效。 - WebSocket 支持：在反向代理（如 Nginx）后需配置支持 WebSocket 协议。 --- ### 7. 协程与并发 - 支持在多线程环境中使用，协程会话适合单线程模型，减少资源占用和同步问题。 - 新线程需通过 `register_thread()` 注册，否则可能导致会话管理异常。 --- ### 8. 版本更新 - v1.0 新增功能： - 支持多任务函数，提供 `go_app()` 跳转功能。 - 添加布局支持（`put_grid()`、`put_row()`、`put_column()`）和自定义样式。 - 新增输出函数：`toast()`、`popup()`、`put_widget()` 等。 - 向后兼容性变化：移除部分旧功能，如 `set_output_fixed_height()`、`set_title()` 等。 --- ### 9. 常见问题 - 文件下载问题：`put_file()` 需在会话保持的情况下使用，否则下载链接不可用。 - 跨域请求：需正确配置 `allowed_origins` 或 `check_origin`。 --- ### 10. 使用手册结构手册分为以下几个部分： 1. 特性 2. 安装 3. Hello, world 4. 文档（包括用户指南、输入模块、输出模块、会话管理、Web 框架支持等） 5. 第三方库生态 6. 示例 7. 其他 8. 常见问题 9. 版本更新日志 --- PyWebIO 的核心目标是通过简单的代码实现高效的用户交互，同时提供灵活的配置和扩展能力，适用于 Web 开发和快速原型设计。