python安装命令 pip install -e . 解释

原创已于 2025-01-10 11:18:54 修改 · 2.8k 阅读

CC 4.0 BY-SA版权

文章标签：

于 2025-01-10 11:16:59 首次发布

64 篇文章

订阅专栏

pip install -e . 是用于在开发模式下安装 Python 包的命令。具体解释如下：

pip install: 这是用于安装 Python 包的命令。
-e: 这是 --editable 的缩写，表示以“可编辑”模式安装包。这意味着包不会被复制到 Python 的 site-packages 目录，而是通过符号链接指向当前目录。这样，你可以直接修改源代码，而无需重新安装包。
.: 这表示当前目录。通常，你会在包含 setup.py 或 pyproject.toml 文件的目录中运行此命令。

假设你有一个项目结构如下：

my_project/
├── setup.py
├── my_package/
│   ├── __init__.py
│   └── module.py

在 my_project 目录下运行 pip install -e . 后，my_package 会被安装到当前环境中，但实际代码仍然位于 my_project 目录中。你可以直接修改 my_package 中的代码，修改会立即生效。

在使用 pip install -e . 命令时，pip 会创建一个符号链接（symlink），将安装的包指向你的项目目录。这个符号链接的具体位置取决于你的 Python 环境。

符号链接通常会被创建在 Python 环境的 site-packages 目录中。具体路径如下：

虚拟环境:
- 如果你使用的是虚拟环境（如 venv 或 conda），符号链接会出现在虚拟环境的 site-packages 目录中。
- 例如：
```
venv/lib/python3.x/site-packages/
```
  或
```
~/miniconda3/envs/my_env/lib/python3.x/site-packages/
```
全局环境:
- 如果你在全局 Python 环境中运行 pip install -e .，符号链接会出现在全局的 site-packages 目录中。
- 例如：
```
/usr/local/lib/python3.x/site-packages/
```
  或
```
~/.local/lib/python3.x/site-packages/
```

符号链接的名称通常是你项目在 setup.py 或 pyproject.toml 中定义的包名。例如，如果你的包名是 my_package，那么符号链接的名称就是 my_package.egg-link 或直接是 my_package。

查找 site-packages 目录:
- 运行以下命令可以找到当前 Python 环境的 site-packages 目录：
```
python -m site
```
  输出中会列出 site-packages 的路径。

查看符号链接:

进入 site-packages 目录，查找与你的包名相关的文件或链接。例如：

ls -l /path/to/site-packages | grep my_package

你会看到类似以下的输出：

lrwxrwxrwx 1 user user   45 Oct  1 12:34 my_package.egg-link -> /path/to/your/project

假设你的项目路径是 /home/user/my_project，包名是 my_package，并且你使用的是虚拟环境 venv。运行 pip install -e . 后，你可能会在以下路径找到符号链接：

venv/lib/python3.x/site-packages/my_package.egg-link

该文件的内容会指向你的项目目录：

/home/user/my_project

pip install -e . 创建的符号链接位于 Python 环境的 site-packages 目录中，名称通常是你的包名加上 .egg-link 后缀。通过这个符号链接，Python 可以直接访问你的项目目录中的代码，而无需将代码复制到 site-packages 中。