什么时候-e，--editable选项对pip安装有用？

Question

什么时候-e或--edable选项对pip安装有用？

对于某些项目，requirements.txt中的最后一行是-e.。它到底做什么？

Answer 1

在“发展”模式下工作：

虽然不是必需的，但在处理项目时，以“可编辑”或“开发”模式本地安装项目是很常见的。这允许您的项目以项目形式安装和可编辑。

假设您位于项目目录的根目录中，则运行：

pip安装-e.

虽然有点晦涩，-e是--editable的缩写，指的是当前工作目录，所以合在一起意味着以可编辑模式安装当前目录（即您的项目）。

从“开发模式”中对setuptools和distutils内部的一些额外见解：

在正常情况下，distutils假定您要构建项目的发行版，而不是以“原始”或“未构建”的形式使用它。如果要以这种方式使用distutils，则每次在开发过程中对项目进行更改时，都必须重新生成并重新安装项目。

distutils有时会出现的另一个问题是，您可能需要同时对两个相关项目进行开发。您可能需要将两个项目的包放在同一个目录中才能运行它们，但需要将它们分开以进行修订控制。你怎么能做到这一点？

Setuptools允许您在公共目录或临时区域中部署项目以供使用，但无需复制任何文件。因此，您可以在其签出目录中编辑每个项目的代码，并且只需要在更改项目的C扩展名或类似编译文件时运行构建命令。您甚至可以将一个项目部署到另一个项目的签出目录中，如果这是您首选的工作方式（而不是使用公共的独立暂存区域或site packages目录）。

为此，请使用setup.pyDevelopment命令。它的工作原理与setup.py安装非常相似，只是它实际上没有安装任何东西。相反，它在部署目录中创建一个特殊的. ege-link文件，该文件链接到项目的源代码。而且，如果您的部署目录是Python的site-包目录，它还将更新easy-install.pth文件以包含您的项目的源代码，从而使其在sys.path上可用使用该Python安装的所有程序。

Answer 2

在开发中使用--editable的具体示例

如果您按照以下步骤使用此测试包：

cd ~
git clone https://github.com/cirosantilli/vcdvcd
cd vcdvcd
git checkout 5dd4205c37ed0244ecaf443d8106fadb2f9cfbb8
python -m pip install --editable . --user

它输出：

Obtaining file:///home/ciro/bak/git/vcdvcd
Installing collected packages: vcdvcd
  Attempting uninstall: vcdvcd
    Found existing installation: vcdvcd 1.0.6
    Can't uninstall 'vcdvcd'. No files were found to uninstall.
  Running setup.py develop for vcdvcd
Successfully installed vcdvcd-1.0.6

无法卸载“vcdvcd”是正常的：它尝试卸载任何现有的vcdvcd，然后用在以下步骤中生成的“类似符号链接的机制”替换它们，但由于没有以前的安装而失败。

然后生成一个文件：

~/.local/lib/python3.8/site-packages/vcdvcd.egg-link

其中包括：

/home/ciro/vcdvcd
.

并充当Python解释器的“符号链接”。

现在，如果我在/home/ciro/vcdvcd下对git源代码进行任何更改，它会自动反映在进口商身上，他们可以从任何目录执行以下操作：

python -c 'import vcdvcd'

但是请注意，至少在我的pip版本中，安装了--editable的二进制文件，例如该软件包通过scripts=在setup.py上提供的vcdcat脚本，不会进行符号链接，只会复制到：

~/.local/bin/vcdcat

就像常规安装一样，因此对git存储库的更新不会直接影响它们。

相比之下，一个常规的非-可编辑的安装来自git源：

python -m pip uninstall vcdvcd
python -m pip install --user .

在以下位置生成已安装文件的副本：

~/.local/lib/python3.8/site-packages/vcdvcd

如上所述卸载可编辑包需要一个足够新的pip，如：如何使用pip卸载可编辑包（与-e一起安装）

在Python3.8、PIP20.0.2和Ubuntu20.04中测试。

建议：尽可能直接在树中开发

当您通过另一个项目对包测试修补程序时，可编辑设置非常有用。

然而，如果您可以在树中完全测试您的更改，只需这样做，而不是生成更复杂的可编辑安装。

例如，上面的vcdvcd软件包的设置方式是，您只需将cd插入源代码并执行/vcdcat，而无需pip安装软件包本身（通常，您可能需要从requirements.txt安装依赖项），以及该可执行文件执行的导入vcdvcd（或者您自己的自定义测试）只需在包所在的同一目录中正确地找到包。

Answer 3

正如手册页所说：

-e,--editable <path/url>
     Install a project in editable mode (i.e.  setuptools "develop mode") from a local project path or a VCS url.

因此，当您试图在本地安装软件包时，通常在系统上开发软件包时使用此选项。它只是将包链接到原始位置，基本上意味着对原始包的任何更改都将直接反映在您的环境中。

这里和这里都有一些金块。

示例运行可以是：

pip install -e .

或者

pip install -e ~/ultimate-utils/ultimate-utils-proj-src/

请注意，第二个是setup.py所在的完整路径。