feat,fix(core,docs): 完善核心模块代码注释并添加架构改进文档

- 为 core 目录下主要模块 (models, context, creator, base_api, exchange, executor) 添加了详细的类和方法 Docstring。
   - 新增 docs/架构改进.md 文件。
This commit is contained in:
2026-03-18 11:26:55 +08:00
parent d05757f7cc
commit 6393414ab2
9 changed files with 226 additions and 4 deletions

View File

@@ -18,6 +18,10 @@ logger = logging.getLogger(__name__)
class HttpAction(BaseModel):
"""
HTTP 请求动作模型。
定义了发起 HTTP 请求所需的所有参数包括方法、URL、头信息、参数、请求体等。
"""
method: str = Field(..., description="HTTP 请求方法: get, post, etc.")
url: str = Field(..., description="接口路径或完整 URL")
headers: dict[str, Any] | None = Field(default=None, description="HTTP 请求头")
@@ -31,6 +35,10 @@ class HttpAction(BaseModel):
class ApiActionModel(BaseModel):
"""
PO (Page Object) 模式动作模型。
定义了调用封装在 API 类中的方法所需的信息,通过反射机制动态执行。
"""
module: str = Field(..., alias="class", description="要调用的 API 类名")
method: str = Field(..., description="类中的方法名")
params: dict[str, Any] = Field(default_factory=dict, description="传给方法的参数")
@@ -39,6 +47,10 @@ class ApiActionModel(BaseModel):
class ValidateItem(BaseModel):
"""
断言项模型。
定义了测试用例执行后的校验规则,包括检查字段、断言方法和期望值。
"""
check: str = Field(..., description="要检查的字段或表达式")
assert_method: str = Field(alias="assert", default="equals")
expect: Any = Field(..., description="期望值")
@@ -48,6 +60,10 @@ class ValidateItem(BaseModel):
class RawSchema(BaseModel):
"""
测试用例原始数据模型。
对应 YAML 用例文件的结构,包含元数据、动作定义、变量提取和断言规则。
"""
title: str = Field(..., description="用例标题")
epic: str | None = None
feature: str | None = None