为多个开发人员管理 sys.path答案

【问题标题】：Managing sys.path for multiple developers为多个开发人员管理 sys.path
【发布时间】：2017-08-30 15:37:30
【问题描述】：

我面临的问题很小但很烦人：

一位同事正在开发版本控制系统 X (VCS-X) 中的一个项目。另一位同事正在另一个版本控制系统 Y 中工作，并使用 X 中的包。

不幸的是，VCS-X 中的同事使用本地导入并在他们的代码中使用 sys.path.append('trunk/my_location') 修改了他的路径。

我的观点是，这是错误的做法，因为 X 中的同事强迫 Y 同事在能够运行代码之前对其进行编辑，仅仅是因为他们的 repo 命名不同。

应该如何管理这些依赖关系？

开发者 X：

>>> sys.path.append('my_repo/my_location')
>>> from my_location import toolbox
>>> nosetests -v
toolbox.test1 ... ok
toolbox.test2 ... ok
...

开发者 Y：

第 1 步：

>>> nosetests -v
toolbox.test1 ... fail
...

第 2 步：

>>> sys.path.append('my_repo/my_location')
>>> from my_location import toolbox
Import error: No such package.

第 3 步：

>>> sys.path.append('my_colleagues_repo/my_location')
>>> from my_location import toolbox
>>> nosetests -v
toolbox.test1 ... ok
toolbox.test2 ... ok

"...叹息随之而来；代码正在运行..."

【问题讨论】：

【解决方案1】：

没有人应该做sys.path.append！这是您应该首先解决的工作流程问题。

在这种情况下，将toolbox 打包到一个发行版中是合适的。只想使用来自toolbox的代码的开发人员，即通过导入语句或命令行脚本，将执行：

pip install --user toolbox

想要在toolbox 代码上工作的开发人员也应该使用 pip install。然而，这个开发者应该克隆 repo，创建/激活一个虚拟环境，然后执行：

 pip install --editable .

在这两种情况下，pip 都会以正确的方式为您整理出必要的sys.path 内容。

关注PyPA Python Packaging User Guide，了解如何创建分发的详细信息。

【讨论】：