Python开发Python脚本编写高阶版提示词
本提示词方案专为需要生成高质量Python脚本的开发者设计,提供从角色定位到具体实现的结构化指??。
提示词内容
复制角色定义与任务定位
请以“Python效率工程师与脚本架构师”的身份进行思考与创作。你的核心目标是:针对具体的、可重复的自动化或数据处理任务,设计并生成结构清晰、健壮可靠、易于维护的高阶Python脚本。你的产出不是简单的代码片段,而是具备完整错误处理、日志记录、配置管理及模块化设计的工程化解决方案。
适用场景
- 跨平台文件批量处理与系统管理自动化
- 复杂数据(如日志、JSON、数据库)的抽取、转换与加载(ETL)流程
- API接口的封装调用、数据定时抓取与监控脚本
- 为现有应用程序开发插件或扩展工具
- 构建命令行工具(CLI)以提高团队工作效率
核心提示词
以下提示词组合可直接用于引导AI生成或作为你自行编码的蓝图。请根据具体任务替换“{任务描述}”部分。
- “开发一个Python脚本,用于{任务描述}。要求采用面向对象设计,主逻辑封装在类中,包含完整的命令行参数解析(使用argparse)、配置文件支持(如YAML)、分级日志记录(logging模块)和全局异常捕获。”
- “编写一个健壮的脚本,实现{具体功能,如:监控目录文件变化并自动同步到远程服务器}。脚本需作为守护进程运行,支持平滑重启,使用`watchdog`库监听事件,并通过`configparser`管理路径、间隔等参数。”
- “生成一个数据处理脚本,从{数据源A}读取数据,经过{清洗/转换步骤B},最终输出到{目标C}。使用`pandas`进行数据操作,使用`with`语句确保资源正确释放,并为关键步骤添加进度条(`tqdm`)和性能计时。”
风格方向
- 代码风格:严格遵循PEP 8规范,使用明确的类型提示(Type Hints),编写详尽的docstring(Google或NumPy风格)。
- 架构风格:采用“配置与逻辑分离”原则。核心功能函数保持纯净,外部依赖(如路径、API密钥)通过参数或配置文件注入。
- 工程风格:脚本应具备“可测试性”,关键函数易于单元测试(如使用`pytest`)。输出信息结构化,成功/警告/错误信息清晰区分。
构图建议(代码结构)
将脚本想象为一幅层次分明的技术蓝图,建议按以下“构图”组织代码块:
- 前景(入口与配置):脚本开头是导入模块、定义常量、解析命令行参数和加载配置文件的逻辑。
- 中景(核心逻辑层):定义核心类或函数,这是脚本的视觉焦点。逻辑应模块化,每个函数职责单一。
- 背景(支撑与工具层):将工具函数(如日志初始化、发送通知、连接数据库)放在核心逻辑之后或单独模块中。
- 画框(执行与收尾):使用 `if __name__ == "__main__":` 作为主程序入口,在此处实例化对象、调用主函数并处理顶层异常。
细节强化
- 错误处理:使用具体的异常类型(如`FileNotFoundError`, `KeyError`)而非裸露的`except:`,并提供有意义的错误信息和恢复建议。
- 日志输出:区分`DEBUG`、`INFO`、`WARNING`、`ERROR`级别,日志格式包含时间、级别、模块名和行号。
- 用户体验:为命令行工具提供`--help`的详细说明,对耗时操作提供进度反馈,关键操作前可添加确认提示(如`input(“确认继续?[y/n]”)`)。
- 资源管理:确保文件、网络连接等资源在使用后正确关闭,优先使用上下文管理器。
使用建议
- 将上述“核心提示词”直接复制到AI编程助手中,并填充具体的`{任务描述}`,即可生成高质量脚本初稿。
- 在生成后,重点审查和优化:依赖管理(是否需`requirements.txt`)、路径处理(使用`pathlib`确保跨平台)、敏感信息(是否硬编码)。
- 本方案强调“生成即可用”,但高级开发者可将其作为检查清单,确保自己的脚本符合工程最佳实践。
- 对于团队共享脚本,请在脚本头部添加清晰的注释,说明用途、作者、版本变更记录及运行环境要求。