测试工程Python脚本编写清晰框架提示词
本提示词方案为测试工程师提供了一套编写清晰、可维护的Python测试脚本框架的指导,涵盖模块划分、命名规范、异常处理与日志记录,帮助提升自动化测试代码质量。
测试工程
Python脚本编写
软件测试
提示词内容
可直接复制使用
角色定义 你应当以测试自动化架构师的角色来使用这组提示词,目标是为团队或项目设计一套结构清晰、易于扩展、可维护的Python测试脚本框架。你需要从代码组织、命名约定、错误处理、日志记录和数据驱动等维度出发,输出可直接用于脚本编写阶段的规范与模板。 适用场景 为回归测试、接口测试、UI自动化测试项目搭建初始脚本框架 重构已有混乱的测试代码,建立统一的模块化和分层结构 编写可复用的测试工具库(如自定义断言、报告生成、配置管理) 在团队中推广标准化脚本编写风格,降低新人上手成本 核心提示词 以下提示词可直接复制到AI生成工具或作为个人编写准则: 模块分层:按test_case、common、config、report、data_driver 划分目录,每个目录下包含__init__.py 命名规范:测试类名以Test开头(如TestLogin),测试方法名以test_开头(如test_login_success);函数/变量使用小写+下划线 框架底座:使用pytest作为测试执行引擎,结合fixture管理预置条件,conftest.py存放全局配置 数据驱动:采用Excel、YAML或JSON文件管理测试数据,通过parametrize装饰器注入,避免硬编码 日志与异常:封装统一的Logger类,记录每个测试步骤的开始、结束及关键断言;使用try-except捕获预期异常并转化为清晰错误信息 断言策略:优先使用pytest自带的assert,复杂校验可封装自定义断言函数(如assert_response_code, assert_json_schema) 风格方向 专业规范:代码风格遵循PEP 8,注释使用Google风格docstring,文档字符串包含参数、返回值及示例 可读性强:每个函数不超过50行,单一职责;使用类型提示(Type Hints)提高可读性 松耦合:业务逻辑与测试数据分离,环境配置通过环境变量或配置文件动态加载 构图建议 架构层级图:用树形拓扑展示框架层次——顶层为测试执行入口(pytest),中间层为业务封装(page objects、API clients),底层为数据层(config、data files) 数据流图:绘制测试数据从加载到参数化传入测试方法的箭头路径,标明转化节点(如YAML→dict→参数列表) 类关系图:如果使用POM,绘制BasePage与具体Page类的继承关系,标注公共方法与私有方法 细节强化 装饰器封装:定义retry装饰器处理网络波动,定义skip_on_fail装饰器跳过无关依赖的用例 报告增强:集成allure-pytest,自动关联测试步骤截图、请求/响应日志;添加自定义标签(如@feature, @severity) 并发策略:使用pytest-xdist分布式执行,配合fixture作用域(session/module)合理分配资源 环境切换:通过pytest -k或marker指定测试环境(test/staging/prod),配合config.py读取对应配置 使用建议 先根据项目规模选择模块划分粒度:小型项目可将common和config合并,大型项目需增加service层 在项目根目录放置README.md,用本提示词的内容提炼总结框架结构,便于团队成员快速对齐 将“核心提示词”部分作为代码评审的checklist,检查每个PR是否满足分层、命名、日志等要求 对于AI生成工具,可输入“请按测试工程Python脚本编写清晰框架提示词中的模块分层和命名规范,生成一个登录测试用例的脚本示例”进行快速落地