Python单元测试最佳实践:从pytest到测试驱动开发
引言
单元测试是保证代码质量的关键环节。作为从Python转向Rust的后端开发者,我发现Python的测试生态非常成熟,尤其是pytest框架提供了强大的测试能力。本文将深入探讨Python单元测试的最佳实践,帮助你构建可靠的测试体系。
一、测试基础
1.1 测试类型
| 测试类型 | 范围 | 目的 |
|---|---|---|
| 单元测试 | 单个函数/方法 | 验证独立组件 |
| 集成测试 | 多个组件交互 | 验证系统集成 |
| 端到端测试 | 完整业务流程 | 验证用户场景 |
1.2 pytest基础
# test_example.py
def test_addition():
assert 2 + 2 == 4
def test_string_concat():
assert "Hello" + " " + "World" == "Hello World"
运行测试:
pytest test_example.py -v
二、测试结构
2.1 测试文件组织
project/
├── src/
│ └── my_module/
│ ├── __init__.py
│ └── utils.py
└── tests/
├── __init__.py
├── conftest.py
└── test_utils.py
2.2 conftest.py配置
import pytest
@pytest.fixture
def sample_data():
return {"name": "test", "value": 42}
@pytest.fixture
def client():
from my_app import create_app
app = create_app()
return app.test_client()
三、fixture详解
3.1 基础fixture
import pytest
@pytest.fixture
def database_connection():
conn = create_connection()
yield conn
conn.close()
def test_query(database_connection):
result = database_connection.query("SELECT * FROM users")
assert len(result) > 0
3.2 参数化fixture
@pytest.fixture(params=[1, 2, 3])
def number(request):
return request.param
def test_number(number):
assert number > 0
3.3 作用域控制
@pytest.fixture(scope="session")
def session_fixture():
# 整个测试会话只执行一次
return "session_data"
@pytest.fixture(scope="module")
def module_fixture():
# 每个模块执行一次
return "module_data"
@pytest.fixture(scope="function")
def function_fixture():
# 每个测试函数执行一次
return "function_data"
四、测试技巧
4.1 参数化测试
import pytest
@pytest.mark.parametrize("input_value,expected", [
(1, 2),
(2, 4),
(3, 6),
])
def test_double(input_value, expected):
assert input_value * 2 == expected
4.2 异常测试
def test_divide_by_zero():
with pytest.raises(ZeroDivisionError):
1 / 0
def test_custom_exception():
with pytest.raises(ValueError, match="invalid value"):
raise ValueError("This is an invalid value")
4.3 临时文件
def test_file_operations(tmp_path):
# tmp_path是pytest内置fixture
file = tmp_path / "test.txt"
file.write_text("Hello, World!")
content = file.read_text()
assert content == "Hello, World!"
五、测试覆盖率
5.1 安装coverage
pip install pytest-cov
5.2 运行测试并生成报告
pytest --cov=src --cov-report=html tests/
5.3 配置文件
[tool:pytest]
addopts = --cov=src --cov-report=term-missing
testpaths = ["tests"]
六、测试驱动开发(TDD)
6.1 TDD流程
编写失败的测试 → 编写最小代码使测试通过 → 重构代码
6.2 示例:实现计算器
# 1. 编写测试
def test_add():
assert Calculator().add(2, 3) == 5
def test_subtract():
assert Calculator().subtract(5, 3) == 2
# 2. 实现代码
class Calculator:
def add(self, a, b):
return a + b
def subtract(self, a, b):
return a - b
七、Mock技术
7.1 使用unittest.mock
from unittest.mock import Mock, patch
def test_api_call():
with patch('requests.get') as mock_get:
mock_get.return_value.status_code = 200
mock_get.return_value.json.return_value = {"data": "test"}
result = fetch_data("https://api.example.com")
mock_get.assert_called_once_with("https://api.example.com")
assert result == {"data": "test"}
7.2 Mock类方法
class UserService:
def get_user(self, user_id):
# 调用数据库
pass
def test_user_service():
service = UserService()
service.get_user = Mock(return_value={"id": 1, "name": "Alice"})
user = service.get_user(1)
assert user["name"] == "Alice"
八、实战:完整测试示例
8.1 测试REST API
import pytest
from fastapi.testclient import TestClient
from my_app import app
client = TestClient(app)
def test_create_user():
response = client.post(
"/users",
json={"name": "Alice", "email": "alice@example.com"}
)
assert response.status_code == 200
data = response.json()
assert data["name"] == "Alice"
assert data["email"] == "alice@example.com"
def test_get_user():
response = client.get("/users/1")
assert response.status_code == 200
assert response.json()["id"] == 1
8.2 测试数据库操作
import pytest
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
@pytest.fixture
def db_session():
engine = create_engine("sqlite:///:memory:")
Session = sessionmaker(bind=engine)
session = Session()
# 创建表
Base.metadata.create_all(engine)
yield session
session.close()
def test_create_user(db_session):
user = User(name="Alice", email="alice@example.com")
db_session.add(user)
db_session.commit()
retrieved = db_session.query(User).first()
assert retrieved.name == "Alice"
九、测试最佳实践
9.1 测试命名规范
# 好的命名
def test_user_creation_with_valid_data():
pass
def test_user_creation_raises_error_with_invalid_email():
pass
# 不好的命名
def test_create():
pass
def test_user():
pass
9.2 测试隔离
# 每个测试应该独立,不依赖其他测试的状态
def test_first():
# 设置
# 执行
# 断言
def test_second():
# 这个测试不应该依赖test_first的结果
9.3 避免测试实现细节
# 不好:测试实现细节
def test_user_repository_insert():
repo = UserRepository()
assert repo.db.insert.called # 测试内部方法
# 好:测试行为
def test_user_repository():
repo = UserRepository()
user = repo.save(User(name="Alice"))
retrieved = repo.get(user.id)
assert retrieved.name == "Alice"
十、总结
单元测试是保证代码质量的关键。通过使用pytest和相关工具,我们可以构建可靠、可维护的测试体系。
关键要点:
- 使用pytest:功能强大且灵活的测试框架
- 使用fixture:管理测试依赖和资源
- 参数化测试:减少重复代码
- Mock外部依赖:隔离测试环境
- 追求高覆盖率:但不要盲目追求100%
从Python转向Rust后,我发现Rust的测试框架虽然简单,但类型安全的特性让测试更加可靠。
延伸阅读
- pytest官方文档
- unittest.mock官方文档
- pytest-cov文档
- 《测试驱动开发》书籍
528



被折叠的 条评论
为什么被折叠?



