如何为Python LSP配置GObject Introspection绑定以获取代码提示？

我编写的Python代码大量使用GObject Introspection，开头导入语句如下：

import gi
from gi.repository import GObject
from gi.repository import GLib
# .. 更多同类导入

在Ubuntu 24.04上使用python3-pylsp 1.10.0-1时，这些模块无法获得有效代码提示（常规Python库可正常获取）。部分此类库位于GI_TYPELIB_PATH扩展路径中，请问需要添加什么配置，以及配置在何处才能让LSP识别这些库？

1. 配置Pylsp的Jedi分析路径 #

Pylsp依赖Jedi做代码分析，需要让Jedi定位到GI模块的绑定文件和类型库，可通过以下配置实现：

• VS Code：打开设置（Ctrl+,），搜索Pylsp，在Pylsp > Configuration中添加：

  {
    "pylsp.plugins.jedi.environment_path": "/usr/bin/python3",
    "pylsp.plugins.jedi.extra_paths": ["/usr/lib/python3/dist-packages/gi"]
  }
  

• Neovim（lspconfig）：在Pylsp的setup配置中添加：

  require('lspconfig').pylsp.setup{
    settings = {
      pylsp = {
        plugins = {
          jedi = {
            environment_path = "/usr/bin/python3",
            extra_paths = {"/usr/lib/python3/dist-packages/gi"}
          }
        }
      }
    }
  }
  

• 通用配置文件：在~/.config/pylsp/config.toml中添加：

  [jedi]
  environment_path = "/usr/bin/python3"
  extra_paths = ["/usr/lib/python3/dist-packages/gi"]
  

2. 让Pylsp加载GI_TYPELIB_PATH环境变量 #

因为部分库在自定义的GI_TYPELIB_PATH路径下，需要确保Pylsp进程能读取到这个变量：

• 桌面启动编辑器前，先在终端导出变量：

  export GI_TYPELIB_PATH=/你的自定义类型库路径:$GI_TYPELIB_PATH
  code # 替换为你的编辑器启动命令
  

• 终端启动的编辑器，可把上述导出命令添加到~/.bashrc或~/.zshrc，确保每次终端启动时变量生效。

3. 安装GI相关的类型库包 #

确保已安装对应库的GObject Introspection类型包，比如GLib、GObject的包：

sudo apt install gir1.2-glib-2.0 gir1.2-gobject-2.0

根据你使用的GI库，添加对应的gir1.2-*包即可。

验证配置 #

修改配置后重启编辑器，尝试输入GObject.或GLib.，查看是否出现代码提示。如果无效，可查看Pylsp的日志（比如VS Code的输出面板→Pylsp选项），排查路径是否配置正确。

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