AI应用Python脚本编写清晰框架提示词
本文为AI应用开发者与Python脚本编写者提供了一套结构化提示词方案,旨在帮助用户通过AI生成逻辑...
提示词内容
复制角色定义与任务定位
请以“AI辅助的Python脚本架构师”身份,运用本提示词方案。你的核心目标是:指导AI(如ChatGPT、Claude等大型语言模型)生成结构严谨、注释清晰、功能模块划分明确的Python脚本框架,以高效应对特定行业或功能场景下的自动化与智能化需求。
适用场景
- 为特定行业(如数据分析、自动化办公、网络爬虫)快速生成可定制的基础脚本模板。
- 在开发智能应用(如AI工具集成、文本批量处理、API调用)时,构建清晰的项目骨架。
- 为不熟悉Python复杂结构的文本创作者或业务人员,提供“填空式”的可运行代码框架。
- 教学与学习中,快速生成带有标准注释和逻辑分区的示例脚本。
核心提示词
可直接复制并填充具体需求后使用:
- “请生成一个用于[具体场景,如:批量重命名特定格式文件]的Python脚本框架。要求包含:1. 清晰的模块导入部分;2. 主函数main()作为执行入口;3. 将核心逻辑封装为独立函数;4. 添加必要的命令行参数解析;5. 包含详细的注释说明每个部分的功能和参数。脚本应遵循PEP 8规范。”
- “作为AI应用脚本,请编写一个能够[核心功能,如:调用OpenAI API进行文本摘要]的Python脚本框架。框架需包括:配置加载、错误处理、日志记录、核心处理函数等部分,并给出关键位置的TODO注释以供后续填充。”
风格方向
- 代码风格:工业级/生产导向。强调可读性、可维护性和健壮性,而非仅仅实现功能。
- 注释风格:文档化。使用docstring描述模块和函数功能,行内注释解释关键算法或复杂逻辑。
- 结构风格:模块化。功能解耦,输入/输出、处理逻辑、错误处理分离。
构图建议(逻辑结构)
- 开场区:脚本元信息(Shebang、编码声明、作者、描述)。
- 导入区:集中导入所有依赖库,并按标准库、第三方库、本地模块分组。
- 配置区:定义常量、配置参数(可考虑从文件或环境变量加载)。
- 函数定义区:按逻辑顺序定义功能函数,每个函数职责单一。
- 主执行区:使用 `if __name__ == "__main__":` 包裹,包含参数解析、流程控制。
- 收尾区:可包含示例调用或简单的单元测试入口(如需要)。
细节强化
- 错误处理:明确提示加入try-except块,对文件I/O、网络请求、API调用等可能失败的操作进行捕获和友好提示。
- 日志记录:建议使用logging模块替代print,框架中预留日志初始化配置。
- 参数化:通过argparse或click库设计命令行接口,使脚本更灵活。
- 扩展点:在关键位置使用 `# TODO: [说明]` 或 `# FIXME:` 标记,引导后续开发。
使用建议
- 将上述“核心提示词”作为与AI对话的起点,并根据实际需求替换 `[]` 中的具体描述。
- 生成框架后,首先关注整体结构是否符合预期,再逐一填充TODO部分的具体实现。
- 对于复杂应用,可要求AI分步骤生成:先输出整体目录结构,再针对核心模块生成详细框架。
- 本方案生成的框架是“蓝图”,需结合具体业务逻辑、API密钥管理和部署环境进行最终调整与测试。