VS Code中Python函数悬停时定义与文档字符串重复显示的解决方法

成因 #

• 多插件冲突：同时启用了多个提供Python语言服务的插件（比如官方Python插件+第三方同类插件），多个服务同时响应悬停请求，导致内容重复输出。
• Pylance配置异常：Pylance的悬停相关配置被重复设置，或与VS Code原生悬停功能叠加触发重复显示。
• 缓存文件损坏：VS Code或Python插件的索引缓存文件出现异常，导致解析后的函数定义和文档被重复加载。

解决办法 #

• 清理冗余插件：打开VS Code扩展面板，保留官方Python插件（含内置的Pylance），禁用或卸载其他同类Python语言服务插件，重启VS Code后测试。
• 重置Pylance配置：
  1. 打开设置界面（Ctrl+,），搜索python.analysis.hover，将所有相关选项恢复默认。
  2. 或直接编辑settings.json，删除自定义的悬停相关配置项，示例：

     // 删除这类自定义配置
     "python.analysis.hover": {
       "showDocumentation": true,
       "showDefinitions": true
     }
     

• 清除缓存：
  • 打开命令面板（Ctrl+Shift+P），执行Python: Clear Cache and Reload Window命令，清理Pylance索引缓存并重启窗口。
  • 若无效，手动删除VS Code缓存目录：Windows为%APPDATA%\Code\Cache，macOS为~/Library/Caches/Code，Linux为~/.cache/Code，删除后重启VS Code。
• 检查解释器配置：确保仅选中一个有效的Python解释器，避免虚拟环境与全局解释器重复关联引发冲突。

内容的提问来源于stack exchange，提问作者agftrading