|
| 1 | +# 自动测试发现功能 (Auto Test Discovery) |
| 2 | + |
| 3 | +## 概述 |
| 4 | + |
| 5 | +`@evaluation_test` decorator 现在会自动确保所有装饰的函数都能被 pytest 发现,无论函数名是否遵循 pytest 命名规范。 |
| 6 | + |
| 7 | +## 功能说明 |
| 8 | + |
| 9 | +### 核心机制 |
| 10 | + |
| 11 | +当你使用 `@evaluation_test` 装饰一个函数时: |
| 12 | + |
| 13 | +1. **如果函数名以 `test_` 开头**:正常工作,无需额外处理 |
| 14 | +2. **如果函数名不以 `test_` 开头**:decorator 会自动在模块的全局命名空间中注册一个以 `test_` 开头的别名 |
| 15 | + |
| 16 | +### 实现细节 |
| 17 | + |
| 18 | +- 在 `evaluation_test.py` 中,decorator 检查函数名 |
| 19 | +- 如果不以 `test_` 开头,使用 `sys._getframe(1).f_globals` 获取调用者的全局命名空间 |
| 20 | +- 在该命名空间中注册 `test_{original_name}` 别名 |
| 21 | +- Pytest 扫描模块时会发现这个别名 |
| 22 | + |
| 23 | +## 使用示例 |
| 24 | + |
| 25 | +```python |
| 26 | +from eval_protocol.pytest import evaluation_test |
| 27 | +from eval_protocol.models import EvaluationRow, EvaluateResult |
| 28 | + |
| 29 | +# ✅ 这个函数名不以 test_ 开头,但仍然会被发现 |
| 30 | +@evaluation_test( |
| 31 | + input_rows=[[ |
| 32 | + EvaluationRow(messages=[{"role": "user", "content": "Test"}]) |
| 33 | + ]] |
| 34 | +) |
| 35 | +async def my_custom_evaluation(row: EvaluationRow) -> EvaluationRow: |
| 36 | + """ |
| 37 | + Pytest 会自动发现这个函数作为 'test_my_custom_evaluation' |
| 38 | + """ |
| 39 | + row.evaluation_result = EvaluateResult(score=1.0) |
| 40 | + return row |
| 41 | + |
| 42 | +# ✅ 这个函数名已经符合规范 |
| 43 | +@evaluation_test( |
| 44 | + input_rows=[[ |
| 45 | + EvaluationRow(messages=[{"role": "user", "content": "Test"}]) |
| 46 | + ]] |
| 47 | +) |
| 48 | +async def test_my_evaluation(row: EvaluationRow) -> EvaluationRow: |
| 49 | + """ |
| 50 | + 这个函数已经以 test_ 开头,正常工作 |
| 51 | + """ |
| 52 | + row.evaluation_result = EvaluateResult(score=1.0) |
| 53 | + return row |
| 54 | +``` |
| 55 | + |
| 56 | +## 验证 |
| 57 | + |
| 58 | +运行 pytest collection 可以看到两个测试都被发现: |
| 59 | + |
| 60 | +```bash |
| 61 | +$ pytest --collect-only |
| 62 | +<Module my_tests.py> |
| 63 | + <Coroutine test_my_custom_evaluation[rows(len=1)]> |
| 64 | + <Coroutine test_my_evaluation[rows(len=1)]> |
| 65 | +``` |
| 66 | + |
| 67 | +## 代码修改 |
| 68 | + |
| 69 | +### 1. `eval_protocol/pytest/evaluation_test.py` |
| 70 | + |
| 71 | +在 decorator 返回之前添加自动注册逻辑: |
| 72 | + |
| 73 | +```python |
| 74 | +# Auto-register the test function in the caller's namespace with 'test_' prefix |
| 75 | +original_name = test_func.__name__ |
| 76 | +if not original_name.startswith('test_'): |
| 77 | + import sys |
| 78 | + frame = sys._getframe(1) |
| 79 | + caller_globals = frame.f_globals |
| 80 | + test_name = f'test_{original_name}' |
| 81 | + if test_name not in caller_globals: |
| 82 | + caller_globals[test_name] = dual_mode_wrapper |
| 83 | +``` |
| 84 | + |
| 85 | +### 2. `eval_protocol/pytest/parameterize.py` |
| 86 | + |
| 87 | +确保 wrapper 的 `__name__` 属性被修正: |
| 88 | + |
| 89 | +```python |
| 90 | +# Ensure wrapper name starts with 'test_' for pytest discovery |
| 91 | +original_name = test_func.__name__ |
| 92 | +if not original_name.startswith('test_'): |
| 93 | + wrapper.__name__ = f'test_{original_name}' |
| 94 | +``` |
| 95 | + |
| 96 | +### 3. `eval_protocol/pytest/dual_mode_wrapper.py` |
| 97 | + |
| 98 | +同样确保 dual_mode_wrapper 的名称被修正: |
| 99 | + |
| 100 | +```python |
| 101 | +# Ensure the wrapper name starts with 'test_' for pytest discovery |
| 102 | +original_name = test_func.__name__ |
| 103 | +if not original_name.startswith('test_'): |
| 104 | + dual_mode_wrapper.__name__ = f'test_{original_name}' |
| 105 | +``` |
| 106 | + |
| 107 | +## 测试 |
| 108 | + |
| 109 | +参考 `tests/test_auto_discovery_simple.py` 查看完整的测试示例。 |
| 110 | + |
| 111 | +运行测试: |
| 112 | +```bash |
| 113 | +pytest tests/test_auto_discovery_simple.py -v |
| 114 | +``` |
| 115 | + |
| 116 | +## 优点 |
| 117 | + |
| 118 | +1. ✅ 用户不需要记住命名规范 |
| 119 | +2. ✅ 所有使用 `@evaluation_test` 的函数都能被 pytest 发现 |
| 120 | +3. ✅ 无需任何配置 |
| 121 | +4. ✅ 向后兼容(已经使用 `test_` 前缀的函数继续正常工作) |
| 122 | +5. ✅ 无警告,自动静默处理 |
| 123 | + |
| 124 | +## 总结 |
| 125 | + |
| 126 | +现在,只要你使用 `@evaluation_test` 装饰函数,就可以保证它能被 pytest 发现,无论你如何命名这个函数!🎉 |
| 127 | + |
0 commit comments