本教程旨在解决emacs jedi插件安装服务器时遇到的`sexpdata`依赖问题，该问题常表现为`pip`构建`wheel`失败或`setuptools`出现`keyerror`。文章将提供详细的解决方案，包括停用虚拟环境、通过系统包管理器安装`sexpdata`，并指导如何重新安装jedi服务器，确保python开发环境在emacs中顺畅运行。
在Emacs中配置python开发环境时，Jedi插件因其强大的代码补全、跳转和重构能力而广受欢迎。然而，用户在执行jedi:install-server命令时，可能会遇到由于sexpdata等依赖包安装失败导致的问题。这类问题通常源于pip在构建或安装特定包时遇到的环境冲突或构建工具错误，尤其是在处理wheel构建需求时，可能伴随着setuptools抛出的KeyError。本文将深入探讨此问题的根源并提供一套可靠的解决方案。
问题概述与错误分析
当Emacs尝试通过jedi:install-server命令安装Jedi服务器时，它会调用系统中的pip来安装必要的Python依赖。常见的失败场景如下：
-
pip进程异常退出：Emacs报告Deferred process exited abnormally，并显示pip命令以非零状态码（如exit 1）退出。这表明pip在执行过程中遇到了无法恢复的错误。
Running: pip install --upgrade /home/name/.emacs.d/elpa/jedi-core-20210503.1315/...Done deferred error : (error "Deferred process exited abnormally: command: /home/name/.emacs.d/.python-environments/default/bin/pip exit status: exit 1 event: exited abnormally with code 1 note: This error originates from a subprocess, and is likely not a problem with pip.
-
sexpdata安装失败：在pip的输出中，会看到尝试收集和安装sexpdata包时出现错误。这通常是由于pip尝试从源代码构建sexpdata，但在获取构建wheel所需的依赖时失败。
Collecting sexpdata>=0.0.3 (from epc>=0.0.4->jediepcserver==0.3.0) Using cached sexpdata-1.0.1.tar.gz (8.6 kB) Installing build dependencies ... [?25l- | / - done [?25h Getting requirements to build wheel ... [?25l- error error: subprocess-exited-with-error × Getting requirements to build wheel did not run successfully. │ exit code: 1 ╰─> [78 lines of output]
-
KeyError: ‘text’错误：更深层次的错误可能发生在setuptools内部，尤其是在处理pyproject.toml文件或构建元数据时。KeyError: ‘text’通常表示setuptools在预期某个字典键（如’text’）时未能找到它，这可能是由于setuptools版本与Python版本、包的构建配置或构建环境之间的不兼容性造成的。
File "/tmp/pip-build-env-fhs0pp5v/overlay/lib/python3.11/site-packages/setuptools/config/_apply_pyprojecttoml.py", line 183, in _license _set_config(dist, "license", val["text"]) ~~~^^^^^^^^ KeyError: 'text' [end of output] note: This error originates from a subprocess, and is likely not a problem with pip. error: subprocess-exited-with-error × Getting requirements to build wheel did not run successfully. │ exit code: 1 ╰─> See above for output.
这些错误共同指向一个核心问题：pip在当前环境下无法顺利完成sexpdata的构建和安装。这可能是由于系统Python环境的复杂性、虚拟环境的干扰，或是pip/setuptools版本与特定包的构建流程不兼容。
解决方案
解决此问题的关键在于绕过pip的复杂构建过程，并确保Jedi所需的依赖能够被正确、稳定地安装。
步骤一：确认并停用Python虚拟环境
在进行系统级别的包安装之前，务必确保当前没有激活的Python虚拟环境。活跃的虚拟环境可能会导致pip将包安装到虚拟环境中，而不是Emacs所期望的全局或用户级Python环境中，从而引发Jedi服务器无法找到依赖的问题。
在终端中执行以下命令，确保没有任何虚拟环境处于激活状态：
deactivate
如果没有任何输出或提示“No virtual environment is active”，则表示当前没有激活的虚拟环境。如果有虚拟环境被停用，请重复此步骤直到确认。
步骤二：通过系统包管理器安装sexpdata
解决pip构建sexpdata失败的最有效方法是利用操作系统的包管理器来安装预编译的sexpdata包。系统包管理器通常能够提供与系统Python环境高度兼容且经过测试的软件包，从而避免了pip在特定环境下可能遇到的构建问题。
根据您所使用的linux发行版，执行相应的命令：
- 对于基于debian/ubuntu的系统：
sudo apt install python3-sexpdata
- 对于基于Arch/EndeavourOS的系统：
sudo pacman -S python-sexpdata
- 对于基于Fedora/centos的系统：
sudo dnf install python3-sexpdata
请确保安装的是与您系统默认Python版本（通常是Python 3）对应的sexpdata包。通过这种方式安装，sexpdata将作为系统库的一部分存在，jedi服务器在安装时便能直接找到并使用它，而无需再次尝试通过pip进行构建。
步骤三：重新安装Jedi服务器
在确保sexpdata已通过系统包管理器成功安装后，即可在Emacs中重新尝试安装Jedi服务器。
-
在Emacs中执行命令： 打开Emacs，然后使用M-x jedi:install-server命令。Emacs会再次尝试安装Jedi服务器及其剩余依赖。由于sexpdata已解决，这次安装应该能顺利完成。
-
或者，手动通过pip安装Jedi核心组件： 作为备用方案，您也可以在终端中手动运行pip命令来安装Jedi核心组件。这在调试或Emacs内部命令仍然失败时非常有用。请注意，命令中的路径可能需要根据您的jedi-core版本和Emacs配置进行调整。
pip install --upgrade $HOME/.emacs.d/elpa/jedi-core-YYYYMMDD.HHMM/
其中YYYYMMDD.HHMM应替换为您的jedi-core实际版本文件夹名称。通常，Emacs的jedi:install-server会处理这个路径。
注意事项
- Python版本兼容性： 确保Emacs使用的Python解释器与您通过系统包管理器安装sexpdata时所针对的Python版本一致。通常，python3-sexpdata对应系统默认的Python 3。
- Emacs Python环境配置： 如果Emacs的Jedi配置指定了特定的Python解释器（例如通过jedi:server-args或python-shell-interpreter），请确保该解释器能够访问到通过系统包管理器安装的sexpdata。
- 清理旧的Jedi安装： 如果问题持续存在，可以尝试删除Emacs中Jedi插件的相关缓存和安装目录（例如~/.emacs.d/elpa/jedi*和~/.emacs.d/.python-environments/default），然后重新安装Jedi插件并执行上述步骤。
- pip与系统包管理器： 理解pip和系统包管理器（如apt, pacman, dnf）之间的区别至关重要。pip用于管理Python包，而系统包管理器用于管理整个操作系统的软件包，包括Python及其模块。在某些情况下，通过系统包管理器安装Python模块可以避免pip可能遇到的底层构建问题。
总结
Emacs Jedi服务器安装失败，尤其是涉及sexpdata依赖和pip构建错误时，通常可以通过确保没有活跃的虚拟环境，并利用系统包管理器安装sexpdata来解决。这种方法绕过了pip在特定环境下可能遇到的复杂构建问题，为Jedi服务器提供了一个稳定、兼容的sexpdata依赖。遵循本文提供的步骤和注意事项，您将能够成功配置Emacs Jedi，享受高效的Python开发体验。