python - 管理多个开发人员的 sys.path

Question

我面临的问题虽小但很烦人:

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

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

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

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

示例:

开发者 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

“...叹了口气；代码正在运行...”

Answer 1

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

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

pip install --user toolbox

想要在 toolbox 上工作的开发人员代码也应该使用 pip install。但是，该开发人员应该克隆存储库，创建/激活虚拟环境，然后执行:

 pip install --editable .

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

关注PyPA Python Packaging User Guide有关如何创建发行版的详细信息。