scikit-image项目中pytest-doctestplus在可编辑安装模式下的问题分析与解决

在scikit-image项目的开发过程中，开发者发现当使用可编辑安装模式(editable install)时，pytest-doctestplus插件会出现测试失败的情况。这个问题主要影响那些需要进行本地文档测试的开发工作流程。

问题背景

在Python项目开发中，可编辑安装模式是一种常见的开发实践，它允许开发者在修改源代码后立即看到效果，而无需反复执行安装操作。scikit-image项目推荐开发者使用这种模式进行本地开发。

然而，当使用spin install --editable命令进行可编辑安装后，运行文档测试时会出现模块找不到的错误。具体表现为：测试框架能够找到源代码中的文档测试，但在运行时却无法加载对应的模块。

问题根源

经过分析，这个问题主要出现在以下几种情况：

1. 构建工具生成的模块：例如brief_pythran.py文件会被构建工具转译，但在可编辑安装模式下运行时，对应的模块并不存在。

2. 内部构建工具模块：_build_utils目录下的多个文件也会出现类似问题，因为这些模块在运行时环境中不可用。

3. 模块加载机制差异：可编辑安装模式下，Python的模块加载机制与常规安装模式有所不同，导致测试框架和运行时环境对模块可用性的判断不一致。

解决方案

经过项目维护者的探索，发现可以通过调整pytest的导入模式来解决这个问题：

spin test -- --import-mode=importlib --pyargs skimage

或者针对特定模块进行测试：

spin test -- --doctest-plus --import-mode=importlib skimage/feature/

解决方案原理

--import-mode=importlib参数告诉pytest使用Python的标准导入机制(importlib)来加载测试模块，而不是默认的基于文件系统的导入方式。这种模式有以下特点：

1. 更接近实际运行时的模块加载行为
2. 避免了可编辑安装模式下的路径问题
3. 确保模块加载的一致性

注意事项

虽然这个解决方案有效，但开发者需要注意：

1. 在importlib模式下，测试模块之间不能相互导入
2. 测试工具模块(如tests.helpers)可能无法导入
3. 对于已经依赖默认导入模式的项目，切换可能会有兼容性问题

最佳实践建议

对于scikit-image项目的开发者，建议：

1. 在进行文档测试时使用--import-mode=importlib参数
2. 将测试相关的工具模块放在应用程序代码目录中(如app.testing.helpers)，而不是测试目录
3. 在添加新的测试模块时，注意模块间的依赖关系

这个问题展示了Python项目开发中模块系统和测试框架交互的一个典型挑战，通过理解其背后的机制，开发者可以更有效地解决类似问题。