help() 是 Python 内置交互式帮助系统，用于查看对象文档字符串和用法；可交互调用或直接传入对象，依赖 docstring 存在与否，脚本中慎用，推荐 IDE 悬停等轻量替代方案。

help() 是 Python 内置的交互式帮助系统，用于查看模块、函数、类、方法、关键字等的文档字符串（docstring）和基本用法。

基本用法：直接调用 help()

在 Python 交互式环境中（如 IDLE、IPython 或终端启动的 python），输入 help() 并回车，会进入交互式帮助模式：

• 输入要查询的对象名（如 print、len、os.path）后按回车，即可显示其帮助信息
• 输入 quit 或按 q 退出帮助模式
• 输入 modules 可列出当前已安装的所有模块（较慢，慎用）

快速获取单个对象的帮助

无需进入交互模式，可直接对具体对象调用 help：

python-flask-vue-creator

创建 Flask + Vue.js 全栈项目，采用单端口架构、uv 依赖管理、结构化日志和生产级前端设计。当用户要求以下操作时触发：创建新的 Flask+Vue 项目、搭建 Web 应用、构建全栈 Python+Vue 应用、初始化 Flask Web 项目、设置单端口 Flask 前后端项目。触发词：新建项目、创建项目、搭建项目、Flask项目、Vue项目。

下载

• help(print) — 查看 print 函数说明
• help(str.split) — 查看字符串 split 方法
• help('for') — 查看 for 语句语法（传入字符串可查关键字或主题）
• help('modules') — 列出所有可用模块名（非详细信息）

注意事项与常见问题

help() 显示的内容完全依赖于对象是否提供了规范的 docstring。部分内置函数或 C 扩展模块可能只有简短描述。

立即学习“Python免费学习笔记（深入）”；

• 若提示 No Python documentation found，说明该对象无 docstring 或未正确安装源码文档
• 自定义函数/类需在定义时写好三引号文档字符串，help() 才能显示有效内容
• 在脚本中调用 help() 会阻塞执行，一般只用于开发调试，不建议在正式代码中使用

替代方案（更轻量）

想快速查看签名或简要说明，可用：

• print(func.__doc__) — 直接打印 docstring（可能为 None）
• print(inspect.signature(func)) — 需导入 inspect，精准显示参数签名
• IDE（如 VS Code、PyCharm）悬停提示或快捷键（Ctrl+Q / Ctrl+P）更便捷