Pytest执行多组件FastAPI测试时未更新API实例的问题

目录结构 #

├── component_1/
│   ├── src/
│   │   ├── some_source.py
│   │   └── app.py
│   └── test_for_component1.py
└── component_2/
    ├── src/
    │   ├── more_source.py
    │   └── app.py
    └── test_for_component2.py

问题现象 #

• 在仓库根目录运行pytest，可正常识别两个测试文件test_for_component1.py和test_for_component2.py
• test_for_component1.py的所有测试全部通过
• test_for_component2.py执行时返回404错误，提示找不到/method_for_component2接口；若在该测试文件中调用/method_for_component1，会返回输入错误而非404，说明复用了第一个组件的app实例

原因分析 #

这是Python模块导入机制导致的：Python的模块采用单例缓存机制，一旦某个模块被导入并加载到内存，后续任何导入该模块的代码都会直接复用已缓存的模块对象，不会重新执行模块代码。

当pytest按顺序执行测试时，第一个测试文件运行时，from src.app import app会将component_1/src/app.py的app实例加载到内存并缓存；第二个测试文件同样使用from src.app import app时，Python会直接复用之前缓存的component_1的app实例，而非加载component_2/src/app.py的新实例，因此找不到对应接口。

解决方案 #

方案1：使用绝对导入明确指定模块路径 #

直接修改测试文件的导入语句，明确指向对应组件的app模块：

• 在test_for_component1.py中：

  from component_1.src.app import app
  

• 在test_for_component2.py中：

  from component_2.src.app import app
  

通过绝对导入指定不同的模块路径，Python会加载两个独立的模块实例，避免复用。

方案2：利用pytest fixture清除模块缓存，重新导入 #

在每个测试文件中定义模块级别的fixture，每次测试前清除已缓存的src.app模块，再重新导入当前组件的实例：

import importlib
import sys
import pytest
from fastapi.testclient import TestClient

@pytest.fixture(scope="module")
def app():
    # 清除已缓存的src.app模块
    if "src.app" in sys.modules:
        del sys.modules["src.app"]
    # 重新导入当前测试所在目录的src.app
    app_module = importlib.import_module("src.app")
    return app_module.app

@pytest.fixture(scope="module")
def client(app):
    return TestClient(app)

这样每个测试模块运行时，都会重新加载对应组件的app实例，实现隔离。

方案3：修改sys.path优先级，确保导入当前组件的src #

在每个测试文件开头，将当前组件的目录添加到sys.path的最前面，让Python优先导入当前组件下的src模块：
以test_for_component2.py为例：

import sys
from pathlib import Path

# 获取当前测试文件所在的组件目录
current_component_dir = Path(__file__).parent
# 将组件目录插入到sys.path首位
sys.path.insert(0, str(current_component_dir))

from src.app import app
from fastapi.testclient import TestClient

client = TestClient(app)

# 后续测试代码

每个测试文件运行时，sys.path的首位是当前组件目录，导入的src.app自然是对应组件的实例。

内容的提问来源于stack exchange，提问作者nbai