python - 如何指定另一个 tox 项目文件夹作为 tox 项目的依赖项

Question

我们有一个 tox - 启用项目(我们称之为“主”项目)，它依赖于另一个 tox 项目(我们称之为“库”项目)——所有这些都统一在一个存储库中，因为它都是一个大型总体项目的一部分。

项目如何为普通用户工作

对于作为最终用户的常规安装，您只需先从存储库或任何来源安装“library”，然后安装“main”，然后运行它。

我们的问题是什么 tox

但是，作为开发人员，情况有所不同，因为“tox”应该可以工作，而且您可能希望同时拥有多个版本。

您通常会查看大型总体存储库，然后文件系统布局是这样的:

overarchingproject/main/
overarchingproject/main/src/
overarchingproject/main/tox.ini
overarchingproject/main/setup.py
...
overarchingproject/library/
overarchingproject/library/src/
overarchingproject/library/tox.ini
overarchingproject/library/setup.py
...

现在，如果我进入 main/并输入“tox”，就会发生这种情况:

当前行为:它将尝试构建依赖于“库”的“主”项目——这显然会导致尝试从 pip 获取“库”。但是，该项目尚未发布(因此不在 pip 上)，因此它无法工作 - 即使 lib 就在同一个 repo 中。

结果:它不起作用。

解决方法 1:我们可以设置我们自己的包索引/要求用户这样做。然而，要求每个对项目做出贡献的人都使用 DevPI 或类似的东西来做这件事，只是为了能够运行单元测试似乎不是一个好主意，所以我们需要集中进行。

但是，如果我们在某个中心位置提供包索引或“库”的 pip 包，则人们无法轻松地运行“main”的测试，并涉及他们自己创建的“库”的修改版本:

“库”毕竟在同一个存储库中，所以人们不妨在某个时候修改它。

在“主”项目文件夹中输入“tox”不会轻易接受当前相邻的“库”版本，但只有预先打包的在线内容并不完全直观。

解决方法 2:我们尝试了 sitepackages=True 并在系统中安装了“library”——但是，sitepackages=True 给我们带来了很多麻烦，总的来说这似乎不是一个好主意。

期望的行为:我们希望 tox 使用该文件夹中“库”的本地版本，就在同一个总体存储库中，人们通常会在其中获得一件事:

该版本可能更新甚至在本地修改，因此这显然是开发用户想要使用的。它存在，现在不能说 pip 包。

为什么我们无论如何都想要带有子项目(“main”、“library”、...)的总体存储库，而不仅仅是一个项目？

我们开发了一个多守护进程的大型项目，其中有许多守护进程用于各种用途，在一些库中共享代码以形成大学类(class)管理系统(处理论坛，类(class)管理有可能提交的东西，附加的学生项目代码版本控制系统)等等。)。

可以只使用守护进程的一个子集，因此它们是独立的项目是有道理的，但它们仍然足够连接，以至于大多数人都希望拥有其中的大部分——因此它们都在一个存储库中。

库本身也适用于完全不同的项目，但它通常用于我们的项目 - 因此它被填充到存储库中。所以这意味着它总是在给定的相对路径中，但它有单独的 tox.ini 和单元测试。

TL;DR/摘要

那么，在安装项目时，我们如何让 tox 在另一个可毒项目文件夹中查找特定依赖项，而不仅仅是 pip 呢？

当然，“main”的常规 setup.py 安装过程不应该与 tox 或搜索本地磁盘混淆:它应该只检查一个特定的相对路径，如果不存在则放弃(并回退pip 或其他)。

所以最好是将相对路径以某种方式存储在 tox.ini 中。

或者这只是一个非常糟糕的主意？我们是否应该以不同的方式解决这个问题，以使我们的“主”项目很容易被本地存储库中最新的“库”本地开发版本所毒害？

Answer 1

您可以使用 pip 的 --可编辑 主项目中的选项，如下所示:

deps =
    --editable=file:///{toxinidir}/../library
    -r{toxinidir}/requirements.txt

附言不要使用这种样式:-e file:///{toxinidir}/../library，因为 tox 在错误格式中将整个字符串作为参数传递给 argparse。